Module airbyte_agent_sdk.connectors.facebook_marketing.models
Pydantic models for facebook-marketing connector.
This module contains Pydantic models used for authentication configuration and response envelope types.
Classes
Ad(**data: Any)
: Facebook Ad
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_id: str | None
: The type of the None singleton.
adlabels: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdLabel] | None
: The type of the None singleton.
adset_id: str | None
: The type of the None singleton.
bid_amount: int | None
: The type of the None singleton.
bid_info: typing.Any | None
: The type of the None singleton.
bid_type: str | None
: The type of the None singleton.
campaign_id: str | None
: The type of the None singleton.
configured_status: str | None
: The type of the None singleton.
conversion_specs: list[dict[str, typing.Any]] | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
creative: typing.Any | None
: The type of the None singleton.
effective_status: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
last_updated_by_app_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.
recommendations: list[airbyte_agent_sdk.connectors.facebook_marketing.models.Recommendation] | None
: The type of the None singleton.
source_ad_id: str | None
: The type of the None singleton.
status: str | None
: The type of the None singleton.
tracking_specs: list[dict[str, typing.Any]] | None
: The type of the None singleton.
updated_time: str | None
: The type of the None singleton.
AdAccount(**data: Any)
: Facebook Ad Account
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_id: str | None
: The type of the None singleton.
account_status: int | None
: The type of the None singleton.
age: float | None
: The type of the None singleton.
amount_spent: str | None
: The type of the None singleton.
balance: str | None
: The type of the None singleton.
business: typing.Any | None
: The type of the None singleton.
business_city: str | None
: The type of the None singleton.
business_country_code: str | None
: The type of the None singleton.
business_name: str | None
: The type of the None singleton.
business_state: str | None
: The type of the None singleton.
business_street: str | None
: The type of the None singleton.
business_street2: str | None
: The type of the None singleton.
business_zip: str | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
currency: str | None
: The type of the None singleton.
disable_reason: int | None
: The type of the None singleton.
end_advertiser: str | None
: The type of the None singleton.
end_advertiser_name: str | None
: The type of the None singleton.
funding_source: str | None
: The type of the None singleton.
funding_source_details: dict[str, typing.Any] | None
: The type of the None singleton.
has_migrated_permissions: bool | None
: The type of the None singleton.
id: str
: The type of the None singleton.
is_personal: int | None
: The type of the None singleton.
is_prepay_account: bool | None
: The type of the None singleton.
is_tax_id_required: bool | None
: The type of the None singleton.
min_campaign_group_spend_cap: str | None
: The type of the None singleton.
min_daily_budget: 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.
owner: str | None
: The type of the None singleton.
spend_cap: str | None
: The type of the None singleton.
timezone_id: int | None
: The type of the None singleton.
timezone_name: str | None
: The type of the None singleton.
timezone_offset_hours_utc: float | None
: The type of the None singleton.
AdAccountListItem(**data: Any)
: Facebook Ad Account in list response
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_id: str | None
: The type of the None singleton.
account_status: int | None
: The type of the None singleton.
age: float | None
: The type of the None singleton.
amount_spent: str | None
: The type of the None singleton.
balance: str | None
: The type of the None singleton.
business: typing.Any | None
: The type of the None singleton.
business_name: str | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
currency: str | None
: The type of the None singleton.
disable_reason: int | None
: The type of the None singleton.
id: str
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
spend_cap: str | None
: The type of the None singleton.
timezone_id: int | None
: The type of the None singleton.
timezone_name: str | None
: The type of the None singleton.
AdAccountsList(**data: Any)
: List of Facebook Ad Accounts
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdAccountListItem] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
AdAccountsListResultMeta(**data: Any)
: Metadata for ad_accounts.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdAccountsSearchData(**data: Any)
: Search result data for ad_accounts 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_id: str | None
: Ad account ID (numeric)
account_status: int | None
: Account status
amount_spent: str | None
: Total amount spent
balance: str | None
: Current balance of the ad account
business_name: str | None
: Business name
created_time: str | None
: Account creation time
currency: str | None
: Currency used by the ad account
id: str | None
: Ad account ID
model_config
: The type of the None singleton.
name: str | None
: Ad account name
spend_cap: str | None
: Spend cap
timezone_name: str | None
: Timezone name
AdCreateParams(**data: Any)
: Parameters for creating a new ad. Note - requires a Facebook Page to be connected to the ad account.
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
adset_id: str
: The type of the None singleton.
bid_amount: str | None
: The type of the None singleton.
creative: str
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str
: The type of the None singleton.
status: str
: The type of the None singleton.
tracking_specs: str | None
: The type of the None singleton.
AdCreateResponse(**data: Any)
: Response from creating an ad
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.
model_config
: The type of the None singleton.
AdCreative(**data: Any)
: Facebook Ad Creative
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_id: str | None
: The type of the None singleton.
actor_id: str | None
: The type of the None singleton.
body: str | None
: The type of the None singleton.
call_to_action_type: str | None
: The type of the None singleton.
effective_object_story_id: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
image_hash: str | None
: The type of the None singleton.
image_url: str | None
: The type of the None singleton.
link_url: 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.
object_story_id: str | None
: The type of the None singleton.
object_story_spec: dict[str, typing.Any] | None
: The type of the None singleton.
object_type: str | None
: The type of the None singleton.
status: str | None
: The type of the None singleton.
thumbnail_url: str | None
: The type of the None singleton.
title: str | None
: The type of the None singleton.
url_tags: str | None
: The type of the None singleton.
AdCreativeRef(**data: Any)
: AdCreativeRef type definition
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
creative_id: str | None
: The type of the None singleton.
id: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdCreativesList(**data: Any)
: AdCreativesList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdCreative] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
AdCreativesListResultMeta(**data: Any)
: Metadata for ad_creatives.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdCreativesSearchData(**data: Any)
: Search result data for ad_creatives 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_id: str | None
: Ad account ID
body: str | None
: Ad body text
call_to_action_type: str | None
: Call to action type
id: str | None
: Ad Creative ID
image_url: str | None
: Image URL
link_url: str | None
: Link URL
model_config
: The type of the None singleton.
name: str | None
: Ad Creative name
status: str | None
: Creative status
thumbnail_url: str | None
: Thumbnail URL
title: str | None
: Ad title
AdLabel(**data: Any)
: AdLabel type definition
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
created_time: str | None
: The type of the None singleton.
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.
updated_time: str | None
: The type of the None singleton.
AdLibraryAd(**data: Any)
: An archived ad from the Facebook Ad Library, containing ad creative content, delivery information, spend data, and demographic reach breakdowns.
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_creation_time: str | None
: The type of the None singleton.
ad_creative_bodies: list[str] | None
: The type of the None singleton.
ad_creative_link_captions: list[str] | None
: The type of the None singleton.
ad_creative_link_descriptions: list[str] | None
: The type of the None singleton.
ad_creative_link_titles: list[str] | None
: The type of the None singleton.
ad_delivery_start_time: str | None
: The type of the None singleton.
ad_delivery_stop_time: str | None
: The type of the None singleton.
ad_snapshot_url: str | None
: The type of the None singleton.
age_country_gender_reach_breakdown: list[dict[str, typing.Any]] | None
: The type of the None singleton.
beneficiary_payers: list[dict[str, typing.Any]] | None
: The type of the None singleton.
br_total_reach: int | None
: The type of the None singleton.
bylines: str | None
: The type of the None singleton.
currency: str | None
: The type of the None singleton.
delivery_by_region: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdLibraryAdDeliveryByRegionItem] | None
: The type of the None singleton.
demographic_distribution: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdLibraryAdDemographicDistributionItem] | None
: The type of the None singleton.
estimated_audience_size: airbyte_agent_sdk.connectors.facebook_marketing.models.AdLibraryAdEstimatedAudienceSize | None
: The type of the None singleton.
eu_total_reach: int | None
: The type of the None singleton.
id: str
: The type of the None singleton.
impressions: airbyte_agent_sdk.connectors.facebook_marketing.models.AdLibraryAdImpressions | None
: The type of the None singleton.
languages: list[str] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
page_id: str | None
: The type of the None singleton.
page_name: str | None
: The type of the None singleton.
publisher_platforms: list[str] | None
: The type of the None singleton.
spend: airbyte_agent_sdk.connectors.facebook_marketing.models.AdLibraryAdSpend | None
: The type of the None singleton.
target_ages: list[str] | None
: The type of the None singleton.
target_gender: str | None
: The type of the None singleton.
target_locations: list[dict[str, typing.Any]] | None
: The type of the None singleton.
total_reach_by_location: list[dict[str, typing.Any]] | None
: The type of the None singleton.
AdLibraryAdDeliveryByRegionItem(**data: Any)
: Nested schema for AdLibraryAd.delivery_by_region_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: str | None
: Percentage of audience in this region
region: str | None
: Region name
AdLibraryAdDemographicDistributionItem(**data: Any)
: Nested schema for AdLibraryAd.demographic_distribution_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
age: str | None
: Age range
gender: str | None
: Gender category
model_config
: The type of the None singleton.
percentage: str | None
: Percentage of audience in this demographic
AdLibraryAdEstimatedAudienceSize(**data: Any)
: Estimated audience size range
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
lower_bound: int | None
: Lower bound of the estimated audience size
model_config
: The type of the None singleton.
upper_bound: int | None
: Upper bound of the estimated audience size
AdLibraryAdImpressions(**data: Any)
: Number of impressions as a range
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
lower_bound: int | None
: Lower bound of impressions
model_config
: The type of the None singleton.
upper_bound: int | None
: Upper bound of impressions
AdLibraryAdSpend(**data: Any)
: Amount spent on the ad as a range
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
lower_bound: int | None
: Lower bound of spend
model_config
: The type of the None singleton.
upper_bound: int | None
: Upper bound of spend
AdLibraryList(**data: Any)
: AdLibraryList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdLibraryAd] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
AdLibraryListResultMeta(**data: Any)
: Metadata for ad_library.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdSet(**data: Any)
: Facebook Ad Set
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_id: str | None
: The type of the None singleton.
adlabels: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdLabel] | None
: The type of the None singleton.
bid_amount: float | None
: The type of the None singleton.
bid_constraints: typing.Any | None
: The type of the None singleton.
bid_info: typing.Any | None
: The type of the None singleton.
bid_strategy: str | None
: The type of the None singleton.
budget_remaining: float | None
: The type of the None singleton.
campaign_id: str | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
daily_budget: float | None
: The type of the None singleton.
effective_status: str | None
: The type of the None singleton.
end_time: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
learning_stage_info: typing.Any | None
: The type of the None singleton.
lifetime_budget: float | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
promoted_object: typing.Any | None
: The type of the None singleton.
start_time: str | None
: The type of the None singleton.
targeting: dict[str, typing.Any] | None
: The type of the None singleton.
updated_time: str | None
: The type of the None singleton.
AdSetCreateParams(**data: Any)
: Parameters for creating a new ad set
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_amount: str | None
: The type of the None singleton.
billing_event: str
: The type of the None singleton.
campaign_id: str
: The type of the None singleton.
daily_budget: str | None
: The type of the None singleton.
end_time: str | None
: The type of the None singleton.
lifetime_budget: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str
: The type of the None singleton.
optimization_goal: str
: The type of the None singleton.
start_time: str | None
: The type of the None singleton.
status: str
: The type of the None singleton.
targeting: str
: The type of the None singleton.
AdSetCreateResponse(**data: Any)
: Response from creating an ad set
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.
model_config
: The type of the None singleton.
AdSetUpdateParams(**data: Any)
: Parameters for updating an ad set
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_amount: str | None
: The type of the None singleton.
daily_budget: str | None
: The type of the None singleton.
end_time: str | None
: The type of the None singleton.
lifetime_budget: 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.
start_time: str | None
: The type of the None singleton.
status: str | None
: The type of the None singleton.
targeting: str | None
: The type of the None singleton.
AdSetsList(**data: Any)
: AdSetsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdSet] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
AdSetsListResultMeta(**data: Any)
: Metadata for ad_sets.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdSetsSearchData(**data: Any)
: Search result data for ad_sets 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_id: str | None
: Ad account ID
bid_amount: float | None
: Bid amount
bid_strategy: str | None
: Bid strategy
budget_remaining: float | None
: Remaining budget
campaign_id: str | None
: Parent campaign ID
created_time: str | None
: Ad set creation time
daily_budget: float | None
: Daily budget
effective_status: str | None
: Effective status
end_time: str | None
: Ad set end time
id: str | None
: Ad Set ID
lifetime_budget: float | None
: Lifetime budget
model_config
: The type of the None singleton.
name: str | None
: Ad Set name
start_time: str | None
: Ad set start time
updated_time: str | None
: Last update time
AdUpdateParams(**data: Any)
: Parameters for updating an ad
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_amount: str | None
: The type of the None singleton.
creative: 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.
status: str | None
: The type of the None singleton.
tracking_specs: str | None
: The type of the None singleton.
AdsActionStats(**data: Any)
: Action statistics for Facebook ads
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
action_destination: str | None
: The type of the None singleton.
action_target_id: str | None
: The type of the None singleton.
action_type: str | None
: The type of the None singleton.
field_1d_click: float | None
: The type of the None singleton.
field_1d_view: float | None
: The type of the None singleton.
field_28d_click: float | None
: The type of the None singleton.
field_28d_view: float | None
: The type of the None singleton.
field_7d_click: float | None
: The type of the None singleton.
field_7d_view: float | None
: The type of the None singleton.
model_config
: The type of the None singleton.
value: float | None
: The type of the None singleton.
AdsInsight(**data: Any)
: Facebook Ads Insight
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_id: str | None
: The type of the None singleton.
account_name: str | None
: The type of the None singleton.
action_values: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdsActionStats] | None
: The type of the None singleton.
actions: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdsActionStats] | None
: The type of the None singleton.
ad_id: str | None
: The type of the None singleton.
ad_name: str | None
: The type of the None singleton.
adset_id: str | None
: The type of the None singleton.
adset_name: str | None
: The type of the None singleton.
campaign_id: str | None
: The type of the None singleton.
campaign_name: str | None
: The type of the None singleton.
clicks: int | None
: The type of the None singleton.
cpc: float | None
: The type of the None singleton.
cpm: float | None
: The type of the None singleton.
ctr: float | None
: The type of the None singleton.
date_start: str | None
: The type of the None singleton.
date_stop: str | None
: The type of the None singleton.
impressions: int | None
: The type of the None singleton.
model_config
: The type of the None singleton.
reach: int | None
: The type of the None singleton.
spend: float | None
: The type of the None singleton.
AdsInsightsList(**data: Any)
: AdsInsightsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdsInsight] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
AdsInsightsListResultMeta(**data: Any)
: Metadata for ads_insights.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdsInsightsSearchData(**data: Any)
: Search result data for ads_insights 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_id: str | None
: Ad account ID
account_name: str | None
: Ad account name
action_values: list[typing.Any] | None
: Action values taken on the ad
actions: list[typing.Any] | None
: Total number of actions taken
ad_id: str | None
: Ad ID
ad_name: str | None
: Ad name
adset_id: str | None
: Ad set ID
adset_name: str | None
: Ad set name
campaign_id: str | None
: Campaign ID
campaign_name: str | None
: Campaign name
clicks: int | None
: Number of clicks
cpc: float | None
: Cost per click
cpm: float | None
: Cost per 1000 impressions
ctr: float | None
: Click-through rate
date_start: str | None
: Start date of the reporting period
date_stop: str | None
: End date of the reporting period
impressions: int | None
: Number of impressions
model_config
: The type of the None singleton.
reach: int | None
: Number of unique people reached
spend: float | None
: Amount spent
AdsList(**data: Any)
: AdsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.Ad] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
AdsListResultMeta(**data: Any)
: Metadata for 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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
AdsSearchData(**data: Any)
: Search result data for ads 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_id: str | None
: Ad account ID
adset_id: str | None
: Parent ad set ID
campaign_id: str | None
: Parent campaign ID
created_time: str | None
: Ad creation time
effective_status: str | None
: Effective status
id: str | None
: Ad ID
model_config
: The type of the None singleton.
name: str | None
: Ad name
status: str | None
: Ad status
updated_time: str | None
: Last update time
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.facebook_marketing.models.AirbyteSearchResult[AdAccountsSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[AdCreativesSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[AdSetsSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[AdsInsightsSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[AdsSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[CampaignsSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[CustomConversionsSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[ImagesSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[VideosSearchData]
- airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchResult[dict[str, Any]]
Class variables
data: list[~D]
: List of matching records.
meta: airbyte_agent_sdk.connectors.facebook_marketing.models.AirbyteSearchMeta
: Pagination metadata.
model_config
: The type of the None singleton.
AirbyteSearchResult[AdAccountsSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdAccountsSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[AdCreativesSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdCreativesSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[AdSetsSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdSetsSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[AdsInsightsSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdsInsightsSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[AdsSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdsSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[CampaignsSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
CampaignsSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[CustomConversionsSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
CustomConversionsSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[ImagesSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
ImagesSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[VideosSearchData](**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
VideosSearchResult(**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.facebook_marketing.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
BidConstraints(**data: Any)
: BidConstraints type definition
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.
roas_average_floor: int | None
: The type of the None singleton.
BidInfo(**data: Any)
: BidInfo type definition
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
actions: int | None
: The type of the None singleton.
clicks: int | None
: The type of the None singleton.
impressions: int | None
: The type of the None singleton.
model_config
: The type of the None singleton.
reach: int | None
: The type of the None singleton.
social: int | None
: The type of the None singleton.
BusinessRef(**data: Any)
: Reference to a Facebook Business
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.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
Campaign(**data: Any)
: Facebook Ad 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
account_id: str | None
: The type of the None singleton.
adlabels: list[airbyte_agent_sdk.connectors.facebook_marketing.models.AdLabel] | None
: The type of the None singleton.
bid_strategy: str | None
: The type of the None singleton.
boosted_object_id: str | None
: The type of the None singleton.
budget_rebalance_flag: bool | None
: The type of the None singleton.
budget_remaining: float | None
: The type of the None singleton.
buying_type: str | None
: The type of the None singleton.
configured_status: str | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
daily_budget: float | None
: The type of the None singleton.
effective_status: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
issues_info: list[airbyte_agent_sdk.connectors.facebook_marketing.models.IssueInfo] | None
: The type of the None singleton.
lifetime_budget: float | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
objective: str | None
: The type of the None singleton.
smart_promotion_type: str | None
: The type of the None singleton.
source_campaign_id: str | None
: The type of the None singleton.
special_ad_category: str | None
: The type of the None singleton.
special_ad_category_country: list[str | None] | None
: The type of the None singleton.
spend_cap: float | None
: The type of the None singleton.
start_time: str | None
: The type of the None singleton.
status: str | None
: The type of the None singleton.
stop_time: str | None
: The type of the None singleton.
updated_time: str | None
: The type of the None singleton.
CampaignCreateParams(**data: Any)
: Parameters for creating a new 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
bid_strategy: str | None
: The type of the None singleton.
daily_budget: str | None
: The type of the None singleton.
is_adset_budget_sharing_enabled: bool | None
: The type of the None singleton.
lifetime_budget: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str
: The type of the None singleton.
objective: str
: The type of the None singleton.
special_ad_categories: str
: The type of the None singleton.
status: str
: The type of the None singleton.
CampaignCreateResponse(**data: Any)
: Response from creating 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
id: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
CampaignUpdateParams(**data: Any)
: Parameters for updating 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
bid_strategy: str | None
: The type of the None singleton.
daily_budget: str | None
: The type of the None singleton.
lifetime_budget: 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.
spend_cap: str | None
: The type of the None singleton.
status: str | None
: The type of the None singleton.
CampaignsList(**data: Any)
: CampaignsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.Campaign] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
CampaignsListResultMeta(**data: Any)
: Metadata for 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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
CampaignsSearchData(**data: Any)
: Search result data for campaigns 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_id: str | None
: Ad account ID
budget_remaining: float | None
: Remaining budget
created_time: str | None
: Campaign creation time
daily_budget: float | None
: Daily budget in account currency
effective_status: str | None
: Effective status
id: str | None
: Campaign ID
lifetime_budget: float | None
: Lifetime budget
model_config
: The type of the None singleton.
name: str | None
: Campaign name
objective: str | None
: Campaign objective
start_time: str | None
: Campaign start time
status: str | None
: Campaign status
stop_time: str | None
: Campaign stop time
updated_time: str | None
: Last update time
CurrentUser(**data: Any)
: Current Facebook user associated with the access token
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
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
CustomConversion(**data: Any)
: Facebook Custom Conversion
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_id: str | None
: The type of the None singleton.
business: str | None
: The type of the None singleton.
creation_time: str | None
: The type of the None singleton.
custom_event_type: str | None
: The type of the None singleton.
data_sources: list[airbyte_agent_sdk.connectors.facebook_marketing.models.DataSource] | None
: The type of the None singleton.
default_conversion_value: float | None
: The type of the None singleton.
description: str | None
: The type of the None singleton.
event_source_type: str | None
: The type of the None singleton.
first_fired_time: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
is_archived: bool | None
: The type of the None singleton.
is_unavailable: bool | None
: The type of the None singleton.
last_fired_time: 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.
offline_conversion_data_set: str | None
: The type of the None singleton.
retention_days: float | None
: The type of the None singleton.
rule: str | None
: The type of the None singleton.
CustomConversionsList(**data: Any)
: CustomConversionsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.CustomConversion] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
CustomConversionsListResultMeta(**data: Any)
: Metadata for custom_conversions.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
CustomConversionsSearchData(**data: Any)
: Search result data for custom_conversions 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_id: str | None
: Ad account ID
creation_time: str | None
: Creation time
custom_event_type: str | None
: Custom event type
description: str | None
: Description
first_fired_time: str | None
: First fired time
id: str | None
: Custom Conversion ID
is_archived: bool | None
: Whether the conversion is archived
last_fired_time: str | None
: Last fired time
model_config
: The type of the None singleton.
name: str | None
: Custom Conversion name
DataSource(**data: Any)
: DataSource type definition
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.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
source_type: str | None
: The type of the None singleton.
FacebookMarketingCheckResult(**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'.
FacebookMarketingExecuteResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult[list[PixelStat]]
Class variables
data: ~T
: Response data containing the result of the action.
model_config
: The type of the None singleton.
FacebookMarketingExecuteResultWithMeta(**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.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Descendants
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[AdAccountListItem], AdAccountsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[AdCreative], AdCreativesListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[AdLibraryAd], AdLibraryListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[AdSet], AdSetsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[Ad], AdsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[AdsInsight], AdsInsightsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[Campaign], CampaignsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[CustomConversion], CustomConversionsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[Image], ImagesListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[Pixel], PixelsListResultMeta]
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta[list[Video], VideosListResultMeta]
Class variables
meta: ~S | None
: Metadata about the response (e.g., pagination cursors, record counts).
FacebookMarketingExecuteResultWithMeta[list[AdAccountListItem], AdAccountsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdAccountsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[AdCreative], AdCreativesListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdCreativesListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[AdLibraryAd], AdLibraryListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdLibraryListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[AdSet], AdSetsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdSetsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[Ad], AdsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[AdsInsight], AdsInsightsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
AdsInsightsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[Campaign], CampaignsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
CampaignsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[CustomConversion], CustomConversionsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
CustomConversionsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[Image], ImagesListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
ImagesListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[Pixel], PixelsListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
PixelsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResultWithMeta[list[Video], VideosListResultMeta](**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
VideosListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResultWithMeta
- airbyte_agent_sdk.connectors.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingExecuteResult[list[PixelStat]](**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.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
PixelStatsListResult(**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.facebook_marketing.models.FacebookMarketingExecuteResult
- pydantic.main.BaseModel
- typing.Generic
FacebookMarketingOauth20AuthenticationAuthConfig(**data: Any)
: OAuth 2.0 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
access_token: str
: Facebook OAuth2 Access Token
client_id: str | None
: Facebook App Client ID
client_secret: str | None
: Facebook App Client Secret
model_config
: The type of the None singleton.
FacebookMarketingReplicationConfig(**data: Any)
: Replication Configuration - Settings for data replication from Facebook Marketing.
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_ids: str
: The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your Meta Ads Manager.
model_config
: The type of the None singleton.
FacebookMarketingServiceAccountKeyAuthenticationAuthConfig(**data: Any)
: Service Account Key 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
account_key: str
: Facebook long-lived access token for Service Account authentication
model_config
: The type of the None singleton.
Image(**data: Any)
: Image type definition
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_id: str | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
creatives: list[str | None] | None
: The type of the None singleton.
filename: str | None
: The type of the None singleton.
hash: str | None
: The type of the None singleton.
height: int | None
: The type of the None singleton.
id: str | None
: The type of the None singleton.
is_associated_creatives_in_adgroups: bool | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
original_height: int | None
: The type of the None singleton.
original_width: int | None
: The type of the None singleton.
permalink_url: str | None
: The type of the None singleton.
status: str | None
: The type of the None singleton.
updated_time: str | None
: The type of the None singleton.
url: str | None
: The type of the None singleton.
url_128: str | None
: The type of the None singleton.
width: int | None
: The type of the None singleton.
ImagesList(**data: Any)
: ImagesList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.Image] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
ImagesListResultMeta(**data: Any)
: Metadata for images.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
ImagesSearchData(**data: Any)
: Search result data for images 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_id: str | None
: Ad account ID
created_time: str | None
: Creation time
hash: str | None
: Image hash
height: int | None
: Image height
id: str | None
: Image ID
model_config
: The type of the None singleton.
name: str | None
: Image name
permalink_url: str | None
: Permalink URL
status: str | None
: Image status
updated_time: str | None
: Last update time
url: str | None
: Image URL
width: int | None
: Image width
IssueInfo(**data: Any)
: IssueInfo type definition
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
error_code: str | None
: The type of the None singleton.
error_message: str | None
: The type of the None singleton.
error_summary: str | None
: The type of the None singleton.
error_type: str | None
: The type of the None singleton.
level: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
LearningStageInfo(**data: Any)
: LearningStageInfo type definition
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
attribution_windows: list[str | None] | None
: The type of the None singleton.
conversions: int | None
: The type of the None singleton.
last_sig_edit_ts: int | None
: The type of the None singleton.
model_config
: The type of the None singleton.
status: str | None
: The type of the None singleton.
Paging(**data: Any)
: Paging type definition
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
cursors: airbyte_agent_sdk.connectors.facebook_marketing.models.PagingCursors | None
: The type of the None singleton.
model_config
: The type of the None singleton.
next: str | None
: The type of the None singleton.
previous: str | None
: The type of the None singleton.
PagingCursors(**data: Any)
: Nested schema for Paging.cursors
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
after: str | None
: Cursor for next page
before: str | None
: Cursor for previous page
model_config
: The type of the None singleton.
Pixel(**data: Any)
: Facebook Ads Pixel
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
creation_time: str | None
: The type of the None singleton.
creator: airbyte_agent_sdk.connectors.facebook_marketing.models.PixelCreator | None
: The type of the None singleton.
data_use_setting: str | None
: The type of the None singleton.
enable_automatic_matching: bool | None
: The type of the None singleton.
first_party_cookie_status: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
is_created_by_app: bool | None
: The type of the None singleton.
is_crm: bool | None
: The type of the None singleton.
is_unavailable: bool | None
: The type of the None singleton.
last_fired_time: 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.
owner_ad_account: airbyte_agent_sdk.connectors.facebook_marketing.models.PixelOwnerAdAccount | None
: The type of the None singleton.
owner_business: airbyte_agent_sdk.connectors.facebook_marketing.models.PixelOwnerBusiness | None
: The type of the None singleton.
PixelCreator(**data: Any)
: User who created the pixel
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
: Creator user ID
model_config
: The type of the None singleton.
name: str | None
: Creator user name
PixelOwnerAdAccount(**data: Any)
: Ad account that owns the pixel
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_id: str | None
: Owner ad account ID
id: str | None
: Owner ad account ID (with act_ prefix)
model_config
: The type of the None singleton.
PixelOwnerBusiness(**data: Any)
: Business that owns the pixel
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
: Owner business ID
model_config
: The type of the None singleton.
name: str | None
: Owner business name
PixelStat(**data: Any)
: Facebook Pixel event stat entry showing event counts and quality metrics
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.PixelStatDataItem] | None
: The type of the None singleton.
event: str | None
: The type of the None singleton.
event_source: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
test_events_count: int | None
: The type of the None singleton.
total_count: int | None
: The type of the None singleton.
total_deduped_count: int | None
: The type of the None singleton.
total_matched_count: int | None
: The type of the None singleton.
PixelStatDataItem(**data: Any)
: Nested schema for PixelStat.data_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.
timestamp: str | None
: Timestamp for the data point
value: int | None
: Event count at the timestamp
PixelStatsList(**data: Any)
: PixelStatsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.PixelStat] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
PixelsList(**data: Any)
: PixelsList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.Pixel] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
PixelsListResultMeta(**data: Any)
: Metadata for pixels.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
PromotedObject(**data: Any)
: PromotedObject type definition
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
application_id: str | None
: The type of the None singleton.
custom_event_type: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
object_store_url: str | None
: The type of the None singleton.
offer_id: str | None
: The type of the None singleton.
page_id: str | None
: The type of the None singleton.
pixel_id: str | None
: The type of the None singleton.
pixel_rule: str | None
: The type of the None singleton.
product_set_id: str | None
: The type of the None singleton.
Recommendation(**data: Any)
: Recommendation type definition
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
blame_field: str | None
: The type of the None singleton.
code: int | None
: The type of the None singleton.
confidence: str | None
: The type of the None singleton.
importance: str | None
: The type of the None singleton.
message: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
title: str | None
: The type of the None singleton.
UpdateResponse(**data: Any)
: Generic response from update operations
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.
success: bool | None
: The type of the None singleton.
Video(**data: Any)
: Video type definition
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_id: str | None
: The type of the None singleton.
ad_breaks: list[int] | None
: The type of the None singleton.
backdated_time: str | None
: The type of the None singleton.
backdated_time_granularity: str | None
: The type of the None singleton.
content_category: str | None
: The type of the None singleton.
content_tags: list[str] | None
: The type of the None singleton.
created_time: str | None
: The type of the None singleton.
custom_labels: list[str] | None
: The type of the None singleton.
description: str | None
: The type of the None singleton.
embed_html: str | None
: The type of the None singleton.
embeddable: bool | None
: The type of the None singleton.
format: list[airbyte_agent_sdk.connectors.facebook_marketing.models.VideoFormat] | None
: The type of the None singleton.
icon: str | None
: The type of the None singleton.
id: str
: The type of the None singleton.
is_crosspost_video: bool | None
: The type of the None singleton.
is_crossposting_eligible: bool | None
: The type of the None singleton.
is_episode: bool | None
: The type of the None singleton.
is_instagram_eligible: bool | None
: The type of the None singleton.
length: float | None
: The type of the None singleton.
live_status: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
permalink_url: str | None
: The type of the None singleton.
post_views: int | None
: The type of the None singleton.
premiere_living_room_status: bool | None
: The type of the None singleton.
published: bool | None
: The type of the None singleton.
scheduled_publish_time: str | None
: The type of the None singleton.
source: str | None
: The type of the None singleton.
title: str | None
: The type of the None singleton.
universal_video_id: str | None
: The type of the None singleton.
updated_time: str | None
: The type of the None singleton.
views: int | None
: The type of the None singleton.
VideoFormat(**data: Any)
: VideoFormat type definition
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
embed_html: str | None
: The type of the None singleton.
filter: str | None
: The type of the None singleton.
height: int | None
: The type of the None singleton.
model_config
: The type of the None singleton.
picture: str | None
: The type of the None singleton.
width: int | None
: The type of the None singleton.
VideosList(**data: Any)
: VideosList type definition
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
data: list[airbyte_agent_sdk.connectors.facebook_marketing.models.Video] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
paging: airbyte_agent_sdk.connectors.facebook_marketing.models.Paging | None
: The type of the None singleton.
VideosListResultMeta(**data: Any)
: Metadata for videos.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
after: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
VideosSearchData(**data: Any)
: Search result data for videos 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_id: str | None
: Ad account ID
created_time: str | None
: Creation time
description: str | None
: Video description
id: str | None
: Video ID
length: float | None
: Video length in seconds
model_config
: The type of the None singleton.
permalink_url: str | None
: Permalink URL
source: str | None
: Video source URL
title: str | None
: Video title
updated_time: str | None
: Last update time
views: int | None
: Number of views