Module - amazon_advertising.reports

Report

Represents a AAAPI report that has been or will be created. Information identifying report content is encoded in the report’s file name. Because there are many permutations of the various parameters, only some of which are valid, the set of parameters provided for a report are validated prior to running the job.
type	object
properties
profile_id	Profile Id
	The AAAPI Profile ID associated with the report.
	type	integer
	examples	1907360808850690
profile_tz	Profile Tz
	Timezone associated with profile_id. This value is automatically set by the plugin and should amost never be set via job config.
	type	string
	examples	America/Chicago
		America/Los_Angeles
cls	Cls
	Class of the entity this represents.
	type	string
	examples	report
		snapshot
	minLength	1
sponsored	Sponsored
	The entity being sponsored.
	type	string
	examples	brands
		products
	minLength	1
record_type	Record Type
	AAAPI recordType – the type of report or snapshot this represents.
	type	string
	examples	adGroups
		campaigns
		keywords
		productAds
		targets
	minLength	1
url	FIXME: correct type
	Url
	examples
download_dir	Download Dir
	Directory containing downloaded reports and snapshots.
	type	string
	default	/var/mitto/data/reports/amazon_advertising
	format	path
date	Date
	Date of data contained in report. Important: this field’s value is set by the plugin, do not provide a value for it via the job config.
	type	string
	examples	2020-01-12
	format	date
run_date	Run Date
	Date on which report was run. Important: this field’s value is set by the plugin, do not provide a value for it via the job config.
	type	string
	examples	2020-01-12
	format	date
report_spec	Will contain all valid values for this report type. Important: this field’s value is set by the plugin, do not provide a value for it via the job config.
	Report Spec
report_id	Report Id
	Assigned by API after successful POST requesting report creation. Important: this field’s value is set by the plugin, do not provide a value for it via the job config.
	type	string
	examples	5E6A5CB3.39ce2551-4a7e-4753-ade1-b21c227cdc8d
	minLength	1
segment	Segment
	The segment/dimension, if any, to apply to this report.
	type	string
	examples	placement
		query
	minLength	1
metrics	Metrics
	The metrics to include in the report. By default, the plugin automatically requests all possible metrics. Only provide metrics here if, for some reason, only a subset of the metrics are to be requested.
	type	array
	examples	attributedSales14dOtherSKU
		attributedSales1dOtherSKU
		attributedSales30dOtherSKU
		attributedSales7dOtherSKU
		attributedUnitsOrdered14d
		attributedUnitsOrdered14dOtherSKU
		attributedUnitsOrdered1d
		attributedUnitsOrdered1dOtherSKU
	minLength	1
	items
		type	string
		minLength	1