Module airbyte_agent_sdk.connectors.amazon_ads.models

Pydantic models for amazon-ads connector.

This module contains Pydantic models used for authentication configuration and response envelope types.

Classes

AccountInfo(**data: Any) : Information about the advertiser's account associated with a profile

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

id: str | None : The type of the None singleton.

marketplace_string_id: str | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

sub_type: str | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

valid_payment_method: bool | None : The type of the None singleton.

AirbyteSearchMeta(**data: Any) : Pagination metadata for search responses.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

cursor: str | None : Cursor for fetching the next page of results.

has_more: bool : Whether more results are available.

model_config : The type of the None singleton.

took_ms: int | None : Time taken to execute the search in milliseconds.

AirbyteSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.amazon_ads.models.AirbyteSearchResult[ProfilesSearchData]
• airbyte_agent_sdk.connectors.amazon_ads.models.AirbyteSearchResult[dict[str, Any]]

Class variables

data: list[~D] : List of matching records.

meta: airbyte_agent_sdk.connectors.amazon_ads.models.AirbyteSearchMeta : Pagination metadata.

model_config : The type of the None singleton.

AirbyteSearchResult[ProfilesSearchData](**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ProfilesSearchResult(**data: Any) : Result from Airbyte cache search operations with typed records.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsAuthConfig(**data: Any) : OAuth2 Authentication

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

client_id: str | None : The client ID of your Amazon Ads API application

client_secret: str | None : The client secret of your Amazon Ads API application

model_config : The type of the None singleton.

refresh_token: str : The refresh token obtained from the OAuth authorization flow

AmazonAdsCheckResult(**data: Any) : Result of a health check operation.

Returned by the check() method to indicate connectivity and credential status.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

checked_action: str | None : Action name used for the health check.

checked_entity: str | None : Entity name used for the health check.

error: str | None : Error message if status is 'unhealthy', None otherwise.

model_config : The type of the None singleton.

status: str : Health check status: 'healthy' or 'unhealthy'.

AmazonAdsExecuteResult(**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult[list[Profile]]

Class variables

data: ~T : Response data containing the result of the action.

model_config : The type of the None singleton.

AmazonAdsExecuteResultWithMeta(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], PortfoliosListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredBrandsAdGroupsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredBrandsCampaignsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductAdGroupsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductCampaignsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductKeywordsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductNegativeKeywordsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductNegativeTargetsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductProductAdsListResultMeta]
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductTargetsListResultMeta]

Class variables

meta: ~S | None : Metadata about the response (e.g., pagination cursors, record counts).

AmazonAdsExecuteResultWithMeta[dict[str, Any], PortfoliosListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

PortfoliosListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredBrandsAdGroupsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredBrandsAdGroupsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredBrandsCampaignsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredBrandsCampaignsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductAdGroupsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductAdGroupsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductCampaignsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductCampaignsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductKeywordsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductKeywordsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductNegativeKeywordsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductNegativeKeywordsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductNegativeTargetsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductNegativeTargetsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductProductAdsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductProductAdsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResultWithMeta[dict[str, Any], SponsoredProductTargetsListResultMeta](**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SponsoredProductTargetsListResult(**data: Any) : Response envelope with data and metadata.

Used for actions that return both data and metadata (e.g., pagination info).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResultWithMeta
• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

AmazonAdsExecuteResult[list[Profile]](**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

ProfilesListResult(**data: Any) : Response envelope with data only.

Used for actions that return data without metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• airbyte_agent_sdk.connectors.amazon_ads.models.AmazonAdsExecuteResult
• pydantic.main.BaseModel
• typing.Generic

CampaignBudget(**data: Any) : Budget configuration for a campaign

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

budget: float | None : The type of the None singleton.

budget_type: str | None : The type of the None singleton.

model_config : The type of the None singleton.

DynamicBidding(**data: Any) : Dynamic bidding settings for a campaign

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

placement_bidding: list[airbyte_agent_sdk.connectors.amazon_ads.models.DynamicBiddingPlacementbiddingItem] | None : The type of the None singleton.

strategy: str | None : The type of the None singleton.

DynamicBiddingPlacementbiddingItem(**data: Any) : Nested schema for DynamicBidding.placementBidding_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

percentage: int | None : The bid adjustment percentage

placement: str | None : The placement type

Portfolio(**data: Any) : A portfolio is a container for grouping campaigns together for organizational and budget management purposes.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

budget: typing.Any | None : The type of the None singleton.

creation_date: int | None : The type of the None singleton.

in_budget: bool | None : The type of the None singleton.

last_updated_date: int | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

portfolio_id: typing.Any | None : The type of the None singleton.

serving_status: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

PortfolioBudget(**data: Any) : Budget configuration for a portfolio

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

amount: float | None : The type of the None singleton.

currency_code: str | None : The type of the None singleton.

end_date: str | None : The type of the None singleton.

model_config : The type of the None singleton.

policy: str | None : The type of the None singleton.

start_date: str | None : The type of the None singleton.

PortfoliosListResultMeta(**data: Any) : Metadata for portfolios.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

Profile(**data: Any) : An advertising profile represents an advertiser's account in a specific marketplace. Profiles are used to scope API calls and manage advertising campaigns.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_info: typing.Any | None : The type of the None singleton.

country_code: str | None : The type of the None singleton.

currency_code: str | None : The type of the None singleton.

daily_budget: float | None : The type of the None singleton.

model_config : The type of the None singleton.

profile_id: int | None : The type of the None singleton.

timezone: str | None : The type of the None singleton.

ProfilesSearchData(**data: Any) : Search result data for profiles entity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

account_info: dict[str, typing.Any] | None : The type of the None singleton.

country_code: str | None : The type of the None singleton.

currency_code: str | None : The type of the None singleton.

daily_budget: float | None : The type of the None singleton.

model_config : The type of the None singleton.

profile_id: int | None : The type of the None singleton.

timezone: str | None : The type of the None singleton.

SponsoredBrandsAdGroup(**data: Any) : An ad group within a Sponsored Brands campaign. Ad groups organize ads and targeting within a campaign.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

bid: float | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

SponsoredBrandsAdGroupsListResultMeta(**data: Any) : Metadata for sponsored_brands_ad_groups.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredBrandsCampaign(**data: Any) : A Sponsored Brands campaign. Sponsored Brands campaigns help drive discovery and sales with creative ad experiences that appear in shopping results.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bid_multiplier: float | None : The type of the None singleton.

bid_optimization: bool | None : The type of the None singleton.

budget: float | None : The type of the None singleton.

budget_type: str | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

cost_type: str | None : The type of the None singleton.

end_date: str | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

portfolio_id: typing.Any | None : The type of the None singleton.

product_location: str | None : The type of the None singleton.

smart_default: str | None : The type of the None singleton.

start_date: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

tags: dict[str, typing.Any] | None : The type of the None singleton.

SponsoredBrandsCampaignsListResultMeta(**data: Any) : Metadata for sponsored_brands_campaigns.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductAdGroup(**data: Any) : An ad group within a Sponsored Products campaign. Ad groups contain ads and targeting settings and have a default bid that applies to all ads in the group.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

default_bid: float | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

SponsoredProductAdGroupsListResultMeta(**data: Any) : Metadata for sponsored_product_ad_groups.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductCampaign(**data: Any) : A Sponsored Products campaign promotes individual product listings on Amazon. Campaigns contain ad groups, which contain ads and targeting settings. Note: The list endpoint (v3) and get endpoint (v2) return slightly different field formats.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

bidding: typing.Any | None : The type of the None singleton.

budget: typing.Any | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

campaign_type: str | None : The type of the None singleton.

daily_budget: float | None : The type of the None singleton.

dynamic_bidding: typing.Any | None : The type of the None singleton.

end_date: str | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

marketplace_budget_allocation: str | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

off_amazon_settings: dict[str, typing.Any] | None : The type of the None singleton.

portfolio_id: typing.Any | None : The type of the None singleton.

premium_bid_adjustment: bool | None : The type of the None singleton.

start_date: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

tags: dict[str, typing.Any] | None : The type of the None singleton.

targeting_type: str | None : The type of the None singleton.

SponsoredProductCampaignsListResultMeta(**data: Any) : Metadata for sponsored_product_campaigns.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductKeyword(**data: Any) : A keyword within a Sponsored Products ad group. Keywords are used in manual targeting campaigns to match shopper search queries.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

bid: float | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

keyword_id: typing.Any | None : The type of the None singleton.

keyword_text: str | None : The type of the None singleton.

match_type: str | None : The type of the None singleton.

model_config : The type of the None singleton.

state: str | None : The type of the None singleton.

SponsoredProductKeywordsListResultMeta(**data: Any) : Metadata for sponsored_product_keywords.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductNegativeKeyword(**data: Any) : A negative keyword within a Sponsored Products ad group. Negative keywords prevent ads from showing for specific search terms.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

keyword_id: typing.Any | None : The type of the None singleton.

keyword_text: str | None : The type of the None singleton.

match_type: str | None : The type of the None singleton.

model_config : The type of the None singleton.

state: str | None : The type of the None singleton.

SponsoredProductNegativeKeywordsListResultMeta(**data: Any) : Metadata for sponsored_product_negative_keywords.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductNegativeTarget(**data: Any) : A negative targeting clause within a Sponsored Products ad group. Negative targeting clauses exclude specific products or categories from targeting.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

expression: list[airbyte_agent_sdk.connectors.amazon_ads.models.SponsoredProductNegativeTargetExpressionItem] | None : The type of the None singleton.

expression_type: str | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

resolved_expression: list[airbyte_agent_sdk.connectors.amazon_ads.models.SponsoredProductNegativeTargetResolvedexpressionItem] | None : The type of the None singleton.

state: str | None : The type of the None singleton.

target_id: typing.Any | None : The type of the None singleton.

SponsoredProductNegativeTargetExpressionItem(**data: Any) : Nested schema for SponsoredProductNegativeTarget.expression_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

type_: str | None : The expression type

value: str | None : The expression value

SponsoredProductNegativeTargetResolvedexpressionItem(**data: Any) : Nested schema for SponsoredProductNegativeTarget.resolvedExpression_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

type_: str | None : The resolved expression type

value: str | None : The resolved expression value

SponsoredProductNegativeTargetsListResultMeta(**data: Any) : Metadata for sponsored_product_negative_targets.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductProductAd(**data: Any) : A product ad within a Sponsored Products ad group. Product ads associate an advertised product (identified by ASIN or SKU) with an ad group.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

ad_id: typing.Any | None : The type of the None singleton.

asin: str | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

sku: str | None : The type of the None singleton.

state: str | None : The type of the None singleton.

SponsoredProductProductAdsListResultMeta(**data: Any) : Metadata for sponsored_product_product_ads.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.

SponsoredProductTarget(**data: Any) : A targeting clause within a Sponsored Products ad group. Targeting clauses define product or category targeting for the ad group.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

ad_group_id: typing.Any | None : The type of the None singleton.

bid: float | None : The type of the None singleton.

campaign_id: typing.Any | None : The type of the None singleton.

expression: list[airbyte_agent_sdk.connectors.amazon_ads.models.SponsoredProductTargetExpressionItem] | None : The type of the None singleton.

expression_type: str | None : The type of the None singleton.

extended_data: dict[str, typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

resolved_expression: list[airbyte_agent_sdk.connectors.amazon_ads.models.SponsoredProductTargetResolvedexpressionItem] | None : The type of the None singleton.

state: str | None : The type of the None singleton.

target_id: typing.Any | None : The type of the None singleton.

SponsoredProductTargetExpressionItem(**data: Any) : Nested schema for SponsoredProductTarget.expression_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

type_: str | None : The expression type

value: str | None : The expression value

SponsoredProductTargetResolvedexpressionItem(**data: Any) : Nested schema for SponsoredProductTarget.resolvedExpression_item

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

type_: str | None : The resolved expression type

value: str | None : The resolved expression value

SponsoredProductTargetsListResultMeta(**data: Any) : Metadata for sponsored_product_targets.Action.LIST operation

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

next_token: str | None : The type of the None singleton.