Amazon Ads for Pipes Reference
pipes__Attribution_Advertisers
Amazon Attribution Advertisers
Amazon Endpoint Reference |
|---|
Parameter
<profileId> (optional): Profile ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
advertiserId | string | The identifier of the advertiser |
advertiserName | string | The name of the advertiser |
pipes__Attribution_Publishers
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/amazon-attribution-prod-3p/#/Publishers/getPublishers
Amazon Attribution Publishers
Parameter
<profileId> (optional): Profile ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
id | string | The identifier of the publisher |
macroEnabled | boolean | Set to 'true' if the publisher supports macros |
name | string | The name of the publisher |
pipes__Attribution_Report
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/amazon-attribution-prod-3p/#/Reports/getAttributionTagsByCampaign
Amazon Attribution Report
Amazon Attribution Tags
Parameter
<profileId> (optional): Profile ID
<startDate> (optional): Start date|The start date for the report. For reportType PRODUCTS, startDate can only be within last 90 days from current date
<daysToRedownload> (optional): Days to redownload|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
report_type | string | The type of report. Either PERFORMANCE or PRODUCTS' |
advertiser_id | long | One or more advertiser Ids to filter reporting by. If requesting reporting for multiple advertiser Ids, input via a comma-delimited list |
date | date | Date on which the events took place. Applies to PERFORMANCE and PRODUCTS reportType |
adGroupId | string | An ad group external identifier. Applies to PERFORMANCE and PRODUCTS reportType |
advertiserName | string | Name of advertiser. Applies to PERFORMANCE and PRODUCTS reportType |
brandName | string | Name of the advertiser''s brand. Applies only to PRODUCTS reportType |
campaignId | string | A campaign external identifier. Applies to PERFORMANCE and PRODUCTS reportType |
creativeId | string | A creative external identifier. Applies only to PERFORMANCE reportType |
marketplace | string | The Amazon-owned site the product is sold on. Applies only to PRODUCTS reportType |
productAsin | string | A unique block of letters and/or numbers that identify all products sold on Amazon. Applies only to PRODUCTS reportType |
productCategory | string | A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains categories of products. Applies only to PRODUCTS reportType |
productSubcategory | string | A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains subcategories of products. Applies only to PRODUCTS reportType |
productConversionType | string | The conversion type describes whether the conversion happened on a promoted or a brand halo ASIN. Applies only to PRODUCTS reportType |
productGroup | string | A distinct product grouping distinguishing products like watches from video games from toys. Contains groups of products. Applies only to PRODUCTS reportType |
productName | string | The name of the product. Applies only to PRODUCTS reportType |
publisher | string | The publisher name. Applies to PERFORMANCE and PRODUCTS reportType |
attributedAddToCartClicks14d | decimal | The number of promoted add to cart conversions attributed to ad click-throughs within 14 days |
attributedDetailPageViewsClicks14d | decimal | The number of promoted detail page view conversions attributed to ad click-throughs within 14 days |
attributedNewToBrandPurchases14d | decimal | The number of promoted purchases made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days |
attributedNewToBrandSales14d | decimal | The aggregate value of promoted sales made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days |
attributedNewToBrandUnitsSold14d | decimal | The number of promoted units sold made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days |
attributedPurchases14d | decimal | The number of promoted purchases attributed to ad click-throughs within 14 days |
attributedSales14d | decimal | Aggregate value of promoted attributed sales occurring within 14 days of an attribution event in local currency |
attributedTotalAddToCartClicks14d | decimal | The number of total add to cart conversions attributed to ad click-throughs within 14 days, including brand halo |
attributedTotalDetailPageViewsClicks14d | decimal | The number of total detail page view conversions attributed to ad click-throughs within 14 days, including brand halo |
attributedTotalPurchases14d | decimal | The number of total purchases attributed to ad click-throughs within 14 days, including brand halo |
brandHaloAttributedAddToCartClicks14d | decimal | The number of Brand halo add to cart conversions attributed to ad click-throughs within 14 days |
brandHaloAttributedPurchases14d | decimal | The number of Brand halo purchases attributed to ad click-throughs within 14 days |
brandHaloAttributedSales14d | decimal | Aggregate value of Brand halo attributed sales occurring within 14 days of an attribution event in local currency |
brandHaloDetailPageViewsClicks14d | decimal | The number of Brand halo detail page view conversions attributed to ad click-throughs within 14 days |
brandHaloNewToBrandPurchases14d | decimal | The number of Brand halo purchases made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days |
brandHaloNewToBrandSales14d | decimal | The aggregate value of Brand halo sales made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days |
brandHaloNewToBrandUnitsSold14d | decimal | The number of Brand halo units sold made for the first time over a one-year lookback window by customers on Amazon, attributed to ad click-throughs within 14 days |
brandHaloUnitsSold14d | decimal | The number of Brand halo units sold attributed to ad click-throughs within 14 days |
totalAttributedSales14d | decimal | Aggregate value of total attributed sales occurring within 14 days of an attribution event in local currency, including brand halo |
totalUnitsSold14d | decimal | The number of total units sold attributed to ad click-throughs within 14 days, including brand halo |
unitsSold14d | decimal | The number of promoted units sold attributed to ad click-throughs within 14 days |
pipes__Attribution_TagsMacro
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/amazon-attribution-prod-3p/#/Attribution%20Tags/getPublisherAttributionTagTemplate
Amazon Attribution Tags
Parameter
<profileId> (optional): Profile ID
<nonMacroTemplateTag> (optional): If 'true' - gets a list of attribution tags for third-party publisher campaigns that do not support macros, otherwise if 'false' - gets a list of attribution tags for third-party publisher campaigns that support macros, if NULL - gets both
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
advertiserId | string | The advertiser identifier |
publisherId | string | Publisher Id |
macroTag | string |
pipes__Brands_AdGroups
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Ad%20groups
Brands Ad groups
Parameter
<profileId> (optional): Profile ID
<adGroupIdFilter> (optional): The returned array includes only ad groups with identifiers matching those specified in the comma-delimited string
<campaignIdFilter> (optional): The returned array includes only ad groups associated with campaign identifiers matching those specified in the comma-delimited string
<name> (optional): The returned array includes only ad groups with the specified name
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
adGroupId | long | The idenitifier of the ad group |
campaignId | long | The identifier of the campaign associated with the ad group |
name | string | The name of the ad group |
pipes__Brands
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Brands/getBrands
Brands
Parameter
<profileId> (optional): Profile ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
brandEntityId | string | The Brand entity identifier |
brandId | string | The Brand identifier |
brandRegistryName | string | The Brand name |
pipes__BrandMetrics_Report
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/brand-metrics-openapi/#/Report/generateBrandMetricsReport
Brand Metrics report
Parameter
<profileId> (optional): Profile ID
<startDate> (optional): Start date|The start date for the report. For reportType PRODUCTS, startDate can only be within last 90 days from current date
<daysToRedownload> (optional): Days to redownload|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
brandName | string | Brand Name |
categoryNodeName | string | The hierarchical path that leads to a node starting with the root node. If no Category Node Name is passed, then all data available for all brands belonging to the entity are retrieved |
categoryNodeTreeName | string | The node at the top of a browse tree. It is the start node of a tree |
lookbackPeriod | string | Defines the period of time used to determine the number of shoppers in the metrics computation |
metricsComputationDate | date | Metrics computation date |
addToCarts | decimal | shoppers that added [Brand Name] to cart in [categoryNodePath] in [lookBackPeriod] |
addToCartsCategoryMedian | decimal | shoppers that added the peer median to cart in [categoryNodePath] in [lookBackPeriod] |
addToCartsReturnOnEngagement | decimal | The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
addToCartsROECategoryMedian | decimal | The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
addToCartsROECategoryTopPerformers | decimal | The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
awarenessIndex | decimal | Awareness Index measures actual on-Amazon audience signals reflecting awareness for your brand in the short and long term, across the whole on-Amazon audience. The percentile lets you know how the awareness activity for your brand compares to that of your peers |
brandCustomers | decimal | 0%-90% of sales contributing shoppers for [Brand Name] whom purchased in [categoryNodePath] in [lookBackPeriod] |
brandCustomersCategoryMedian | decimal | 0%-90% of sales contributors for the peer median whom purchased in [categoryNodePath] in [lookBackPeriod] |
brandCustomersCategoryTopPerformers | decimal | 0%-90% of sales contributors for avg. of the top 95th - 99th percent of peers whom purchased in [categoryNodePath] in [lookBackPeriod] |
brandCustomersReturnOnEngagement | decimal | The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
brandCustomersROECategoryMedian | decimal | The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
brandCustomersROECategoryTopPerformers | decimal | The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
brandedSearchesAndDetailPageViews | decimal | shoppers that searched brand and viewed detail page of [Brand Name] in [categoryNodePath] in [lookBackPeriod] |
brandedSearchesAndDetailPageViewsCategoryMedian | decimal | shoppers that searched brand and viewed the detail page of peer median in [categoryNodePath] in [lookBackPeriod] |
brandedSearchesAndDetailPageViewsCategoryTopPerformers | decimal | shoppers that searched brand and viewed the detail page of avg. of the top 95th - 99th percent of peers in [categoryNodePath] in [lookBackPeriod] |
brandedSearchesAndDetailPageViewsReturnOnEngagement | decimal | The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
brandedSearchesAndDetailPageViewsROECategoryMedian | decimal | The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
brandedSearchesAndDetailPageViewsROECategoryTopPerformers | decimal | The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
brandedSearchesCategoryMedian | decimal | shoppers that searched for the peer median, but did not further engage or purchase from peer median and [categoryNodePath] in the [lookBackPeriod] |
brandedSearchesCategoryTopPerformers | decimal | shoppers that searched for the avg. of the top 95th - 99th percent of peers, and [categoryNodePath] but did not further engage or purchase from the Top Performers in the [lookBackPeriod] |
brandedSearchesOnly | decimal | shoppers that searched for [Brand Name] but did not further engage or purchase from [Brand Name] and [categoryNodePath] in the [lookBackPeriod] |
considerationIndex | decimal | Consideration Index measures actual on-Amazon audience signals reflecting consideration for your brand in the short and long term, across the whole on-Amazon audience. The percentile lets you know how the consideration activity for your brand compares to that of your peers |
customerConversionRate | decimal | percentage of shoppers moving from "considering" [Brand Name] in the [categoryNodePath] to "purchased" in the [lookBackPeriod] |
customerConversionRateCategoryMedian | decimal | percentage of shoppers moving from "considering" the peer median in the [categoryNodePath] to "purchased" in the [lookBackPeriod] |
customerConversionRateCategoryTopPerformers | decimal | percentage of shoppers moving from "considering" the average of the top 95th-99th percent of peers in the [categoryNodePath] to "purchased" in the l[lookBackPeriod] |
engagedShopperRateCategoryMedianLowerBound | decimal | Lower bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchased from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category for the median peers |
engagedShopperRateCategoryMedianUpperBound | decimal | Upper bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category for the median peers |
engagedShopperRateCategoryTopPerformersLowerBound | decimal | Lower bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame by the total unique shoppers with 1+ detail page view in the selected category for the top 95th-99th percent of peers |
engagedShopperRateCategoryTopPerformersUpperBound | decimal | Upper bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category for the top 95th-99th percent of peers |
engagedShopperRateLowerBound | decimal | Lower bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from int the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category |
engagedShopperRateUpperBound | decimal | Upper bound on the percentage of unique shoppers in a category that your brand has driven an engagement with or purchase from in the selected time frame divided by the total unique shoppers with 1+ detail page view in the selected category |
highValueCustomers | decimal | top 10% of sales contributing shoppers for |
highValueCustomersCategoryMedian | decimal | top 10% of sales contributing shoppers for peer median in [categoryNodePath] in [lookBackPeriod] |
highValueCustomersCategoryTopPerformers | decimal | The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
highValueCustomersReturnOnEngagement | decimal | The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
highValueCustomersROECategoryMedian | decimal | The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total orginal population 12 months ago by the total amount of sales this populaton drove over the last year for your brand in the selected category |
newToBrandCustomerRate | decimal | share of customers that had not purchased [Brand Name] products in the last 12 months, but did so in the [lookBackPeriod] |
newToBrandCustomerRateCategoryMedian | decimal | share of customers that had not purchased peer median products in the last 12 months, but did so in the [lookBackPeriod] |
newToBrandCustomerRateCategoryTopPerformers | decimal | share of customers that had not purchased average of the top 95th-99th percent of peers products in the last 12 months, but did so in the [lookBackPeriod] |
salesIndex | decimal | Sales Index represents actual on-Amazon sales in the short term and long term, across the whole on-Amazon audience. The percentile lets you know how your sales compare to that of your peers |
viewedDetailPageCategoryMedian | decimal | shoppers that viewed the detail page only of peer median in [categoryNodePath] in [lookBackPeriod] |
viewedDetailPageCategoryTopPerformers | decimal | shoppers that viewed the detail page only of avg. of the top 95th - 99th percent of peers in [categoryNodePath] in [lookBackPeriod] |
viewedDetailPageOnly | decimal | shoppers that viewed detail page only of [Brand Name] in [categoryNodePath] in [lookBackPeriod] |
viewedDetailPageOnlyReturnOnEngagement | decimal | The average amount of sales each customer who was in this state 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
viewedDetailPageROECategoryMedian | decimal | The average amount of sales each customer who was in this state for the peer median 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
viewedDetailPageROECategoryTopPerformers | decimal | The average amount of sales each customer who was in this state for the 95-99 percent peers 12 months ago drove over 1 year. Calculated by taking the total original population 12 months ago by the total amount of sales this population drove over the last year for your brand in the selected category |
pipes__Brands_Campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Campaigns/listCampaigns
Brands Campaigns
Parameter
<profileId> (optional): Profile ID
<campaignIdFilter> (optional): The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string
<name> (optional): The returned array includes only campaigns with the specified name
<portfolioIdFilter> (optional): The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
campaignId | long | The campaign identifier |
name | string | The name of the campaign. This name must be unique to the Amazon Advertising account to which the campaign is associated. Maximum length of the string is 128 characters |
startDate | date | The start date for the campaign. If this field is not set to a value, the current date is used |
endDate | date | The 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 |
bidMultiplier | bigdecimal | A bid multiplier. Note that this field can only be set when 'bidOptimization' is set to false. Value is a percentage to two decimal places. Example: If set to -30.00 for a $5.00 bid, the resulting bid is $3.00 |
bidOptimization | boolean | Set to 'true' to allow Amazon to automatically optimize bids for placements below top of search |
brandEntityId | string | The brand entity identifier. Note that this field is required for sellers |
budget | bigdecimal | The budget amount associated with the campaign |
budgetType | string | Note that for the lifetime budget type, 'startDate' and 'endDate' must be specified. The lifetime budget range is from 100 to 20,000,000 and daily budget range is 1 to 1,000,000 by default for most marketplaces. For the JP marketplace, the lifetime budget range is fromt 10,000 to 2,000,000,000, and the daily budget range is 100 to 21,000,000 |
creative_asins | string | An array of ASINs associated with the creative |
creative_brandLogoAssetID | string | The identifier of the brand logo image from the Store assets library |
creative_brandLogoUrl | string | The address of the hosted image |
creative_brandName | string | A brand name. Maximum length is 30 characters |
creative_headline | string | 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 |
creative_shouldOptimizeAsins | boolean | Note that this field is supported only in the US and UK marketplaces. Set to true to have Amazon show other products from your landing page in the advertisement if they are more relevant to the shopper's search. Set to false to use the ASINs specified in the 'asins' field. Do not specify in unsupported marketplaces |
landingPage_asins | string | An array of ASINs used to generate a simple landing page. The response includes the URL of the generated simple landing page. Do not include this property in the request if the 'url' property is also included, these properties are mutually exclusive |
landingPage_pageType | string | |
landingPage_url | string | "URL of a Store page. Vendors may also specify the URL of a custom landing page. If a custom URL is specified, the landing page must include include the ASINs of at least three products that are advertised as part of the campaign. Do not include this property in the request if the 'asins' property is also included, these properties are mutually exclusive." |
portfolioId | long | The identifier of the portfolio to which the campaign is associated |
servingStatus | string | One of the following : asinNotBuyable,billingError,ended,landingPageNotAvailable,outOfBudget,paused,pendingReview,ready,rejected,running,scheduled,terminated |
state | string |
pipes__Brands_DraftCampaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Drafts
Brands Draft Campaigns
Parameter
<profileId> (optional): Profile ID
<draftCampaignIdFilter> (optional): The returned array includes only draft campaigns with identifiers matching those specified in the comma-delimited string.
<name> (optional): The returned array only includes draft campaigns with the specified name
<portfolioIdFilter> (optional): The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
draftCampaignId | long | The identifier of the draft campaign |
name | string | The name of the draft campaign. Maximum 128 characters. Duplicate campaign names are not allowed |
startDate | date | The start date for the campaign. If this field is not set to a value, the current date is used |
endDate | date | The 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 |
bidMultiplier | bigdecimal | A bid multiplier. Note that this field can only be set when 'bidOptimization' is set to false. Value is a percentage to two decimal places. Example: If set to -30.00 for a $5.00 bid, the resulting bid is $3.00 |
bidOptimization | boolean | Set to 'true' to allow Amazon to automatically optimize bids for placements below top of search |
brandEntityId | string | The brand entity identifier. Note that this field is required for sellers |
budget | bigdecimal | The budget associated with the draft campaign |
budgetType | string | Note that for the lifetime budget type, 'startDate' and 'endDate' must be specified. The lifetime budget range is from 100 to 20,000,000 and daily budget range is 1 to 1,000,000 by default for most marketplaces. For the JP marketplace, the lifetime budget range is fromt 10,000 to 2,000,000,000, and the daily budget range is 100 to 21,000,000 |
creative_asins | string | An array of ASINs associated with the creative |
creative_brandLogoAssetID | string | The identifier of the brand logo image from the Store assets library |
creative_brandLogoUrl | string | The address of the hosted image |
creative_brandName | string | A brand name. Maximum length is 30 characters |
creative_headline | string | 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 |
creative_shouldOptimizeAsins | boolean | Note that this field is supported only in the US and UK marketplaces. Set to true to have Amazon show other products from your landing page in the advertisement if they are more relevant to the shopper's search. Set to false to use the ASINs specified in the 'asins' field. Do not specify in unsupported marketplaces |
landingPage_asins | string | An array of ASINs used to generate a simple landing page. The response includes the URL of the generated simple landing page. Do not include this property in the request if the 'url' property is also included, these properties are mutually exclusive |
landingPage_pageType | string | |
landingPage_url | string | "URL of a Store page. Vendors may also specify the URL of a custom landing page. If a custom URL is specified, the landing page must include include the ASINs of at least three products that are advertised as part of the campaign. Do not include this property in the request if the 'asins' property is also included, these properties are mutually exclusive." |
portfolioId | long | The identifier of the Portfolio to which the draft campaign is associated |
pipes__Brands_Keywords
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Keywords
Brands Keywords
Parameter
<profileId> (optional): Profile ID
<adGroupIdFilter> (optional): The returned array includes only keywords associated with ad groups matching those specified by identifier in the comma-delimited string
<campaignIdFilter> (optional): The returned array includes only keywords associated with campaigns matching those specified by identifier in the comma-delimited string
<keywordIdFilter> (optional): The returned array includes only keywords with identifiers matching those specified in the comma-delimited string
<keywordText> (optional): The returned array includes only keywords with the specified text
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
adGroupId | long | The identifier of the ad group associated with the keyword |
bid | bigdecimal | The bid associated with the keyword |
campaignId | long | The identifier of the campaign associated with the keyword |
keywordId | long | The keyword identifier |
keywordText | string | The keyword text. The maximum number of words for this string is 10 |
matchType | string | The match type. For more information, see match types in the Amazon Advertising support center |
state | string | Newly created SB keywords are in a default state of 'draft' before transitioning to a 'pending' state for moderation. After moderation, the keyword will be in an enabled state |
pipes__Brands_NegativeKeywords
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Negative%20keywords
Brands Negative Keywords
Parameter
<profileId> (optional): Profile ID
<adGroupIdFilter> (optional): The returned array includes only negative keywords associated with ad groups matching those specified by identifier in the comma-delimited string
<campaignIdFilter> (optional): The returned array includes only negative keywords associated with campaigns matching those specified by identifier in the comma-delimited string
<keywordIdFilter> (optional): The returned array includes only negative keywords with identifiers matching those specified in the comma-delimited string
<keywordText> (optional): The returned array includes only negative keywords with the specified text
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
adGroupId | long | The identifier of the ad group associated with the keyword |
campaignId | long | The identifier of the campaign associated with the keyword |
keywordId | long | The keyword identifier |
keywordText | string | The keyword text. The maximum number of words for this string is 10 |
matchType | string | The negative match type. For more information, see negative keyword match types in the Amazon Advertising support center |
state | string | Newly created SB keywords are in a default state of 'draft' before transitioning to a 'pending' state for moderation. After moderation, the keyword will be in an enabled state |
pipes__Brands_Report_AdGroups
Amazon Record Type: adGroups
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Reports/post_v2_hsa__recordType__report
Brands AdGroups Performance
Parameter
<profileId> (optional): CSV list of profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<leaveReDownloadedData> (optional): Leave all data in the table|Skip the deletion of data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
isVideo | boolean | From Sponsored Brands video report |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
adGroupId | long | Unique AdGroup ID |
adGroupName | string | Unique AdGroup name |
campaignBudget | bigdecimal | The campaign budget |
campaignBudgetType | string | One of: daily or lifetime |
campaignId | long | Unique campaign ID |
campaignName | string | Advertiser created campaign name |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
campaignStatus | string | Current status of the campaign |
keywordId | long | Keyword ID |
keywordBid | bigdecimal | User-set bid value for keyword |
keywordStatus | string | Keyword state |
keywordText | string | Keyword or phrase used in bid |
applicableBudgetRuleId | long | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
targetId | long | The product target identifier |
targetingExpression | string | The product targeting expression. Not available for search term report |
targetingText | string | The product targeting text. Not available for search term report |
targetingType | string | The product targeting type. One of: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs |
searchTermImpressionRank | string | Search term impression rank provides account-level ad-attributed impression rank for search terms |
searchTermImpressionShare | string | Search term impression share provides account-level ad-attributed impression share for search terms |
matchType | string | One of: broad, phrase, or exact |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
impressions | bigdecimal | Total ad impressions |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
viewableImpressions | bigdecimal | Views is the number of impressions that met the MRC viewability standard (50% viewable with 2 seconds playback completed) |
videoFirstQuartileViews | bigdecimal | The number of impressions where the video was viewed to 25% |
videoMidpointViews | bigdecimal | The number of impressions where the video was viewed to 50% |
videoThirdQuartileViews | bigdecimal | The number of impressions where the video was viewed to 75% |
videoCompleteViews | bigdecimal | The number of impressions where the video was viewed to 100% |
video5SecondViews | bigdecimal | The number of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
video5SecondViewRate | bigdecimal | The percentage of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
videoUnmutes | bigdecimal | The number of impressions where a shopper unmuted the video |
vtr | bigdecimal | View-through-rate (views/impressions) |
vctr | bigdecimal | Clicks-through-rate for views (clicks/views) |
errorMessage | string | Error message if any problem happened |
pipes__Brands_Report_Campaigns
Amazon Record Type: campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Reports/post_v2_hsa__recordType__report
Brands Campigns Performance
Parameter
<profileId> (optional): CSV list of profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<leaveReDownloadedData> (optional): Leave all data in the table|Skip the deletion of data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
isVideo | boolean | From Sponsored Brands video report |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
adGroupId | long | Unique AdGroup ID |
adGroupName | string | Unique AdGroup name |
campaignBudget | bigdecimal | The campaign budget |
campaignBudgetType | string | One of: daily or lifetime |
campaignId | long | Unique campaign ID |
campaignName | string | Advertiser created campaign name |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
campaignStatus | string | Current status of the campaign |
keywordId | long | Keyword ID |
keywordBid | bigdecimal | User-set bid value for keyword |
keywordStatus | string | Keyword state |
keywordText | string | Keyword or phrase used in bid |
applicableBudgetRuleId | long | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
targetId | long | The product target identifier |
targetingExpression | string | The product targeting expression. Not available for search term report |
targetingText | string | The product targeting text. Not available for search term report |
targetingType | string | The product targeting type. One of: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs |
searchTermImpressionRank | string | Search term impression rank provides account-level ad-attributed impression rank for search terms |
searchTermImpressionShare | string | Search term impression share provides account-level ad-attributed impression share for search terms |
matchType | string | One of: broad, phrase, or exact |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
impressions | bigdecimal | Total ad impressions |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
viewableImpressions | bigdecimal | Views is the number of impressions that met the MRC viewability standard (50% viewable with 2 seconds playback completed) |
videoFirstQuartileViews | bigdecimal | The number of impressions where the video was viewed to 25% |
videoMidpointViews | bigdecimal | The number of impressions where the video was viewed to 50% |
videoThirdQuartileViews | bigdecimal | The number of impressions where the video was viewed to 75% |
videoCompleteViews | bigdecimal | The number of impressions where the video was viewed to 100% |
video5SecondViews | bigdecimal | The number of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
video5SecondViewRate | bigdecimal | The percentage of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
videoUnmutes | bigdecimal | The number of impressions where a shopper unmuted the video |
vtr | bigdecimal | View-through-rate (views/impressions) |
vctr | bigdecimal | Clicks-through-rate for views (clicks/views) |
errorMessage | string | Error message if any problem happened |
pipes__Brands_Report_Keywords
Amazon Record Type: keywords
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Reports/post_v2_hsa__recordType__report
Brands Keywords Performance
Parameter
<profileId> (optional): CSV list of profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<leaveReDownloadedData> (optional): Leave all data in the table|Skip the deletion of data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
isVideo | boolean | From Sponsored Brands video report |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
adGroupId | long | Unique AdGroup ID |
adGroupName | string | Unique AdGroup name |
campaignBudget | bigdecimal | The campaign budget |
campaignBudgetType | string | One of: daily or lifetime |
campaignId | long | Unique campaign ID |
campaignName | string | Advertiser created campaign name |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
campaignStatus | string | Current status of the campaign |
keywordId | long | Keyword ID |
keywordBid | bigdecimal | User-set bid value for keyword |
keywordStatus | string | Keyword state |
keywordText | string | Keyword or phrase used in bid |
applicableBudgetRuleId | long | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
targetId | long | The product target identifier |
targetingExpression | string | The product targeting expression. Not available for search term report |
targetingText | string | The product targeting text. Not available for search term report |
targetingType | string | The product targeting type. One of: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs |
searchTermImpressionRank | string | Search term impression rank provides account-level ad-attributed impression rank for search terms |
searchTermImpressionShare | string | Search term impression share provides account-level ad-attributed impression share for search terms |
matchType | string | One of: broad, phrase, or exact |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
impressions | bigdecimal | Total ad impressions |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
viewableImpressions | bigdecimal | Views is the number of impressions that met the MRC viewability standard (50% viewable with 2 seconds playback completed) |
videoFirstQuartileViews | bigdecimal | The number of impressions where the video was viewed to 25% |
videoMidpointViews | bigdecimal | The number of impressions where the video was viewed to 50% |
videoThirdQuartileViews | bigdecimal | The number of impressions where the video was viewed to 75% |
videoCompleteViews | bigdecimal | The number of impressions where the video was viewed to 100% |
video5SecondViews | bigdecimal | The number of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
video5SecondViewRate | bigdecimal | The percentage of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
videoUnmutes | bigdecimal | The number of impressions where a shopper unmuted the video |
vtr | bigdecimal | View-through-rate (views/impressions) |
vctr | bigdecimal | Clicks-through-rate for views (clicks/views) |
errorMessage | string | Error message if any problem happened |
pipes__Brands_Report_Keywords_SegementPlacement
Amazon Record Type: keywords
Amazon Segment: placement
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Reports/post_v2_hsa__recordType__report
Brands Keywords Performance and Segment by Placement
Parameter
<profileId> (optional): CSV list of profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<leaveReDownloadedData> (optional): Leave all data in the table|Skip the deletion of data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
isVideo | boolean | From Sponsored Brands video report |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
adGroupId | long | Unique AdGroup ID |
adGroupName | string | Unique AdGroup name |
campaignBudget | bigdecimal | The campaign budget |
campaignBudgetType | string | One of: daily or lifetime |
campaignId | long | Unique campaign ID |
campaignName | string | Advertiser created campaign name |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
campaignStatus | string | Current status of the campaign |
keywordId | long | Keyword ID |
keywordBid | bigdecimal | User-set bid value for keyword |
keywordStatus | string | Keyword state |
keywordText | string | Keyword or phrase used in bid |
applicableBudgetRuleId | long | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
targetId | long | The product target identifier |
targetingExpression | string | The product targeting expression. Not available for search term report |
targetingText | string | The product targeting text. Not available for search term report |
targetingType | string | The product targeting type. One of: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs |
searchTermImpressionRank | string | Search term impression rank provides account-level ad-attributed impression rank for search terms |
searchTermImpressionShare | string | Search term impression share provides account-level ad-attributed impression share for search terms |
matchType | string | One of: broad, phrase, or exact |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
impressions | bigdecimal | Total ad impressions |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
viewableImpressions | bigdecimal | Views is the number of impressions that met the MRC viewability standard (50% viewable with 2 seconds playback completed) |
videoFirstQuartileViews | bigdecimal | The number of impressions where the video was viewed to 25% |
videoMidpointViews | bigdecimal | The number of impressions where the video was viewed to 50% |
videoThirdQuartileViews | bigdecimal | The number of impressions where the video was viewed to 75% |
videoCompleteViews | bigdecimal | The number of impressions where the video was viewed to 100% |
video5SecondViews | bigdecimal | The number of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
video5SecondViewRate | bigdecimal | The percentage of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
videoUnmutes | bigdecimal | The number of impressions where a shopper unmuted the video |
vtr | bigdecimal | View-through-rate (views/impressions) |
vctr | bigdecimal | Clicks-through-rate for views (clicks/views) |
errorMessage | string | Error message if any problem happened |
pipes__Brands_Report_Keywords_SegementQuery
Amazon Record Type: keywords
Amazon Segment: query
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#/Reports/post_v2_hsa__recordType__report
Brands Keywords Performance and Segment by Query
Parameter
<profileId> (optional): CSV list of profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<leaveReDownloadedData> (optional): Leave all data in the table|Skip the deletion of data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
isVideo | boolean | From Sponsored Brands video report |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
adGroupId | long | Unique AdGroup ID |
adGroupName | string | Unique AdGroup name |
campaignBudget | bigdecimal | The campaign budget |
campaignBudgetType | string | One of: daily or lifetime |
campaignId | long | Unique campaign ID |
campaignName | string | Advertiser created campaign name |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
campaignStatus | string | Current status of the campaign |
keywordId | long | Keyword ID |
keywordBid | bigdecimal | User-set bid value for keyword |
keywordStatus | string | Keyword state |
keywordText | string | Keyword or phrase used in bid |
applicableBudgetRuleId | long | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
targetId | long | The product target identifier |
targetingExpression | string | The product targeting expression. Not available for search term report |
targetingText | string | The product targeting text. Not available for search term report |
targetingType | string | The product targeting type. One of: asinCategorySameAs, asinBrandSameAs, asinPriceLessThan, asinPriceBetween, asinPriceGreaterThan, asinReviewRatingLessThan, asinReviewRatingBetween, asinReviewRatingGreaterThan, asinSameAs |
searchTermImpressionRank | string | Search term impression rank provides account-level ad-attributed impression rank for search terms |
searchTermImpressionShare | string | Search term impression share provides account-level ad-attributed impression share for search terms |
matchType | string | One of: broad, phrase, or exact |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
impressions | bigdecimal | Total ad impressions |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
viewableImpressions | bigdecimal | Views is the number of impressions that met the MRC viewability standard (50% viewable with 2 seconds playback completed) |
videoFirstQuartileViews | bigdecimal | The number of impressions where the video was viewed to 25% |
videoMidpointViews | bigdecimal | The number of impressions where the video was viewed to 50% |
videoThirdQuartileViews | bigdecimal | The number of impressions where the video was viewed to 75% |
videoCompleteViews | bigdecimal | The number of impressions where the video was viewed to 100% |
video5SecondViews | bigdecimal | The number of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
video5SecondViewRate | bigdecimal | The percentage of impressions where the shopper watched the complete video or 5 seconds (whichever is shorter) |
videoUnmutes | bigdecimal | The number of impressions where a shopper unmuted the video |
vtr | bigdecimal | View-through-rate (views/impressions) |
vctr | bigdecimal | Clicks-through-rate for views (clicks/views) |
errorMessage | string | Error message if any problem happened |
pipes__Consolidated_Report_AdGroups
Amazon Record Type: adGroups
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Consolidated Ad Groups Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
report_source | string | Source report name |
tactic | string | Advertising tactic associated with campaign for sponsored display report |
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Current status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignBudgetType | string | One of: daily or lifetime |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
adid | long | The unique numerical ID of the ad |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
keywordStatus | string | Keyword state |
keywordBid | bigdecimal | User-set bid value for keyword |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
asin | string | The ASIN that is being advertised |
sku | string | The SKU that is being advertised |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
isVideo | boolean | From Sponsored Brands video report |
errorMessage | string | Error message if any problem happened |
pipes__Consolidated_Report_Campaigns
Amazon Record Type: campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Consolidated Campaigns Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
report_source | string | Source report name |
tactic | string | Advertising tactic associated with campaign for sponsored display report |
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Current status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignBudgetType | string | One of: daily or lifetime |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
adid | long | The unique numerical ID of the ad |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
keywordStatus | string | Keyword state |
keywordBid | bigdecimal | User-set bid value for keyword |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
asin | string | The ASIN that is being advertised |
sku | string | The SKU that is being advertised |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
isVideo | boolean | From Sponsored Brands video report |
errorMessage | string | Error message if any problem happened |
pipes__Consolidated_Report_Keywords
Amazon Record Type: keywords
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Consolidated Ad Groups Performance, Consolidated Campaigns Performance, Consolidated Keywords Performance, Consolidated Product Ads Performance, Consolidated Targets Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
report_source | string | Source report name |
tactic | string | Advertising tactic associated with campaign for sponsored display report |
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Current status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignBudgetType | string | One of: daily or lifetime |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
adid | long | The unique numerical ID of the ad |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
keywordStatus | string | Keyword state |
keywordBid | bigdecimal | User-set bid value for keyword |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
asin | string | The ASIN that is being advertised |
sku | string | The SKU that is being advertised |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
isVideo | boolean | From Sponsored Brands video report |
errorMessage | string | Error message if any problem happened |
pipes__Consolidated_Report_ProductAds
Amazon Record Type: productAds
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Consolidated Product Ads Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
report_source | string | Source report name |
tactic | string | Advertising tactic associated with campaign for sponsored display report |
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Current status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignBudgetType | string | One of: daily or lifetime |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
adid | long | The unique numerical ID of the ad |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
keywordStatus | string | Keyword state |
keywordBid | bigdecimal | User-set bid value for keyword |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
asin | string | The ASIN that is being advertised |
sku | string | The SKU that is being advertised |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
isVideo | boolean | From Sponsored Brands video report |
errorMessage | string | Error message if any problem happened |
pipes__Consolidated_Report_Targets
Amazon Record Type: campaigns, targets
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Consolidated Targets Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<days_step> (optional): Number of days to query in a single batch
Attribute | Type | Description |
|---|---|---|
report_source | string | Source report name |
tactic | string | Advertising tactic associated with campaign for sponsored display report |
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Current status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignBudgetType | string | One of: daily or lifetime |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
adid | long | The unique numerical ID of the ad |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
keywordStatus | string | Keyword state |
keywordBid | bigdecimal | User-set bid value for keyword |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
placement | string | The optional dimension on which to segment a campaigns report. Placement refers to the location on a page where your ad appears |
query | string | The optional dimension on which to segment a keyword report. This is also referred to as the search terms report |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
asin | string | The ASIN that is being advertised |
sku | string | The SKU that is being advertised |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedDetailPageViewsClicks14d | bigdecimal | The number of detail page view conversions attributed to ad click-throughs within 14 days |
attributedOrderRateNewToBrand14d | bigdecimal | The number of new-to-brand orders relative to the number of clicks |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedOrdersNewToBrandPercentage14d | bigdecimal | The percentage of total orders that are new-to-brand orders |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on an ad |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders |
attributedSalesNewToBrandPercentage14d | bigdecimal | The percentage of total sales of new-to-brand purchases |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrandPercentage14d | bigdecimal | The percentage of total units that are units from new-to-brand orders |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
dpv14d | bigdecimal | Number of attributed detail page views occurring within 14 days of click on an ad |
unitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
isVideo | boolean | From Sponsored Brands video report |
errorMessage | string | Error message if any problem happened |
pipes__Display_AdGroups
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Ad%20groups
Display Ad Groups
Parameter
<profileId> (optional): Profile ID
<adGroupIdFilter> (optional): The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list
<campaignIdFilter> (optional): The returned array is filtered to include only ad groups associated with the campaign identifiers in the comma-delimited list
<name> (optional): The returned array includes only ad groups with the specified name
<stateFilter> (optional): The returned array is filtered to include only campaigns with state set to one of the values in the comma-delimited list
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
adGroupId | long | The identifier of the ad group |
campaignId | long | The identifier of the campaign that this ad group is associated with |
defaultBid | bigdecimal | The amount of the default bid associated with the ad group. Used if no bid is specified |
name | string | The name of the ad group |
servingStatus | string | The status of the ad group |
state | string | The delivery state of the ad group |
creationDate | timestamp | Epoch time the ad group was created |
lastUpdatedDate | timestamp | Epoch time any property in the ad group was last updated |
pipes__Display_Campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Campaigns
Display Campaigns
Parameter
<profileId> (optional): Profile ID
<campaignIdFilter> (optional): The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string
<name> (optional): The returned array includes only campaign with the specified name using an exact string match
<stateFilter> (optional): The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
campaignId | long | The identifier of the campaign |
startDate | date | The start date of the campaign. The date must be today or in the future |
endDate | date | The end date of the campaign |
budget | bigdecimal | The amount of the budget |
budgetType | string | The time period over which the amount specified in the 'budget' property is allocated |
costType | string | |
deliveryProfile | string | |
name | string | The name of the campaign |
servingStatus | string | The status of the campaign |
state | string | The state of the campaign |
tactic | string | The advertising tactic associated with the campaign. The following table lists available tactic names: T00001, T00020, remarketing |
creationDate | timestamp | Epoch date the campaign was created |
lastUpdatedDate | timestamp | Epoch date of the last update to any property associated with the campaign |
pipes__Display_ProductAds
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Product%20ads
Display Product Ads
Parameter
<profileId> (optional): Profile ID
<adGroupIdFilter> (optional): The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list
<adIdFilter> (optional): The returned array includes only product ads with identifiers matching those in the comma-delimited string
<campaignIdFilter> (optional): The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list
<stateFilter> (optional): The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
adId | long | The identifier of the ad |
adGroupId | long | The identifier of the ad group associated with the ad |
asin | string | The ASIN of the product being advertised |
campaignId | long | The identifier of the campaign associated with the ad |
servingStatus | string | The status of the product ad |
sku | string | The SKU of the product being advertised |
state | string | The state of the product ad |
creationDate | timestamp | Epoch date the product ad was created |
lastUpdatedDate | timestamp | Epoch date of the last update to any property associated with the product ad |
pipes__Display_Report_AdGroups
Amazon recordType: adGroups
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Display AdGroups Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<tactic> (optional): The advertising tactic associated with the campaign. The following table lists available tactic names: remarketing, T00020, T00030
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
tactic | string | The advertising tactic associated with the campaign |
adGroupId | long | The identifier of the ad group |
adGroupName | string | The name of the ad group |
adid | long | The unique numerical ID of the ad |
asin | string | The ASIN of the product |
sku | string | The SKU of the product |
campaignId | long | The identifier of the campaign |
campaignName | string | The name of the campaign |
campaignStatus | string | The status of the campaign |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | The string representation of your expression object in targeting clauses |
targetingText | string | The resolved string representation of your expression object in targeting clauses |
targetingType | string | The type of match for the targeting expression used in bid. For manually created expressions, this value is TARGETING_EXPRESSION. For auto-targeting expressions this value is TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales14d | bigdecimal | Total number of attributed sales occuring within 14 days of ad click |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
viewImpressions | bigdecimal | Total number of ad viewable impressions |
viewAttributedConversions14d | bigdecimal | Total number of attributed conversion events occurring within 14 days of ad click or view |
viewAttributedSales14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
viewAttributedUnitsOrdered14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
errorMessage | string | Error message if any problem happened |
pipes__Display_Report_Campaigns
Amazon recordType: campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Display Campigns Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<tactic> (optional): The advertising tactic associated with the campaign. The following table lists available tactic names: remarketing, T00020, T00030
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
tactic | string | The advertising tactic associated with the campaign |
adGroupId | long | The identifier of the ad group |
adGroupName | string | The name of the ad group |
adid | long | The unique numerical ID of the ad |
asin | string | The ASIN of the product |
sku | string | The SKU of the product |
campaignId | long | The identifier of the campaign |
campaignName | string | The name of the campaign |
campaignStatus | string | The status of the campaign |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | The string representation of your expression object in targeting clauses |
targetingText | string | The resolved string representation of your expression object in targeting clauses |
targetingType | string | The type of match for the targeting expression used in bid. For manually created expressions, this value is TARGETING_EXPRESSION. For auto-targeting expressions this value is TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales14d | bigdecimal | Total number of attributed sales occuring within 14 days of ad click |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
viewImpressions | bigdecimal | Total number of ad viewable impressions |
viewAttributedConversions14d | bigdecimal | Total number of attributed conversion events occurring within 14 days of ad click or view |
viewAttributedSales14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
viewAttributedUnitsOrdered14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
errorMessage | string | Error message if any problem happened |
pipes__Display_Report_ProductAds
Amazon recordType: productAds
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Display Product Ads Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<tactic> (optional): The advertising tactic associated with the campaign. The following table lists available tactic names: remarketing, T00020, T00030
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
tactic | string | The advertising tactic associated with the campaign |
adGroupId | long | The identifier of the ad group |
adGroupName | string | The name of the ad group |
adid | long | The unique numerical ID of the ad |
asin | string | The ASIN of the product |
sku | string | The SKU of the product |
campaignId | long | The identifier of the campaign |
campaignName | string | The name of the campaign |
campaignStatus | string | The status of the campaign |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | The string representation of your expression object in targeting clauses |
targetingText | string | The resolved string representation of your expression object in targeting clauses |
targetingType | string | The type of match for the targeting expression used in bid. For manually created expressions, this value is TARGETING_EXPRESSION. For auto-targeting expressions this value is TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales14d | bigdecimal | Total number of attributed sales occuring within 14 days of ad click |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
viewImpressions | bigdecimal | Total number of ad viewable impressions |
viewAttributedConversions14d | bigdecimal | Total number of attributed conversion events occurring within 14 days of ad click or view |
viewAttributedSales14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
viewAttributedUnitsOrdered14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
errorMessage | string | Error message if any problem happened |
pipes__Display_Report_Targets
Amazon recordType: targets
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
Display AdGroups Performance, Display Campigns Performance, Display Product Ads Performance, Display Targets Performance, (outdated) Display Targets Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<tactic> (optional): The advertising tactic associated with the campaign. The following table lists available tactic names: remarketing, T00020, T00030
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
tactic | string | The advertising tactic associated with the campaign |
adGroupId | long | The identifier of the ad group |
adGroupName | string | The name of the ad group |
adid | long | The unique numerical ID of the ad |
asin | string | The ASIN of the product |
sku | string | The SKU of the product |
campaignId | long | The identifier of the campaign |
campaignName | string | The name of the campaign |
campaignStatus | string | The status of the campaign |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | The string representation of your expression object in targeting clauses |
targetingText | string | The resolved string representation of your expression object in targeting clauses |
targetingType | string | The type of match for the targeting expression used in bid. For manually created expressions, this value is TARGETING_EXPRESSION. For auto-targeting expressions this value is TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales14d | bigdecimal | Total number of attributed sales occuring within 14 days of ad click |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
viewImpressions | bigdecimal | Total number of ad viewable impressions |
viewAttributedConversions14d | bigdecimal | Total number of attributed conversion events occurring within 14 days of ad click or view |
viewAttributedSales14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
viewAttributedUnitsOrdered14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
errorMessage | string | Error message if any problem happened |
pipes__Display_Report_Targets_T00020
Amazon recordType: targets
Amazon tactic: T00020
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Reports/requestReport
(outdated) Display Targets Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<tactic> (optional): The advertising tactic associated with the campaign. The following table lists available tactic names: remarketing, T00020, T00030
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
tactic | string | The advertising tactic associated with the campaign |
adGroupId | long | The identifier of the ad group |
adGroupName | string | The name of the ad group |
adid | long | The unique numerical ID of the ad |
asin | string | The ASIN of the product |
sku | string | The SKU of the product |
campaignId | long | The identifier of the campaign |
campaignName | string | The name of the campaign |
campaignStatus | string | The status of the campaign |
targetId | long | The identifier of the targeting expression used in a bid |
targetingExpression | string | The string representation of your expression object in targeting clauses |
targetingText | string | The resolved string representation of your expression object in targeting clauses |
targetingType | string | The type of match for the targeting expression used in bid. For manually created expressions, this value is TARGETING_EXPRESSION. For auto-targeting expressions this value is TARGETING_EXPRESSION_PREDEFINED |
clicks | bigdecimal | Total number of ad clicks associated with the campaign |
cost | bigdecimal | The total cost of all ad clicks for the campaign. Divide cost by clicks to calculate average cost per click (CPC) |
currency | string | The currency code associated with the campaign |
impressions | bigdecimal | Total number of ad impressions |
attributedConversions1d | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click |
attributedConversions7d | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click |
attributedConversions14d | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click |
attributedConversions30d | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click |
attributedConversions1dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions7dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions14dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedConversions30dSameSKU | bigdecimal | Total number of attributed conversion events occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the conversion event are equivalent |
attributedUnitsOrdered1d | bigdecimal | Total number of attributed units ordered within 24 hours of ad click |
attributedUnitsOrdered7d | bigdecimal | Total number of attributed units ordered within 7 days of ad click |
attributedUnitsOrdered14d | bigdecimal | Total number of attributed units ordered within 14 days of ad click |
attributedUnitsOrdered30d | bigdecimal | Total number of attributed units ordered within 30 days of ad click |
attributedSales1d | bigdecimal | Total number of attributed sales occuring within 24 hours of ad click |
attributedSales7d | bigdecimal | Total number of attributed sales occuring within 7 days of ad click |
attributedSales14d | bigdecimal | Total number of attributed sales occuring within 14 days of ad click |
attributedSales30d | bigdecimal | Total number of attributed sales occuring within 30 days of ad click |
attributedSales1dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 24 hours of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales7dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 7 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales14dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 14 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedSales30dSameSKU | bigdecimal | Aggregate value of all attributed sales occuring within 30 days of ad click, where the SKU of the product advertised and the SKU of the purchased item are equivalent |
attributedDPV14d | bigdecimal | Number of attributed detail page views occuring within 14 days of click on an ad |
attributedUnitsSold14d | bigdecimal | Number of attributed units sold occurring within 14 days of click on an ad |
attributedOrdersNewToBrand14d | bigdecimal | The number of first-time orders for products within the brand over a one-year lookback window |
attributedSalesNewToBrand14d | bigdecimal | The total sales of new-to-brand orders for products within the brand over a one-year lookback window |
attributedUnitsOrderedNewToBrand14d | bigdecimal | The number of units from first-time orders for products within the brand over a one-year lookback window |
viewImpressions | bigdecimal | Total number of ad viewable impressions |
viewAttributedConversions14d | bigdecimal | Total number of attributed conversion events occurring within 14 days of ad click or view |
viewAttributedSales14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
viewAttributedUnitsOrdered14d | bigdecimal | Total number of attributed sales occurring within 14 days of ad click or view |
errorMessage | string | Error message if any problem happened |
pipes__Display_Targets
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Targeting
Display Targets
Parameter
<profileId> (optional): Profile ID
<adGroupIdFilter> (optional): Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified 'adGroupId'
<campaignIdFilter> (optional): Restricts results to ads within campaigns specified in comma-separated list
<stateFilter> (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
<targetIdFilter> (optional): Restricts results to ads with the specified 'tagetId' specified in comma-separated list
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
targetId | long | The identifier of the targeting expression used in a bid |
adGroupId | long | The identifier of the ad group |
bid | bigdecimal | If a value for 'bid' is specified, it overrides the current adGroup bid. Note that this field is ignored for negative targeting clauses |
expression | string | The targeting expression to match against |
resolvedExpression | string | |
servingStatus | string | The status of the target |
state | string | One of the following: enabled, paused, archived |
creationDate | timestamp | Epoch date the target was created |
lastUpdatedDate | timestamp | Epoch date of the last update to any property associated with the target |
pipes__History
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/change-history/
History of changes
Parameter
<profileId> (optional): Profile ID
<startDate> (optional): Start date
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
timestamp | timestamp | Timestamp |
changeType | string | Change type for Entity types |
entityType | string | Entity type |
entityId | string | Entity id |
newValue | string | New value |
previousValue | string | Previous value |
metadata_productTargetingType | string | Product targeting type |
metadata_programType | string | Program type |
metadata_campaignId | string | Campaign id |
metadata_campaignBudgetType | string | Campaign budget type |
metadata_keywordType | string | Keyword type |
metadata_predefinedTarget | string | Predefined target |
metadata_keyword | string | Keyword |
metadata_adAsin | string | Ad asin |
metadata_targetingExpression | string | Targeting expression |
metadata_placementGroupPosition | string | Placement group position |
metadata_negativeTargetingType | string | Negative targeting type |
metadata_adGroupId | string | AdGroup id |
pipes__Invoices
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/invoices/#/invoice/getAdvertiserInvoices
Invoices
Parameter
<profileId> (optional): Profile ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
fromDate | date | From date |
toDate | date | To date |
id | string | Invoice Id |
invoiceDate | date | Invoice date |
dueDate | date | Due date |
status | string | Invoice Status: - ISSUED: An invoice is issued when its charges are finalized and tax is computed on the total amount; - PAID_IN_PART: When a partial payment is received, the invoice status will change to paid in part; - PAID_IN_PART: One full payment has been received, the invoice will be paid in full; - WRITTEN_OFF: If an invoice is written off because of an error, the status will be updated to written off |
purchaseOrderNumber | string | Account-level purchase order number |
paymentMethod | string | Payment method: CREDIT_CARD, ELECTRONIC_FUNDS_TRANSFER, DEDUCT_FROM_PAYMENT, UNIFIED_BILLING |
amountDue_amount | bigdecimal | Amount due |
amountDue_currencyCode | string | The currency used for all monetary values for entities under this profile |
taxAmountDue_amount | bigdecimal | Amount due |
taxAmountDue_currencyCode | string | The currency used for all monetary values for entities under this profile |
remainingAmountDue_amount | bigdecimal | Remaining Amount due |
remainingAmountDue_currencyCode | string | The currency used for all monetary values for entities under this profile |
remainingTaxAmountDue_amount | bigdecimal | Amount due |
remainingTaxAmountDue_currencyCode | string | The currency used for all monetary values for entities under this profile |
pipes__DailyReport_AdGroups
Amazon Record Type: adGroups
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
(outdated) Products Ad Groups Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__DailyReport_Campaigns
Amazon Record Type: campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
(outdated) Products Campaigns Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__DailyReport_Keywords
Amazon Record Type: keywords
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
(outdated) Products Keywords Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__DailyReport_ProductAds
Amazon Record Type: productAds
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
(outdated) Products Ad Groups Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__DailyReport_Targets
Amazon Record Type: targets
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
(outdated) Products Targets Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Products_Report_AdGroups
Amazon Record Type: productAds
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
Products Ad Groups Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Products_Report_Asins
Amazon Record Type: asins
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
Products Asins
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Products_Report_Campaigns
Amazon Record Type: campaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
Products Campaigns Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Products_Report_Keywords
Amazon Record Type: keywords
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
Products Keywords Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Products_Report_ProductAds
Amazon Record Type: productAds
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
Product Ads Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Products_Report_Targets
Amazon Record Type: targets
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Reports/requestReport
Products Targets Performance
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile Id |
reportDate | date | The date of the performance report |
campaignName | string | Unique name of the campaign |
campaignId | long | Unique numerical ID of the campaign |
campaignStatus | string | Status of the campaign |
campaignBudget | bigdecimal | Total budget allotted to the campaign |
campaignRuleBasedBudget | bigdecimal | The value of the rule-based budget |
applicableBudgetRuleId | string | The identifier of the active rule |
applicableBudgetRuleName | string | The name of the active rule |
adGroupName | string | Unique name of the ad group |
adGroupId | long | Unique numerical ID of the ad group |
keywordId | long | ID of the keyword used in bid |
keywordText | string | Text of the keyword or phrase used in bid |
matchType | string | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact |
query | string | Query dimension on which to segment a keyword report |
targetId | long | ID of the targeting expression used in a bid |
targetingExpression | string | A string representation of your expression object in targeting clauses |
targetingText | string | A resolved string representation of your expression object in targeting clauses |
targetingType | string | Type of matching for the targeting expression used in bid. For manually created expressions this value is: TARGETING_EXPRESSION. For auto-targeting expressions this value is: TARGETING_EXPRESSION_PREDEFINED |
impressions | bigdecimal | Total ad impressions |
clicks | bigdecimal | Total ad clicks |
cost | bigdecimal | Total cost of all clicks. Can be divided by clicks to obtain average CPC |
currency | string | A dimensional metric |
asin | string | The ASIN that is being advertised |
otherAsin | string | A non-dimensional metric for ASINs other than the one advertised |
sku | string | The SKU that is being advertised. Not available for vendors |
bidPlus | string | A dimensional metric. See the premium bid adjustment section in the developer notes |
attributedConversions1d | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad |
attributedConversions7d | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad |
attributedConversions14d | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad |
attributedConversions30d | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad |
attributedConversions1dSameSKU | bigdecimal | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions7dSameSKU | bigdecimal | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions14dSameSKU | bigdecimal | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedConversions30dSameSKU | bigdecimal | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1d | bigdecimal | Number of attributed units ordered within 1 day of click on ad |
attributedUnitsOrdered7d | bigdecimal | Number of attributed units ordered within 7 days of click on ad |
attributedUnitsOrdered14d | bigdecimal | Number of attributed units ordered within 14 days of click on ad |
attributedUnitsOrdered30d | bigdecimal | Number of attributed units ordered within 30 days of click on ad |
attributedUnitsOrdered1dSameSKU | bigdecimal | Number of attributed units ordered within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered7dSameSKU | bigdecimal | Number of attributed units ordered within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered14dSameSKU | bigdecimal | Number of attributed units ordered within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered30dSameSKU | bigdecimal | Number of attributed units ordered within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedUnitsOrdered1dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 1 day |
attributedUnitsOrdered7dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 7 days |
attributedUnitsOrdered14dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 14 days |
attributedUnitsOrdered30dOtherSKU | bigdecimal | Number of other ASIN (SKU) units sold. 30 days |
attributedSales1d | bigdecimal | Number of attributed sales occurring within 1 day of click on ad |
attributedSales7d | bigdecimal | Number of attributed sales occurring within 7 days of click on ad |
attributedSales14d | bigdecimal | Number of attributed sales occurring within 14 days of click on ad |
attributedSales30d | bigdecimal | Number of attributed sales occurring within 30 days of click on ad |
attributedSales1dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised |
attributedSales7dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales14dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales30dSameSKU | bigdecimal | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised |
attributedSales1dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 1 day |
attributedSales7dOtherSKU | bigdecimal | Sales for another ASIN (SKU). 7 days |
attributedSales14dOtherSKU | bigdecimal | Sales for another ASIN (sku). 14 days |
attributedSales30dOtherSKU | bigdecimal | Sales for another ASIN (sku). 30 days |
attributedKindleEditionNormalizedPagesRead14d | bigdecimal | Number of attributed kindle edition normalized pages read within 14 days of click on ad |
attributedKindleEditionNormalizedPagesRoyalties14d | bigdecimal | The estimated Royalties of attributed estimated kindle edition normalized pages with in 14 days of click on ad |
errorMessage | string | Error message if any problem happened |
pipes__Report_Products_AdvertisedProducts
Amazon Report Type Id: spAdvertisedProduct
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/createAsyncReport
Sponsored Products : Advertised Products Report v.3
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | ID of the profile |
date | date | Date when the ad activity ocurred in the format YYYY-MM-DD |
acosClicks14d | decimal | Advertising cost of sales based on purchases made within 14 days of an ad click |
acosClicks7d | decimal | Advertising cost of sales based on purchases made within 7 days of an ad click |
adGroupId | long | Unique numerical ID of the ad group |
adGroupName | string | The name of the ad group as entered by the advertiser |
adId | long | Unique numerical ID of the ad |
advertisedAsin | string | The ASIN associated to an advertised product |
advertisedSku | string | The SKU being advertised. Not available for vendors |
attributedSalesSameSku14d | decimal | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku1d | decimal | Total value of sales occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku30d | decimal | Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku7d | decimal | Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
campaignBudgetAmount | decimal | Total budget allocated to the campaign |
campaignBudgetCurrencyCode | string | The currency code associated with the campaign |
campaignBudgetType | string | One of daily or lifetime |
campaignId | long | The ID associated with a campaign |
campaignName | string | The name associated with a campaign |
campaignStatus | string | The status of a campaign |
clicks | integer | Total number of ad clicks |
clickThroughRate | decimal | Clicks divided by impressions |
cost | decimal | Total cost of ad clicks. Same as spend |
costPerClick | decimal | Total cost divided by total number of clicks |
impressions | integer | Total number of ad impressions |
kindleEditionNormalizedPagesRead14d | integer | Number of attributed Kindle edition normalized pages read within 14 days of ad click' |
kindleEditionNormalizedPagesRoyalties14d | decimal | The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click |
portfolioId | long | The portfolio the campaign is associated with |
purchases14d | integer | Number of attributed conversion events occurring within 14 days of an ad click |
purchases1d | integer | Number of attributed conversion events occurring within 1 day of an ad click |
purchases30d | integer | Number of attributed conversion events occurring within 30 days of an ad click |
purchases7d | integer | Number of attributed conversion events occurring within 7 days of an ad click |
purchasesSameSku14d | integer | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku1d | integer | Number of attributed conversion events occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku30d | integer | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku7d | integer | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
roasClicks14d | decimal | Return on ad spend based on purchases made within 14 days of an ad click |
roasClicks7d | decimal | Return on ad spend based on purchases made within 7 days of an ad click |
sales14d | decimal | Total value of sales occurring within 14 days of an ad click |
sales1d | decimal | Total value of sales occurring within 1 day of an ad click |
sales30d | decimal | Total value of sales occurring within 30 days of an ad click |
sales7d | decimal | Total value of sales occurring within 7 days of an ad click |
salesOtherSku7d | decimal | Total value of sales occurring within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
spend | decimal | Total cost of ad clicks. Same as cost |
unitsSoldClicks14d | integer | Total number of units ordered within 14 days of an ad click. Same as unitsSold14d |
unitsSoldClicks1d | integer | Total number of units ordered within 1 day of an ad click |
unitsSoldClicks30d | integer | Total number of units ordered within 30 days of an ad click |
unitsSoldClicks7d | integer | Total number of units ordered within 7 days of an ad click |
unitsSoldOtherSku7d | integer | Total number of units ordered within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
unitsSoldSameSku14d | integer | Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku1d | integer | Total number of units ordered within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku30d | integer | Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku7d | integer | Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
pipes__Report_Brands_PurchasedProducts
Amazon Report Type Id: spPurchasedProduct
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/createAsyncReport
Sponsored Brands : Purchased Products Report v.3
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
date | date | Date when the ad activity ocurred in the format YYYY-MM-DD |
adGroupName | string | The name of the ad group as entered by the advertiser |
attributionType | string | Describes whether a purchase is attributed to a promoted product or brand-halo effect |
budgetCurrency | string | The currency code |
campaignBudgetCurrencyCode | string | The currency code associated with the campaign |
campaignName | string | The name associated with a campaign |
newToBrandOrders14d | integer | The number of orders |
newToBrandOrdersPercentage14d | decimal | The percentage of orders |
newToBrandPurchases14d | integer | The number of first-time orders for brand products over a one-year lookback window. Not available for book vendors |
newToBrandPurchasesPercentage14d | decimal | The percentage of total orders that are new-to-brand orders. Not available for book vendors |
newToBrandSales14d | decimal | Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors |
newToBrandSalesPercentage14d | decimal | Percentage of total sales made up of new-to-brand purchases. Not available for book vendors |
newToBrandUnitsSold14d | integer | 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 |
newToBrandUnitsSoldPercentage14d | decimal | 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'), orders14d integer OPTIONS (ANNOTATION 'Orders within the last 14 days |
productCategory | string | The category the product is associated with on Amazon |
productName | string | The name of the product |
purchasedAsin | string | The ASIN of the product that was purchased |
sales14d | decimal | Total value of sales occurring within 14 days of an ad click |
unitsSold14d | integer | Number of attributed units sold within 14 days of click on an ad. Vendor-only field. Same as unitsSoldClicks14d |
pipes__Report_Products_Campaigns
Amazon Report Type Id: spCampaigns
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/createAsyncReport
Sponsored Products : Campaigns Report v.3
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
date | date | Date when the ad activity ocurred in the format YYYY-MM-DD |
adGroupId | long | Unique numerical ID of the ad group |
adGroupName | string | The name of the ad group as entered by the advertiser |
adStatus | string | Status of the ad group |
attributedSalesSameSku14d | decimal | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku1d | decimal | Total value of sales occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku30d | decimal | Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku7d | decimal | Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
campaignApplicableBudgetRuleId | long | The ID associated to the active budget rule for a campaign |
campaignApplicableBudgetRuleName | string | The name associated to the active budget rule for a campaign |
campaignBiddingStrategy | string | The bidding strategy associated with a campaign |
campaignBudgetAmount | decimal | Total budget allocated to the campaign |
campaignBudgetCurrencyCode | string | The currency code associated with the campaign |
campaignBudgetType | string | One of daily or lifetime |
campaignId | long | The ID associated with a campaign |
campaignName | string | The name associated with a campaign |
campaignRuleBasedBudgetAmount | decimal | The value of the rule-based budget for a campaign |
campaignStatus | string | The status of a campaign |
clicks | integer | Total number of ad clicks |
clickThroughRate | decimal | Clicks divided by impressions |
cost | decimal | Total cost of ad clicks. Same as spend |
costPerClick | decimal | Total cost divided by total number of clicks |
impressions | integer | Total number of ad impressions |
kindleEditionNormalizedPagesRead14d | integer | Number of attributed Kindle edition normalized pages read within 14 days of ad click' |
kindleEditionNormalizedPagesRoyalties14d | decimal | The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click |
placementClassification | string | The page location where an ad appeared |
purchases14d | integer | Number of attributed conversion events occurring within 14 days of an ad click |
purchases1d | integer | Number of attributed conversion events occurring within 1 day of an ad click |
purchases30d | integer | Number of attributed conversion events occurring within 30 days of an ad click |
purchases7d | integer | Number of attributed conversion events occurring within 7 days of an ad click |
purchasesSameSku14d | integer | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku1d | integer | Number of attributed conversion events occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku30d | integer | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku7d | integer | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
sales14d | decimal | Total value of sales occurring within 14 days of an ad click |
sales1d | decimal | Total value of sales occurring within 1 day of an ad click |
sales30d | decimal | Total value of sales occurring within 30 days of an ad click |
sales7d | decimal | Total value of sales occurring within 7 days of an ad click |
spend | decimal | Total cost of ad clicks. Same as cost |
unitsSoldClicks14d | integer | Total number of units ordered within 14 days of an ad click. Same as unitsSold14d |
unitsSoldClicks1d | integer | Total number of units ordered within 1 day of an ad click |
unitsSoldClicks30d | integer | Total number of units ordered within 30 days of an ad click |
unitsSoldClicks7d | integer | Total number of units ordered within 7 days of an ad click |
unitsSoldOtherSku7d | integer | Total number of units ordered within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
unitsSoldSameSku14d | integer | Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku1d | integer | Total number of units ordered within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku30d | integer | Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku7d | integer | Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
pipes__Report_Products_PurchasedProducts
Amazon Report Type Id: sbPurchasedProduct
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/createAsyncReport
Sponsored Products : Purchased Products Report v.3
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | Profile ID |
date | date | Date when the ad activity ocurred in the format YYYY-MM-DD |
adGroupId | long | Unique numerical ID of the ad group |
adGroupName | string | The name of the ad group as entered by the advertiser |
advertisedAsin | string | The ASIN associated to an advertised product |
advertisedSku | string | The SKU being advertised. Not available for vendors |
campaignBudgetCurrencyCode | string | The currency code associated with the campaign |
campaignId | long | The ID associated with a campaign |
campaignName | string | The name associated with a campaign |
keyword | string | Text of the keyword or a representation of the targeting expression. For targets, the same value is returned in the targeting metric |
keywordId | long | ID associated with a keyword or targeting expression |
keywordType | string | Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For targeting expressions, one of TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. Same as matchType |
kindleEditionNormalizedPagesRead14d | integer | Number of attributed Kindle edition normalized pages read within 14 days of ad click' |
kindleEditionNormalizedPagesRoyalties14d | decimal | The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click |
matchType | string | Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For targeting expressions, one of TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. Same as keywordType |
portfolioId | long | The portfolio the campaign is associated with |
purchases14d | integer | Number of attributed conversion events occurring within 14 days of an ad click |
purchases1d | integer | Number of attributed conversion events occurring within 1 day of an ad click |
purchases30d | integer | Number of attributed conversion events occurring within 30 days of an ad click |
purchases7d | integer | Number of attributed conversion events occurring within 7 days of an ad click |
purchasesSameSku14d | integer | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku1d | integer | Number of attributed conversion events occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku30d | integer | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku7d | integer | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
sales14d | decimal | Total value of sales occurring within 14 days of an ad click |
sales1d | decimal | Total value of sales occurring within 1 day of an ad click |
sales30d | decimal | Total value of sales occurring within 30 days of an ad click |
sales7d | decimal | Total value of sales occurring within 7 days of an ad click |
salesOtherSku7d | decimal | Total value of sales occurring within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
salesOtherSku1d | decimal | Total value of sales occurring within 1 day of an ad click where the purchased SKU was different from the SKU advertised |
salesOtherSku30d | decimal | Total value of sales occurring within 30 days of an ad click where the purchased SKU was different from the SKU advertised |
salesOtherSku7d | decimal | Total value of sales occurring within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
unitsSoldClicks14d | integer | Total number of units ordered within 14 days of an ad click. Same as unitsSold14d |
unitsSoldClicks1d | integer | Total number of units ordered within 1 day of an ad click |
unitsSoldClicks30d | integer | Total number of units ordered within 30 days of an ad click |
unitsSoldClicks7d | integer | Total number of units ordered within 7 days of an ad click |
unitsSoldOtherSku7d | integer | Total number of units ordered within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
unitsSoldSameSku14d | integer | Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku1d | integer | Total number of units ordered within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku30d | integer | Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku7d | integer | Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
pipes__Report_Products_SearchTerms
Amazon Report Type Id: spSearchTerm
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/createAsyncReport
Sponsored Products : Search Term Report v.3
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | ID of the profile |
date | date | Date when the ad activity ocurred in the format YYYY-MM-DD |
acosClicks14d | decimal | Advertising cost of sales based on purchases made within 14 days of an ad click |
acosClicks7d | decimal | Advertising cost of sales based on purchases made within 7 days of an ad click |
adGroupId | long | Unique numerical ID of the ad group |
adGroupName | string | The name of the ad group as entered by the advertiser |
adKeywordStatus | string | Current status of a keyword |
attributedSalesSameSku14d | decimal | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku1d | decimal | Total value of sales occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku30d | decimal | Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku7d | decimal | Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
campaignBudgetAmount | decimal | Total budget allocated to the campaign |
campaignBudgetCurrencyCode | string | The currency code associated with the campaign |
campaignBudgetType | string | One of daily or lifetime |
campaignId | long | The ID associated with a campaign |
campaignName | string | The name associated with a campaign |
campaignStatus | string | The status of a campaign |
clicks | integer | Total number of ad clicks |
clickThroughRate | decimal | Clicks divided by impressions |
cost | decimal | Total cost of ad clicks. Same as spend |
costPerClick | decimal | Total cost divided by total number of clicks |
impressions | integer | Total number of ad impressions |
keyword | string | Text of the keyword or a representation of the targeting expression. For targets, the same value is returned in the targeting metric |
keywordBid | long | Bid associated with a keyword or targeting expression |
keywordId | long | ID associated with a keyword or targeting expression |
keywordType | string | Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For targeting expressions, one of TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. Same as matchType |
kindleEditionNormalizedPagesRead14d | integer | Number of attributed Kindle edition normalized pages read within 14 days of ad click' |
kindleEditionNormalizedPagesRoyalties14d | decimal | The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click |
matchType | string | Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For targeting expressions, one of TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. Same as keywordType |
portfolioId | long | The portfolio the campaign is associated with |
purchases14d | integer | Number of attributed conversion events occurring within 14 days of an ad click |
purchases1d | integer | Number of attributed conversion events occurring within 1 day of an ad click |
purchases30d | integer | Number of attributed conversion events occurring within 30 days of an ad click |
purchases7d | integer | Number of attributed conversion events occurring within 7 days of an ad click |
purchasesSameSku14d | integer | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku1d | integer | Number of attributed conversion events occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku30d | integer | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku7d | integer | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
roasClicks14d | decimal | Return on ad spend based on purchases made within 14 days of an ad click |
roasClicks7d | decimal | Return on ad spend based on purchases made within 7 days of an ad click |
sales14d | decimal | Total value of sales occurring within 14 days of an ad click |
sales1d | decimal | Total value of sales occurring within 1 day of an ad click |
sales30d | decimal | Total value of sales occurring within 30 days of an ad click |
sales7d | decimal | Total value of sales occurring within 7 days of an ad click |
salesOtherSku7d | decimal | Total value of sales occurring within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
searchTerm | string | The search term used by the customer |
targeting | string | A string representation of the expression object used in the targeting clause. The targeting expression is also returned in keyword |
unitsSoldClicks14d | integer | Total number of units ordered within 14 days of an ad click. Same as unitsSold14d |
unitsSoldClicks1d | integer | Total number of units ordered within 1 day of an ad click |
unitsSoldClicks30d | integer | Total number of units ordered within 30 days of an ad click |
unitsSoldClicks7d | integer | Total number of units ordered within 7 days of an ad click |
unitsSoldOtherSku7d | integer | Total number of units ordered within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
unitsSoldSameSku14d | integer | Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku1d | integer | Total number of units ordered within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku30d | integer | Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku7d | integer | Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
pipes__Report_Products_Targeting
Amazon Report Type Id: spTargeting
Amazon Endpoint Reference: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/createAsyncReport
Report Products Targeting
Parameter
<profileId> (optional): Profile Id
<startDate> (optional): Start date
<daysToRedownload> (optional): Re-download days|How many days to query into the past
<days_step> (optional): Number of days to query in a single batch
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute | Type | Description |
|---|---|---|
profileId | long | ID of the profile |
date | date | Date when the ad activity ocurred in the format YYYY-MM-DD |
acosClicks14d | decimal | Advertising cost of sales based on purchases made within 14 days of an ad click |
acosClicks7d | decimal | Advertising cost of sales based on purchases made within 7 days of an ad click |
adGroupId | long | Unique numerical ID of the ad group |
adGroupName | string | The name of the ad group as entered by the advertiser |
adKeywordStatus | string | Current status of a keyword |
attributedSalesSameSku14d | decimal | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku1d | decimal | Total value of sales occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku30d | decimal | Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
attributedSalesSameSku7d | decimal | Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
campaignBudgetAmount | decimal | Total budget allocated to the campaign |
campaignBudgetCurrencyCode | string | The currency code associated with the campaign |
campaignBudgetType | string | One of daily or lifetime |
campaignId | long | The ID associated with a campaign |
campaignName | string | The name associated with a campaign |
campaignStatus | string | The status of a campaign |
clicks | integer | Total number of ad clicks |
clickThroughRate | decimal | Clicks divided by impressions |
cost | decimal | Total cost of ad clicks. Same as spend |
costPerClick | decimal | Total cost divided by total number of clicks |
impressions | integer | Total number of ad impressions |
keyword | string | Text of the keyword or a representation of the targeting expression. For targets, the same value is returned in the targeting metric |
keywordBid | long | Bid associated with a keyword or targeting expression |
keywordId | long | ID associated with a keyword or targeting expression |
keywordType | string | Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For targeting expressions, one of TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. Same as matchType |
kindleEditionNormalizedPagesRead14d | integer | Number of attributed Kindle edition normalized pages read within 14 days of ad click' |
kindleEditionNormalizedPagesRoyalties14d | decimal | The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click |
matchType | string | Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For targeting expressions, one of TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. Same as keywordType |
portfolioId | long | The portfolio the campaign is associated with |
purchases14d | integer | Number of attributed conversion events occurring within 14 days of an ad click |
purchases1d | integer | Number of attributed conversion events occurring within 1 day of an ad click |
purchases30d | integer | Number of attributed conversion events occurring within 30 days of an ad click |
purchases7d | integer | Number of attributed conversion events occurring within 7 days of an ad click |
purchasesSameSku14d | integer | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku1d | integer | Number of attributed conversion events occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku30d | integer | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
purchasesSameSku7d | integer | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised |
roasClicks14d | decimal | Return on ad spend based on purchases made within 14 days of an ad click |
roasClicks7d | decimal | Return on ad spend based on purchases made within 7 days of an ad click |
sales14d | decimal | Total value of sales occurring within 14 days of an ad click |
sales1d | decimal | Total value of sales occurring within 1 day of an ad click |
sales30d | decimal | Total value of sales occurring within 30 days of an ad click |
sales7d | decimal | Total value of sales occurring within 7 days of an ad click |
salesOtherSku7d | decimal | Total value of sales occurring within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
targeting | string | A string representation of the expression object used in the targeting clause. The targeting expression is also returned in keyword |
unitsSoldClicks14d | integer | Total number of units ordered within 14 days of an ad click. Same as unitsSold14d |
unitsSoldClicks1d | integer | Total number of units ordered within 1 day of an ad click |
unitsSoldClicks30d | integer | Total number of units ordered within 30 days of an ad click |
unitsSoldClicks7d | integer | Total number of units ordered within 7 days of an ad click |
unitsSoldOtherSku7d | integer | Total number of units ordered within 7 days of an ad click where the purchased SKU was different from the SKU advertised |
unitsSoldSameSku14d | integer | Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku1d | integer | Total number of units ordered within 1 day of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku30d | integer | Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised |
unitsSoldSameSku7d | integer | Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised |