Module - amazon_advertising.io.input

AmazonAdvertisingInput

Basic inputer
type	object
properties
credentials	AmazonAdvertisingCredentials
endpoints	AmazonAdvertisingApiEndpoints
timestamp	Timestamp
	Starting date for which data is acquired. Providing a value for this in the job config disables normal ‘upsert’ behavior. Important: this date must be in the TZ of the profile in use.
	type	string
	examples	2020-12-28
	format	date
end_date	End_Date
	Stop collecting data after this date. Using this disables normal upsert behavior. Only valid if timestamp is supplied. Important: this date must be in the TZ of the profile in use.
	type	string
	examples	2020-12-31
	format	date
profile_id	Profile_Id
	Only used by /portfolios endpoint.
	type	string
	examples	460027049156373
definitions
AmazonAdvertisingCredentials	AmazonAdvertisingCredentials
	Credentials used to access the Amazon Advertising API
	type	object
	properties
	scope	Scope of access permissions
		type	string
		minLength	1
		default	cpc_advertising:campaign_management
	client_id	Client ID
		type	string
		examples	amzn1.application-oa2-client.8407ff6236bf028baa1d8a947c0898cf
		minLength	1
	client_secret	Client Secret
		type	string
		examples	bda137c73f33a83d3d4d57e70b8f96d77e5a8e70 …truncated…
		minLength	1
	refresh_token	Refresh Token
		type	string
		examples	Atzr|IwEBICqc0ic8xYl1f2SE …truncated…
		minLength	1
	access_token	Access_Token
		Access Token. Do not set this via the job config. It’s value is set during operation of the plugin.
		type	string
AmazonAdvertisingApiEndpoints	AmazonAdvertisingApiEndpoints
	GET/POST endpoints for a report, snapshot, or other entity. In the get and post examples below, {record_type} and {report_id} must be replaced with their actual values.
	type	object
	properties
	base_url	Base_Url
		Base URL for Amazon Advertising API.
		type	string
		default	https://advertising-api.amazon.com/v2
	post	Post
		Endpoint for POST requests.
		type	string
		examples	/sp/{record_type}/report
			/sp/adGroups/report
			/hsa/{record_type}/report
			/hsa/campaigns/report
	get	Get
		Endpoint for GET requests.
		type	string
		examples	/sp/reports/{report_id}
			/sp/reports/5E728286.27a56924-ee1d-42a5-86ec-9af491dbd1a1
			/hsa/reports/{report_id}
			/hsa/reports/5E73800F.8f3be3ef-8070-49f2-9103-4ab1abf1da60

AmazonAdvertisingReportCreateAndLoad

Create and download a report
type	object
properties
credentials	AmazonAdvertisingCredentials
endpoints	AmazonAdvertisingApiEndpoints
timestamp	Timestamp
	Starting date for which data is acquired. Providing a value for this in the job config disables normal ‘upsert’ behavior. Important: this date must be in the TZ of the profile in use.
	type	string
	examples	2020-12-28
	format	date
end_date	End_Date
	Stop collecting data after this date. Using this disables normal upsert behavior. Only valid if timestamp is supplied. Important: this date must be in the TZ of the profile in use.
	type	string
	examples	2020-12-31
	format	date
report	Report
source	Source
	Do not provide a value for this via the job config. The plugin sets the value during operation, after the report has been created and downloaded.
	type	string
definitions
AmazonAdvertisingCredentials	AmazonAdvertisingCredentials
	Credentials used to access the Amazon Advertising API
	type	object
	properties
	scope	Scope of access permissions
		type	string
		minLength	1
		default	cpc_advertising:campaign_management
	client_id	Client ID
		type	string
		examples	amzn1.application-oa2-client.8407ff6236bf028baa1d8a947c0898cf
		minLength	1
	client_secret	Client Secret
		type	string
		examples	bda137c73f33a83d3d4d57e70b8f96d77e5a8e70 …truncated…
		minLength	1
	refresh_token	Refresh Token
		type	string
		examples	Atzr|IwEBICqc0ic8xYl1f2SE …truncated…
		minLength	1
	access_token	Access_Token
		Access Token. Do not set this via the job config. It’s value is set during operation of the plugin.
		type	string
AmazonAdvertisingApiEndpoints	AmazonAdvertisingApiEndpoints
	GET/POST endpoints for a report, snapshot, or other entity. In the get and post examples below, {record_type} and {report_id} must be replaced with their actual values.
	type	object
	properties
	base_url	Base_Url
		Base URL for Amazon Advertising API.
		type	string
		default	https://advertising-api.amazon.com/v2
	post	Post
		Endpoint for POST requests.
		type	string
		examples	/sp/{record_type}/report
			/sp/adGroups/report
			/hsa/{record_type}/report
			/hsa/campaigns/report
	get	Get
		Endpoint for GET requests.
		type	string
		examples	/sp/reports/{report_id}
			/sp/reports/5E728286.27a56924-ee1d-42a5-86ec-9af491dbd1a1
			/hsa/reports/{report_id}
			/hsa/reports/5E73800F.8f3be3ef-8070-49f2-9103-4ab1abf1da60
Report	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
	segment	Segment
		The segment/dimension, if any, to apply to this report.
		type	string
		examples	placement
			query
	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
items
	type	string

AmazonAdvertisingReportLoad

Load data from an existing report and make it available to the job.
type	object
properties
directory	Directory
	Directory containing existing reports. This directory is searched using either glob or regex. File(s) matching the provided pattern will be loaded and their data will be provided to the job.
	type	string
	default	/var/mitto/data/reports/amazon_advertising
	format	path
glob	Glob
	glob specifying report name(s) to process. See man 7 glob for more information on file globbing in general. This is ultimately passed to Python’s pathblib.Path.glob.
	type	string
regex	Regex
	regex specifying report name(s) to process.
	type	string
source	Source
	For internal connector use only. The fully-qualified path to the report file currently being processed is placed here. This is to make it compatible with JsonInput, which is used by other AAAPI jobs. This allows both types of jobs to use the AppendReportDataTransform.
	type	string

AmazonAdvertisingSnapshotCreateAndLoad

Create and download a snapshot
type	object
properties
credentials	AmazonAdvertisingCredentials
endpoints	AmazonAdvertisingApiEndpoints
timestamp	Timestamp
	Starting date for which data is acquired. Providing a value for this in the job config disables normal ‘upsert’ behavior. Important: this date must be in the TZ of the profile in use.
	type	string
	examples	2020-12-28
	format	date
end_date	End_Date
	Stop collecting data after this date. Using this disables normal upsert behavior. Only valid if timestamp is supplied. Important: this date must be in the TZ of the profile in use.
	type	string
	examples	2020-12-31
	format	date
snapshot	Snapshot
source	Source
	A value for this should not be provided via the job config; its value is only determined after the snapshot has been created and downloaded.
	type	string
definitions
AmazonAdvertisingCredentials	AmazonAdvertisingCredentials
	Credentials used to access the Amazon Advertising API
	type	object
	properties
	scope	Scope of access permissions
		type	string
		minLength	1
		default	cpc_advertising:campaign_management
	client_id	Client ID
		type	string
		examples	amzn1.application-oa2-client.8407ff6236bf028baa1d8a947c0898cf
		minLength	1
	client_secret	Client Secret
		type	string
		examples	bda137c73f33a83d3d4d57e70b8f96d77e5a8e70 …truncated…
		minLength	1
	refresh_token	Refresh Token
		type	string
		examples	Atzr|IwEBICqc0ic8xYl1f2SE …truncated…
		minLength	1
	access_token	Access_Token
		Access Token. Do not set this via the job config. It’s value is set during operation of the plugin.
		type	string
AmazonAdvertisingApiEndpoints	AmazonAdvertisingApiEndpoints
	GET/POST endpoints for a report, snapshot, or other entity. In the get and post examples below, {record_type} and {report_id} must be replaced with their actual values.
	type	object
	properties
	base_url	Base_Url
		Base URL for Amazon Advertising API.
		type	string
		default	https://advertising-api.amazon.com/v2
	post	Post
		Endpoint for POST requests.
		type	string
		examples	/sp/{record_type}/report
			/sp/adGroups/report
			/hsa/{record_type}/report
			/hsa/campaigns/report
	get	Get
		Endpoint for GET requests.
		type	string
		examples	/sp/reports/{report_id}
			/sp/reports/5E728286.27a56924-ee1d-42a5-86ec-9af491dbd1a1
			/hsa/reports/{report_id}
			/hsa/reports/5E73800F.8f3be3ef-8070-49f2-9103-4ab1abf1da60
Snapshot	Snapshot
	Represents a AAAPI snapshot that has been or will be created. Key feature is encoding/decoding identifyng information in a snapshot’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
	state_filter	State_Filter
		Specifies the state(s) of the entities to include in the snapshot. Entity state selector. List containing one or more of: ‘enabled’, ‘paused’, ‘archived’.
		type	array
		default	[‘enabled’, ‘paused’]
		items
			type	string
segment	Segment
	type	string
	examples	[‘enabled’]
		[‘archived’, ‘paused’]
		[‘enabled’, ‘paused’, ‘archived’]