Amazon-Ads full reference

This is the full reference documentation for the Amazon-Ads agent connector.

Supported entities and actions

The Amazon-Ads connector supports the following entities and actions.

Entity	Actions
Profiles	List, Get
Portfolios	List, Get
Sponsored Product Campaigns	List, Get

Profiles

Profiles List

Returns a list of advertising profiles associated with the authenticated user. Profiles represent an advertiser's account in a specific marketplace. Advertisers may have a single profile if they advertise in only one marketplace, or a separate profile for each marketplace if they advertise regionally or globally.

Python SDK

await amazon_ads.profiles.list()

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "profiles",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
profileTypeFilter	string	No	Filter profiles by type. Comma-separated list of profile types.
Valid values: seller, vendor, agency

Response Schema

Records

Field Name	Type	Description
profileId	integer
countryCode	string | null
currencyCode	string | null
dailyBudget	number | null
timezone	string | null
accountInfo	object | any

Profiles Get

Retrieves a single advertising profile by its ID. The profile contains information about the advertiser's account in a specific marketplace.

Python SDK

await amazon_ads.profiles.get(
    profile_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "profiles",
    "action": "get",
    "params": {
        "profileId": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
profileId	integer	Yes	The unique identifier of the profile

Response Schema

Records

Field Name	Type	Description
profileId	integer
countryCode	string | null
currencyCode	string | null
dailyBudget	number | null
timezone	string | null
accountInfo	object | any

Portfolios

Portfolios List

Returns a list of portfolios for the specified profile. Portfolios are used to group campaigns together for organizational and budget management purposes.

Python SDK

await amazon_ads.portfolios.list()

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "portfolios",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
includeExtendedDataFields	string	No	Whether to include extended data fields in the response

Portfolios Get

Retrieves a single portfolio by its ID using the v2 API.

Python SDK

await amazon_ads.portfolios.get(
    portfolio_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "portfolios",
    "action": "get",
    "params": {
        "portfolioId": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
portfolioId	integer	Yes	The unique identifier of the portfolio

Response Schema

Records

Field Name	Type	Description
portfolioId	string | integer
name	string | null
budget	object | any
inBudget	boolean | null
state	string | null
creationDate	integer | null
lastUpdatedDate	integer | null
servingStatus	string | null

Sponsored Product Campaigns

Sponsored Product Campaigns List

Returns a list of sponsored product campaigns for the specified profile. Sponsored Products campaigns promote individual product listings on Amazon.

Python SDK

await amazon_ads.sponsored_product_campaigns.list()

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "sponsored_product_campaigns",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
stateFilter	object	No
stateFilter.include	string	No	Comma-separated list of states to include (enabled, paused, archived)
maxResults	integer	No	Maximum number of results to return
nextToken	string	No	Token for pagination

Sponsored Product Campaigns Get

Retrieves a single sponsored product campaign by its ID using the v2 API.

Python SDK

await amazon_ads.sponsored_product_campaigns.get(
    campaign_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "sponsored_product_campaigns",
    "action": "get",
    "params": {
        "campaignId": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
campaignId	integer	Yes	The unique identifier of the campaign

Response Schema

Records

Field Name	Type	Description
campaignId	string | integer
portfolioId	string | integer | any
name	string | null
campaignType	string | null
tags	object | null
targetingType	string | null
premiumBidAdjustment	boolean | null
state	string | null
dynamicBidding	object | any
bidding	object | any
startDate	string | null
endDate	string | null
dailyBudget	number | null
budget	object | any
extendedData	object | null
marketplaceBudgetAllocation	string | null
offAmazonSettings	object | null