Profiles and Portfolios

Profile and Portfolio data is obtained from the AAAPI using the AmazonAdvertisingInput inputter.

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
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
		minLength	1
		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
		minLength	1
	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
		minLength	1