airbyte-agent-amazon-ads 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- airbyte_agent_amazon_ads-0.1.0/.gitignore +29 -0
- airbyte_agent_amazon_ads-0.1.0/CHANGELOG.md +6 -0
- airbyte_agent_amazon_ads-0.1.0/PKG-INFO +103 -0
- airbyte_agent_amazon_ads-0.1.0/README.md +70 -0
- airbyte_agent_amazon_ads-0.1.0/REFERENCE.md +373 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/__init__.py +57 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/__init__.py +1 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/__init__.py +82 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/auth_strategies.py +1173 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/auth_template.py +135 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/cloud_utils/__init__.py +5 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/cloud_utils/client.py +213 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/connector_model_loader.py +986 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/constants.py +78 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/exceptions.py +23 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/executor/__init__.py +31 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/executor/hosted_executor.py +196 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/executor/local_executor.py +1773 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/executor/models.py +190 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/extensions.py +693 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/__init__.py +37 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/adapters/__init__.py +9 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/adapters/httpx_adapter.py +251 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/config.py +98 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/exceptions.py +119 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/protocols.py +114 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http/response.py +104 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/http_client.py +693 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/introspection.py +262 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/logging/__init__.py +11 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/logging/logger.py +273 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/logging/types.py +93 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/observability/__init__.py +11 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/observability/config.py +179 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/observability/models.py +19 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/observability/redactor.py +81 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/observability/session.py +103 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/performance/__init__.py +6 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/performance/instrumentation.py +57 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/performance/metrics.py +93 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/__init__.py +75 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/base.py +169 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/components.py +239 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/connector.py +120 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/extensions.py +230 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/operations.py +146 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/schema/security.py +237 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/secrets.py +182 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/telemetry/__init__.py +10 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/telemetry/config.py +32 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/telemetry/events.py +59 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/telemetry/tracker.py +155 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/types.py +254 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/utils.py +60 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/_vendored/connector_sdk/validation.py +828 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/connector.py +578 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/connector_model.py +1074 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/models.py +170 -0
- airbyte_agent_amazon_ads-0.1.0/airbyte_agent_amazon_ads/types.py +48 -0
- airbyte_agent_amazon_ads-0.1.0/pyproject.toml +50 -0
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.egg-info/
|
|
6
|
+
dist/
|
|
7
|
+
build/
|
|
8
|
+
.eggs/
|
|
9
|
+
|
|
10
|
+
# Testing
|
|
11
|
+
.pytest_cache/
|
|
12
|
+
.coverage
|
|
13
|
+
htmlcov/
|
|
14
|
+
|
|
15
|
+
# Virtual environments
|
|
16
|
+
.venv/
|
|
17
|
+
venv/
|
|
18
|
+
|
|
19
|
+
# IDE
|
|
20
|
+
.idea/
|
|
21
|
+
.vscode/
|
|
22
|
+
*.swp
|
|
23
|
+
|
|
24
|
+
# OS
|
|
25
|
+
.DS_Store
|
|
26
|
+
Thumbs.db
|
|
27
|
+
|
|
28
|
+
.env
|
|
29
|
+
configured_connectors.yaml
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: airbyte-agent-amazon-ads
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Airbyte Amazon-Ads Connector for AI platforms
|
|
5
|
+
Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
|
|
6
|
+
Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
|
|
7
|
+
Project-URL: Repository, https://github.com/airbytehq/airbyte-agent-connectors
|
|
8
|
+
Project-URL: Issues, https://github.com/airbytehq/airbyte-agent-connectors/issues
|
|
9
|
+
Author-email: Airbyte <contact@airbyte.io>
|
|
10
|
+
License: Elastic-2.0
|
|
11
|
+
Keywords: agent,ai,airbyte,amazon-ads,api,connector,data-integration,llm,mcp
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: Other/Proprietary License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
19
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
20
|
+
Classifier: Typing :: Typed
|
|
21
|
+
Requires-Python: >=3.13
|
|
22
|
+
Requires-Dist: httpx>=0.24.0
|
|
23
|
+
Requires-Dist: jinja2>=3.0.0
|
|
24
|
+
Requires-Dist: jsonpath-ng>=1.6.1
|
|
25
|
+
Requires-Dist: jsonref>=1.1.0
|
|
26
|
+
Requires-Dist: opentelemetry-api>=1.37.0
|
|
27
|
+
Requires-Dist: opentelemetry-sdk>=1.37.0
|
|
28
|
+
Requires-Dist: pydantic>=2.0.0
|
|
29
|
+
Requires-Dist: python-dotenv>=1.0.0
|
|
30
|
+
Requires-Dist: pyyaml>=6.0
|
|
31
|
+
Requires-Dist: segment-analytics-python>=2.2.0
|
|
32
|
+
Description-Content-Type: text/markdown
|
|
33
|
+
|
|
34
|
+
# Amazon-Ads agent connector
|
|
35
|
+
|
|
36
|
+
Amazon Ads is Amazon's advertising platform that enables sellers and vendors to promote their
|
|
37
|
+
products across Amazon's marketplace. This connector provides access to advertising profiles
|
|
38
|
+
for managing and analyzing advertising campaigns across different marketplaces.
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## Example questions
|
|
42
|
+
|
|
43
|
+
The Amazon-Ads connector is optimized to handle prompts like these.
|
|
44
|
+
|
|
45
|
+
- List all my advertising profiles across marketplaces
|
|
46
|
+
- Show me the profiles for my seller accounts
|
|
47
|
+
- What marketplaces do I have advertising profiles in?
|
|
48
|
+
- List all portfolios for a specific profile
|
|
49
|
+
- Show me all sponsored product campaigns
|
|
50
|
+
- What campaigns are currently enabled?
|
|
51
|
+
- Find campaigns with a specific targeting type
|
|
52
|
+
|
|
53
|
+
## Unsupported questions
|
|
54
|
+
|
|
55
|
+
The Amazon-Ads connector isn't currently able to handle prompts like these.
|
|
56
|
+
|
|
57
|
+
- Create a new advertising campaign
|
|
58
|
+
- Update my campaign budget
|
|
59
|
+
- Delete an ad group
|
|
60
|
+
- Generate a performance report
|
|
61
|
+
|
|
62
|
+
## Installation
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
uv pip install airbyte-agent-amazon-ads
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Usage
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
from airbyte_agent_amazon_ads import AmazonAdsConnector, AmazonAdsAuthConfig
|
|
72
|
+
|
|
73
|
+
connector = AmazonAdsConnector(
|
|
74
|
+
auth_config=AmazonAdsAuthConfig(
|
|
75
|
+
client_id="...",
|
|
76
|
+
client_secret="...",
|
|
77
|
+
refresh_token="..."
|
|
78
|
+
)
|
|
79
|
+
)
|
|
80
|
+
result = await connector.profiles.list()
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## Full documentation
|
|
85
|
+
|
|
86
|
+
This connector supports the following entities and actions.
|
|
87
|
+
|
|
88
|
+
| Entity | Actions |
|
|
89
|
+
|--------|---------|
|
|
90
|
+
| Profiles | [List](./REFERENCE.md#profiles-list), [Get](./REFERENCE.md#profiles-get) |
|
|
91
|
+
| Portfolios | [List](./REFERENCE.md#portfolios-list), [Get](./REFERENCE.md#portfolios-get) |
|
|
92
|
+
| Sponsored Product Campaigns | [List](./REFERENCE.md#sponsored-product-campaigns-list), [Get](./REFERENCE.md#sponsored-product-campaigns-get) |
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
|
|
96
|
+
|
|
97
|
+
For the service's official API docs, see the [Amazon-Ads API reference](https://advertising.amazon.com/API/docs/en-us).
|
|
98
|
+
|
|
99
|
+
## Version information
|
|
100
|
+
|
|
101
|
+
- **Package version:** 0.1.0
|
|
102
|
+
- **Connector version:** 1.0.1
|
|
103
|
+
- **Generated with Connector SDK commit SHA:** 5fbc94c3c665f3c1f39576555fc0e9537bc3f2fa
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Amazon-Ads agent connector
|
|
2
|
+
|
|
3
|
+
Amazon Ads is Amazon's advertising platform that enables sellers and vendors to promote their
|
|
4
|
+
products across Amazon's marketplace. This connector provides access to advertising profiles
|
|
5
|
+
for managing and analyzing advertising campaigns across different marketplaces.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Example questions
|
|
9
|
+
|
|
10
|
+
The Amazon-Ads connector is optimized to handle prompts like these.
|
|
11
|
+
|
|
12
|
+
- List all my advertising profiles across marketplaces
|
|
13
|
+
- Show me the profiles for my seller accounts
|
|
14
|
+
- What marketplaces do I have advertising profiles in?
|
|
15
|
+
- List all portfolios for a specific profile
|
|
16
|
+
- Show me all sponsored product campaigns
|
|
17
|
+
- What campaigns are currently enabled?
|
|
18
|
+
- Find campaigns with a specific targeting type
|
|
19
|
+
|
|
20
|
+
## Unsupported questions
|
|
21
|
+
|
|
22
|
+
The Amazon-Ads connector isn't currently able to handle prompts like these.
|
|
23
|
+
|
|
24
|
+
- Create a new advertising campaign
|
|
25
|
+
- Update my campaign budget
|
|
26
|
+
- Delete an ad group
|
|
27
|
+
- Generate a performance report
|
|
28
|
+
|
|
29
|
+
## Installation
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
uv pip install airbyte-agent-amazon-ads
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Usage
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
from airbyte_agent_amazon_ads import AmazonAdsConnector, AmazonAdsAuthConfig
|
|
39
|
+
|
|
40
|
+
connector = AmazonAdsConnector(
|
|
41
|
+
auth_config=AmazonAdsAuthConfig(
|
|
42
|
+
client_id="...",
|
|
43
|
+
client_secret="...",
|
|
44
|
+
refresh_token="..."
|
|
45
|
+
)
|
|
46
|
+
)
|
|
47
|
+
result = await connector.profiles.list()
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
## Full documentation
|
|
52
|
+
|
|
53
|
+
This connector supports the following entities and actions.
|
|
54
|
+
|
|
55
|
+
| Entity | Actions |
|
|
56
|
+
|--------|---------|
|
|
57
|
+
| Profiles | [List](./REFERENCE.md#profiles-list), [Get](./REFERENCE.md#profiles-get) |
|
|
58
|
+
| Portfolios | [List](./REFERENCE.md#portfolios-list), [Get](./REFERENCE.md#portfolios-get) |
|
|
59
|
+
| Sponsored Product Campaigns | [List](./REFERENCE.md#sponsored-product-campaigns-list), [Get](./REFERENCE.md#sponsored-product-campaigns-get) |
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
|
|
63
|
+
|
|
64
|
+
For the service's official API docs, see the [Amazon-Ads API reference](https://advertising.amazon.com/API/docs/en-us).
|
|
65
|
+
|
|
66
|
+
## Version information
|
|
67
|
+
|
|
68
|
+
- **Package version:** 0.1.0
|
|
69
|
+
- **Connector version:** 1.0.1
|
|
70
|
+
- **Generated with Connector SDK commit SHA:** 5fbc94c3c665f3c1f39576555fc0e9537bc3f2fa
|
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
# Amazon-Ads full reference
|
|
2
|
+
|
|
3
|
+
This is the full reference documentation for the Amazon-Ads agent connector.
|
|
4
|
+
|
|
5
|
+
## Supported entities and actions
|
|
6
|
+
|
|
7
|
+
The Amazon-Ads connector supports the following entities and actions.
|
|
8
|
+
|
|
9
|
+
| Entity | Actions |
|
|
10
|
+
|--------|---------|
|
|
11
|
+
| Profiles | [List](#profiles-list), [Get](#profiles-get) |
|
|
12
|
+
| Portfolios | [List](#portfolios-list), [Get](#portfolios-get) |
|
|
13
|
+
| Sponsored Product Campaigns | [List](#sponsored-product-campaigns-list), [Get](#sponsored-product-campaigns-get) |
|
|
14
|
+
|
|
15
|
+
### Profiles
|
|
16
|
+
|
|
17
|
+
#### Profiles List
|
|
18
|
+
|
|
19
|
+
Returns a list of advertising profiles associated with the authenticated user.
|
|
20
|
+
Profiles represent an advertiser's account in a specific marketplace. Advertisers
|
|
21
|
+
may have a single profile if they advertise in only one marketplace, or a separate
|
|
22
|
+
profile for each marketplace if they advertise regionally or globally.
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
**Python SDK**
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
await amazon_ads.profiles.list()
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**API**
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
|
|
35
|
+
--header 'Content-Type: application/json' \
|
|
36
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
37
|
+
--data '{
|
|
38
|
+
"entity": "profiles",
|
|
39
|
+
"action": "list"
|
|
40
|
+
}'
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
**Parameters**
|
|
45
|
+
|
|
46
|
+
| Parameter Name | Type | Required | Description |
|
|
47
|
+
|----------------|------|----------|-------------|
|
|
48
|
+
| `profileTypeFilter` | `string` | No | Filter profiles by type. Comma-separated list of profile types.
|
|
49
|
+
Valid values: seller, vendor, agency
|
|
50
|
+
|
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<details>
|
|
54
|
+
<summary><b>Response Schema</b></summary>
|
|
55
|
+
|
|
56
|
+
**Records**
|
|
57
|
+
|
|
58
|
+
| Field Name | Type | Description |
|
|
59
|
+
|------------|------|-------------|
|
|
60
|
+
| `profileId` | `integer` | |
|
|
61
|
+
| `countryCode` | `string \| null` | |
|
|
62
|
+
| `currencyCode` | `string \| null` | |
|
|
63
|
+
| `dailyBudget` | `number \| null` | |
|
|
64
|
+
| `timezone` | `string \| null` | |
|
|
65
|
+
| `accountInfo` | `object \| any` | |
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</details>
|
|
69
|
+
|
|
70
|
+
#### Profiles Get
|
|
71
|
+
|
|
72
|
+
Retrieves a single advertising profile by its ID. The profile contains
|
|
73
|
+
information about the advertiser's account in a specific marketplace.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
**Python SDK**
|
|
77
|
+
|
|
78
|
+
```python
|
|
79
|
+
await amazon_ads.profiles.get(
|
|
80
|
+
profile_id=0
|
|
81
|
+
)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**API**
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
|
|
88
|
+
--header 'Content-Type: application/json' \
|
|
89
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
90
|
+
--data '{
|
|
91
|
+
"entity": "profiles",
|
|
92
|
+
"action": "get",
|
|
93
|
+
"params": {
|
|
94
|
+
"profileId": 0
|
|
95
|
+
}
|
|
96
|
+
}'
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
**Parameters**
|
|
101
|
+
|
|
102
|
+
| Parameter Name | Type | Required | Description |
|
|
103
|
+
|----------------|------|----------|-------------|
|
|
104
|
+
| `profileId` | `integer` | Yes | The unique identifier of the profile |
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<details>
|
|
108
|
+
<summary><b>Response Schema</b></summary>
|
|
109
|
+
|
|
110
|
+
**Records**
|
|
111
|
+
|
|
112
|
+
| Field Name | Type | Description |
|
|
113
|
+
|------------|------|-------------|
|
|
114
|
+
| `profileId` | `integer` | |
|
|
115
|
+
| `countryCode` | `string \| null` | |
|
|
116
|
+
| `currencyCode` | `string \| null` | |
|
|
117
|
+
| `dailyBudget` | `number \| null` | |
|
|
118
|
+
| `timezone` | `string \| null` | |
|
|
119
|
+
| `accountInfo` | `object \| any` | |
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
</details>
|
|
123
|
+
|
|
124
|
+
### Portfolios
|
|
125
|
+
|
|
126
|
+
#### Portfolios List
|
|
127
|
+
|
|
128
|
+
Returns a list of portfolios for the specified profile. Portfolios are used to
|
|
129
|
+
group campaigns together for organizational and budget management purposes.
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
**Python SDK**
|
|
133
|
+
|
|
134
|
+
```python
|
|
135
|
+
await amazon_ads.portfolios.list()
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
**API**
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
|
|
142
|
+
--header 'Content-Type: application/json' \
|
|
143
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
144
|
+
--data '{
|
|
145
|
+
"entity": "portfolios",
|
|
146
|
+
"action": "list"
|
|
147
|
+
}'
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
**Parameters**
|
|
152
|
+
|
|
153
|
+
| Parameter Name | Type | Required | Description |
|
|
154
|
+
|----------------|------|----------|-------------|
|
|
155
|
+
| `includeExtendedDataFields` | `string` | No | Whether to include extended data fields in the response |
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
#### Portfolios Get
|
|
159
|
+
|
|
160
|
+
Retrieves a single portfolio by its ID using the v2 API.
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
**Python SDK**
|
|
164
|
+
|
|
165
|
+
```python
|
|
166
|
+
await amazon_ads.portfolios.get(
|
|
167
|
+
portfolio_id=0
|
|
168
|
+
)
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
**API**
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
|
|
175
|
+
--header 'Content-Type: application/json' \
|
|
176
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
177
|
+
--data '{
|
|
178
|
+
"entity": "portfolios",
|
|
179
|
+
"action": "get",
|
|
180
|
+
"params": {
|
|
181
|
+
"portfolioId": 0
|
|
182
|
+
}
|
|
183
|
+
}'
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
**Parameters**
|
|
188
|
+
|
|
189
|
+
| Parameter Name | Type | Required | Description |
|
|
190
|
+
|----------------|------|----------|-------------|
|
|
191
|
+
| `portfolioId` | `integer` | Yes | The unique identifier of the portfolio |
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<details>
|
|
195
|
+
<summary><b>Response Schema</b></summary>
|
|
196
|
+
|
|
197
|
+
**Records**
|
|
198
|
+
|
|
199
|
+
| Field Name | Type | Description |
|
|
200
|
+
|------------|------|-------------|
|
|
201
|
+
| `portfolioId` | `string \| integer` | |
|
|
202
|
+
| `name` | `string \| null` | |
|
|
203
|
+
| `budget` | `object \| any` | |
|
|
204
|
+
| `inBudget` | `boolean \| null` | |
|
|
205
|
+
| `state` | `string \| null` | |
|
|
206
|
+
| `creationDate` | `integer \| null` | |
|
|
207
|
+
| `lastUpdatedDate` | `integer \| null` | |
|
|
208
|
+
| `servingStatus` | `string \| null` | |
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
</details>
|
|
212
|
+
|
|
213
|
+
### Sponsored Product Campaigns
|
|
214
|
+
|
|
215
|
+
#### Sponsored Product Campaigns List
|
|
216
|
+
|
|
217
|
+
Returns a list of sponsored product campaigns for the specified profile.
|
|
218
|
+
Sponsored Products campaigns promote individual product listings on Amazon.
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
**Python SDK**
|
|
222
|
+
|
|
223
|
+
```python
|
|
224
|
+
await amazon_ads.sponsored_product_campaigns.list()
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
**API**
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
|
|
231
|
+
--header 'Content-Type: application/json' \
|
|
232
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
233
|
+
--data '{
|
|
234
|
+
"entity": "sponsored_product_campaigns",
|
|
235
|
+
"action": "list"
|
|
236
|
+
}'
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
**Parameters**
|
|
241
|
+
|
|
242
|
+
| Parameter Name | Type | Required | Description |
|
|
243
|
+
|----------------|------|----------|-------------|
|
|
244
|
+
| `stateFilter` | `object` | No | |
|
|
245
|
+
| `stateFilter.include` | `string` | No | Comma-separated list of states to include (enabled, paused, archived) |
|
|
246
|
+
| `maxResults` | `integer` | No | Maximum number of results to return |
|
|
247
|
+
| `nextToken` | `string` | No | Token for pagination |
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
#### Sponsored Product Campaigns Get
|
|
251
|
+
|
|
252
|
+
Retrieves a single sponsored product campaign by its ID using the v2 API.
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
**Python SDK**
|
|
256
|
+
|
|
257
|
+
```python
|
|
258
|
+
await amazon_ads.sponsored_product_campaigns.get(
|
|
259
|
+
campaign_id=0
|
|
260
|
+
)
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
**API**
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
|
|
267
|
+
--header 'Content-Type: application/json' \
|
|
268
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
269
|
+
--data '{
|
|
270
|
+
"entity": "sponsored_product_campaigns",
|
|
271
|
+
"action": "get",
|
|
272
|
+
"params": {
|
|
273
|
+
"campaignId": 0
|
|
274
|
+
}
|
|
275
|
+
}'
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
**Parameters**
|
|
280
|
+
|
|
281
|
+
| Parameter Name | Type | Required | Description |
|
|
282
|
+
|----------------|------|----------|-------------|
|
|
283
|
+
| `campaignId` | `integer` | Yes | The unique identifier of the campaign |
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<details>
|
|
287
|
+
<summary><b>Response Schema</b></summary>
|
|
288
|
+
|
|
289
|
+
**Records**
|
|
290
|
+
|
|
291
|
+
| Field Name | Type | Description |
|
|
292
|
+
|------------|------|-------------|
|
|
293
|
+
| `campaignId` | `string \| integer` | |
|
|
294
|
+
| `portfolioId` | `string \| integer \| any` | |
|
|
295
|
+
| `name` | `string \| null` | |
|
|
296
|
+
| `campaignType` | `string \| null` | |
|
|
297
|
+
| `tags` | `object \| null` | |
|
|
298
|
+
| `targetingType` | `string \| null` | |
|
|
299
|
+
| `premiumBidAdjustment` | `boolean \| null` | |
|
|
300
|
+
| `state` | `string \| null` | |
|
|
301
|
+
| `dynamicBidding` | `object \| any` | |
|
|
302
|
+
| `bidding` | `object \| any` | |
|
|
303
|
+
| `startDate` | `string \| null` | |
|
|
304
|
+
| `endDate` | `string \| null` | |
|
|
305
|
+
| `dailyBudget` | `number \| null` | |
|
|
306
|
+
| `budget` | `object \| any` | |
|
|
307
|
+
| `extendedData` | `object \| null` | |
|
|
308
|
+
| `marketplaceBudgetAllocation` | `string \| null` | |
|
|
309
|
+
| `offAmazonSettings` | `object \| null` | |
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</details>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
## Configuration
|
|
317
|
+
|
|
318
|
+
The Amazon-Ads connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
|
|
319
|
+
|
|
320
|
+
| Variable | Type | Required | Default | Description |
|
|
321
|
+
|----------|------|----------|---------|-------------|
|
|
322
|
+
| `region_url` | `string` | Yes | https://advertising-api.amazon.com | The Amazon Ads API endpoint URL based on region:
|
|
323
|
+
- NA (North America): https://advertising-api.amazon.com
|
|
324
|
+
- EU (Europe): https://advertising-api-eu.amazon.com
|
|
325
|
+
- FE (Far East): https://advertising-api-fe.amazon.com
|
|
326
|
+
|
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
## Authentication
|
|
330
|
+
|
|
331
|
+
The Amazon-Ads connector supports the following authentication methods.
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
### OAuth2 Authentication
|
|
335
|
+
|
|
336
|
+
| Field Name | Type | Required | Description |
|
|
337
|
+
|------------|------|----------|-------------|
|
|
338
|
+
| `client_id` | `str` | Yes | The client ID of your Amazon Ads API application |
|
|
339
|
+
| `client_secret` | `str` | Yes | The client secret of your Amazon Ads API application |
|
|
340
|
+
| `refresh_token` | `str` | Yes | The refresh token obtained from the OAuth authorization flow |
|
|
341
|
+
|
|
342
|
+
#### Example
|
|
343
|
+
|
|
344
|
+
**Python SDK**
|
|
345
|
+
|
|
346
|
+
```python
|
|
347
|
+
AmazonAdsConnector(
|
|
348
|
+
auth_config=AmazonAdsAuthConfig(
|
|
349
|
+
client_id="<The client ID of your Amazon Ads API application>",
|
|
350
|
+
client_secret="<The client secret of your Amazon Ads API application>",
|
|
351
|
+
refresh_token="<The refresh token obtained from the OAuth authorization flow>"
|
|
352
|
+
)
|
|
353
|
+
)
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
**API**
|
|
357
|
+
|
|
358
|
+
```bash
|
|
359
|
+
curl --location 'https://api.airbyte.ai/api/v1/integrations/sources' \
|
|
360
|
+
--header 'Content-Type: application/json' \
|
|
361
|
+
--header 'Authorization: Bearer {your_auth_token}' \
|
|
362
|
+
--data '{
|
|
363
|
+
"workspace_id": "{your_workspace_id}",
|
|
364
|
+
"source_template_id": "{source_template_id}",
|
|
365
|
+
"auth_config": {
|
|
366
|
+
"client_id": "<The client ID of your Amazon Ads API application>",
|
|
367
|
+
"client_secret": "<The client secret of your Amazon Ads API application>",
|
|
368
|
+
"refresh_token": "<The refresh token obtained from the OAuth authorization flow>"
|
|
369
|
+
},
|
|
370
|
+
"name": "My Amazon-Ads Connector"
|
|
371
|
+
}'
|
|
372
|
+
```
|
|
373
|
+
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Blessed Amazon-Ads connector for Airbyte SDK.
|
|
3
|
+
|
|
4
|
+
Auto-generated from OpenAPI specification.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from .connector import AmazonAdsConnector
|
|
8
|
+
from .models import (
|
|
9
|
+
AmazonAdsAuthConfig,
|
|
10
|
+
Profile,
|
|
11
|
+
AccountInfo,
|
|
12
|
+
Portfolio,
|
|
13
|
+
PortfolioBudget,
|
|
14
|
+
SponsoredProductCampaign,
|
|
15
|
+
DynamicBiddingPlacementbiddingItem,
|
|
16
|
+
DynamicBidding,
|
|
17
|
+
CampaignBudget,
|
|
18
|
+
AmazonAdsExecuteResult,
|
|
19
|
+
AmazonAdsExecuteResultWithMeta,
|
|
20
|
+
ProfilesListResult,
|
|
21
|
+
PortfoliosListResult,
|
|
22
|
+
SponsoredProductCampaignsListResult
|
|
23
|
+
)
|
|
24
|
+
from .types import (
|
|
25
|
+
SponsoredProductCampaignsListParamsStatefilter,
|
|
26
|
+
ProfilesListParams,
|
|
27
|
+
ProfilesGetParams,
|
|
28
|
+
PortfoliosListParams,
|
|
29
|
+
PortfoliosGetParams,
|
|
30
|
+
SponsoredProductCampaignsListParams,
|
|
31
|
+
SponsoredProductCampaignsGetParams
|
|
32
|
+
)
|
|
33
|
+
|
|
34
|
+
__all__ = [
|
|
35
|
+
"AmazonAdsConnector",
|
|
36
|
+
"AmazonAdsAuthConfig",
|
|
37
|
+
"Profile",
|
|
38
|
+
"AccountInfo",
|
|
39
|
+
"Portfolio",
|
|
40
|
+
"PortfolioBudget",
|
|
41
|
+
"SponsoredProductCampaign",
|
|
42
|
+
"DynamicBiddingPlacementbiddingItem",
|
|
43
|
+
"DynamicBidding",
|
|
44
|
+
"CampaignBudget",
|
|
45
|
+
"AmazonAdsExecuteResult",
|
|
46
|
+
"AmazonAdsExecuteResultWithMeta",
|
|
47
|
+
"ProfilesListResult",
|
|
48
|
+
"PortfoliosListResult",
|
|
49
|
+
"SponsoredProductCampaignsListResult",
|
|
50
|
+
"SponsoredProductCampaignsListParamsStatefilter",
|
|
51
|
+
"ProfilesListParams",
|
|
52
|
+
"ProfilesGetParams",
|
|
53
|
+
"PortfoliosListParams",
|
|
54
|
+
"PortfoliosGetParams",
|
|
55
|
+
"SponsoredProductCampaignsListParams",
|
|
56
|
+
"SponsoredProductCampaignsGetParams",
|
|
57
|
+
]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Vendored connector-sdk runtime."""
|