Amazon-Ads full reference

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.

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/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "profiles",
    "action": "list"
}'

Parameters

Records

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/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "profiles",
    "action": "get",
    "params": {
        "profileId": 0
    }
}'

Parameters

Records

Profiles Search

Search and filter profiles records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await amazon_ads.profiles.search(
    query={"filter": {"eq": {"accountInfo": {}}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "profiles",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"accountInfo": {}}}}
    }
}'

Parameters

Searchable Fields

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/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "portfolios",
    "action": "list"
}'

Parameters

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/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "portfolios",
    "action": "get",
    "params": {
        "portfolioId": 0
    }
}'

Parameters

Records

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/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "sponsored_product_campaigns",
    "action": "list"
}'

Parameters

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/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "sponsored_product_campaigns",
    "action": "get",
    "params": {
        "campaignId": 0
    }
}'

Parameters

Records