Module airbyte_agent_sdk.connectors.tiktok_marketing.models

Pydantic models for tiktok-marketing connector.

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

Classes

Ad(**data: Any) : TikTok 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

ad_format: str | 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.

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

ad_texts: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

campaign_automation_type: 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.

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

carousel_image_labels: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

image_ids: list[str] | None : The type of the None singleton.

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

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

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

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

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

landing_page_urls: list[typing.Any] | None : The type of the None singleton.

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

AdGroup(**data: Any) : TikTok ad group

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

actions: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

age_groups: list[str] | None : The type of the None singleton.

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

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

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

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

audience_ids: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

campaign_automation_type: 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.

category_exclusion_ids: list[typing.Any] | None : The type of the None singleton.

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

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

contextual_tag_ids: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

device_model_ids: list[typing.Any] | None : The type of the None singleton.

device_price_ranges: list[typing.Any] | None : The type of the None singleton.

excluded_audience_ids: list[typing.Any] | None : The type of the None singleton.

excluded_custom_actions: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

household_income: list[typing.Any] | None : The type of the None singleton.

included_custom_actions: list[typing.Any] | None : The type of the None singleton.

interest_category_ids: list[str] | None : The type of the None singleton.

interest_keyword_ids: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

isp_ids: list[typing.Any] | None : The type of the None singleton.

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

languages: list[str] | None : The type of the None singleton.

location_ids: list[str] | None : The type of the None singleton.

model_config : The type of the None singleton.

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

network_types: list[typing.Any] | None : The type of the None singleton.

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

operating_systems: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

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

placements: list[str] | None : The type of the None singleton.

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

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

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

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

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

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

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

schedule_infos: list[typing.Any] | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

zipcode_ids: list[typing.Any] | None : The type of the None singleton.

AdGroupsListResultMeta(**data: Any) : Metadata for ad_groups.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdGroupsReportDaily(**data: Any) : Daily performance report at the ad group level

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AdGroupsReportsDailyListResultMeta(**data: Any) : Metadata for ad_groups_reports_daily.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdGroupsReportsDailySearchData(**data: Any) : Search result data for ad_groups_reports_daily 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

adgroup_id: int | None : The unique identifier for the ad group.

adgroup_name: str | None : The name of the ad group.

app_install: float | None : Number of app installations.

average_video_play: float | None : Average video play duration.

average_video_play_per_user: float | None : Average video play duration per user.

campaign_id: int | None : The unique identifier for the campaign.

campaign_name: str | None : The name of the marketing campaign.

clicks: str | None : Number of clicks on the ad.

clicks_on_music_disc: float | None : Number of clicks on the music disc.

comments: float | None : Number of comments.

conversion: str | None : Number of conversions.

conversion_rate: str | None : Rate of conversions.

cost_per_1000_reached: str | None : Cost per 1000 unique users reached.

cost_per_conversion: str | None : Cost per conversion.

cost_per_result: str | None : Cost per result.

cost_per_secondary_goal_result: str | None : Cost per secondary goal result.

cpc: str | None : Cost per click.

cpm: str | None : Cost per thousand impressions.

ctr: str | None : Click-through rate.

follows: float | None : Number of follows.

frequency: str | None : Average number of times each person saw the ad.

impressions: str | None : Number of times the ad was displayed.

likes: float | None : Number of likes.

model_config : The type of the None singleton.

placement_type: str | None : Type of ad placement.

profile_visits: float | None : Number of profile visits.

reach: str | None : Total number of unique users reached.

real_time_app_install: float | None : Real-time app installations.

real_time_app_install_cost: float | None : Cost of real-time app installations.

real_time_conversion: str | None : Real-time conversions.

real_time_conversion_rate: str | None : Real-time conversion rate.

real_time_cost_per_conversion: str | None : Real-time cost per conversion.

real_time_cost_per_result: str | None : Real-time cost per result.

real_time_result: str | None : Real-time results.

real_time_result_rate: str | None : Real-time result rate.

result: str | None : Number of results.

result_rate: str | None : Rate of results.

secondary_goal_result: str | None : Results for secondary goals.

secondary_goal_result_rate: str | None : Rate of secondary goal results.

shares: float | None : Number of shares.

spend: str | None : Total amount of money spent.

stat_time_day: str | None : The date for which the statistical data is recorded (YYYY-MM-DD HH:MM:SS format).

video_play_actions: float | None : Number of video play actions.

video_views_p100: float | None : Number of times video was watched to 100%.

video_views_p25: float | None : Number of times video was watched to 25%.

video_views_p50: float | None : Number of times video was watched to 50%.

video_views_p75: float | None : Number of times video was watched to 75%.

video_watched_2s: float | None : Number of times video was watched for at least 2 seconds.

video_watched_6s: float | None : Number of times video was watched for at least 6 seconds.

AdGroupsSearchData(**data: Any) : Search result data for ad_groups 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

adgroup_id: int | None : The unique identifier of the ad group

adgroup_name: str | None : The name of the ad group

advertiser_id: int | None : The unique identifier of the advertiser

budget: float | None : The allocated budget for the ad group

budget_mode: str | None : The mode for managing the budget

campaign_id: int | None : The unique identifier of the campaign

create_time: str | None : The timestamp for when the ad group was created

model_config : The type of the None singleton.

modify_time: str | None : The timestamp for when the ad group was last modified

operation_status: str | None : The status of the operation

optimization_goal: str | None : The goal set for optimization

placement_type: str | None : The type of ad placement

promotion_type: str | None : The type of promotion

secondary_status: str | None : The secondary status of the ad group

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

model_config : The type of the None singleton.

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

AdsReportDaily(**data: Any) : Daily performance report at the ad level

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_id: int | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AdsReportHourly(**data: Any) : Hourly performance report at the ad level

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_id: int | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AdsReportLifetime(**data: Any) : Lifetime performance report at the ad level

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_id: int | None : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AdsReportsDailyListResultMeta(**data: Any) : Metadata for ads_reports_daily.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdsReportsDailySearchData(**data: Any) : Search result data for ads_reports_daily 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

ad_id: int | None : The unique identifier for the ad.

ad_name: str | None : The name of the ad.

ad_text: str | None : The text content of the ad.

adgroup_id: int | None : The unique identifier for the ad group.

adgroup_name: str | None : The name of the ad group.

app_install: float | None : Number of app installations.

average_video_play: float | None : Average video play duration.

average_video_play_per_user: float | None : Average video play duration per user.

campaign_id: int | None : The unique identifier for the campaign.

campaign_name: str | None : The name of the marketing campaign.

clicks: str | None : Number of clicks on the ad.

clicks_on_music_disc: float | None : Number of clicks on the music disc.

comments: float | None : Number of comments.

conversion: str | None : Number of conversions.

conversion_rate: str | None : Rate of conversions.

cost_per_1000_reached: str | None : Cost per 1000 unique users reached.

cost_per_conversion: str | None : Cost per conversion.

cost_per_result: str | None : Cost per result.

cost_per_secondary_goal_result: str | None : Cost per secondary goal result.

cpc: str | None : Cost per click.

cpm: str | None : Cost per thousand impressions.

ctr: str | None : Click-through rate.

follows: float | None : Number of follows.

frequency: str | None : Average number of times each person saw the ad.

impressions: str | None : Number of times the ad was displayed.

likes: float | None : Number of likes.

model_config : The type of the None singleton.

placement_type: str | None : Type of ad placement.

profile_visits: float | None : Number of profile visits.

reach: str | None : Total number of unique users reached.

real_time_app_install: float | None : Real-time app installations.

real_time_app_install_cost: float | None : Cost of real-time app installations.

real_time_conversion: str | None : Real-time conversions.

real_time_conversion_rate: str | None : Real-time conversion rate.

real_time_cost_per_conversion: str | None : Real-time cost per conversion.

real_time_cost_per_result: str | None : Real-time cost per result.

real_time_result: str | None : Real-time results.

real_time_result_rate: str | None : Real-time result rate.

result: str | None : Number of results.

result_rate: str | None : Rate of results.

secondary_goal_result: str | None : Results for secondary goals.

secondary_goal_result_rate: str | None : Rate of secondary goal results.

shares: float | None : Number of shares.

spend: str | None : Total amount of money spent.

stat_time_day: str | None : The date for which the statistical data is recorded (YYYY-MM-DD HH:MM:SS format).

video_play_actions: float | None : Number of video play actions.

video_views_p100: float | None : Number of times video was watched to 100%.

video_views_p25: float | None : Number of times video was watched to 25%.

video_views_p50: float | None : Number of times video was watched to 50%.

video_views_p75: float | None : Number of times video was watched to 75%.

video_watched_2s: float | None : Number of times video was watched for at least 2 seconds.

video_watched_6s: float | None : Number of times video was watched for at least 6 seconds.

AdsReportsHourlyListResultMeta(**data: Any) : Metadata for ads_reports_hourly.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdsReportsHourlySearchData(**data: Any) : Search result data for ads_reports_hourly 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

ad_id: int | None : The unique identifier for the ad.

ad_name: str | None : The name of the ad.

ad_text: str | None : The text content of the ad.

adgroup_id: int | None : The unique identifier for the ad group.

adgroup_name: str | None : The name of the ad group.

app_install: float | None : Number of app installations.

average_video_play: float | None : Average video play duration.

average_video_play_per_user: float | None : Average video play duration per user.

campaign_id: int | None : The unique identifier for the campaign.

campaign_name: str | None : The name of the marketing campaign.

clicks: str | None : Number of clicks on the ad.

clicks_on_music_disc: float | None : Number of clicks on the music disc.

comments: float | None : Number of comments.

conversion: str | None : Number of conversions.

conversion_rate: str | None : Rate of conversions.

cost_per_1000_reached: str | None : Cost per 1000 unique users reached.

cost_per_conversion: str | None : Cost per conversion.

cost_per_result: str | None : Cost per result.

cost_per_secondary_goal_result: str | None : Cost per secondary goal result.

cpc: str | None : Cost per click.

cpm: str | None : Cost per thousand impressions.

ctr: str | None : Click-through rate.

follows: float | None : Number of follows.

frequency: str | None : Average number of times each person saw the ad.

impressions: str | None : Number of times the ad was displayed.

likes: float | None : Number of likes.

model_config : The type of the None singleton.

placement_type: str | None : Type of ad placement.

profile_visits: float | None : Number of profile visits.

reach: str | None : Total number of unique users reached.

real_time_app_install: float | None : Real-time app installations.

real_time_app_install_cost: float | None : Cost of real-time app installations.

real_time_conversion: str | None : Real-time conversions.

real_time_conversion_rate: str | None : Real-time conversion rate.

real_time_cost_per_conversion: str | None : Real-time cost per conversion.

real_time_cost_per_result: str | None : Real-time cost per result.

real_time_result: str | None : Real-time results.

real_time_result_rate: str | None : Real-time result rate.

result: str | None : Number of results.

result_rate: str | None : Rate of results.

secondary_goal_result: str | None : Results for secondary goals.

secondary_goal_result_rate: str | None : Rate of secondary goal results.

shares: float | None : Number of shares.

spend: str | None : Total amount of money spent.

stat_time_hour: str | None : The hour for which the statistical data is recorded (YYYY-MM-DD HH:MM:SS format).

video_play_actions: float | None : Number of video play actions.

video_views_p100: float | None : Number of times video was watched to 100%.

video_views_p25: float | None : Number of times video was watched to 25%.

video_views_p50: float | None : Number of times video was watched to 50%.

video_views_p75: float | None : Number of times video was watched to 75%.

video_watched_2s: float | None : Number of times video was watched for at least 2 seconds.

video_watched_6s: float | None : Number of times video was watched for at least 6 seconds.

AdsReportsLifetimeListResultMeta(**data: Any) : Metadata for ads_reports_lifetime.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdsReportsLifetimeSearchData(**data: Any) : Search result data for ads_reports_lifetime 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

ad_id: int | None : The unique identifier for the ad.

ad_name: str | None : The name of the ad.

ad_text: str | None : The text content of the ad.

adgroup_id: int | None : The unique identifier for the ad group.

adgroup_name: str | None : The name of the ad group.

app_install: float | None : Number of app installations.

average_video_play: float | None : Average video play duration.

average_video_play_per_user: float | None : Average video play duration per user.

campaign_id: int | None : The unique identifier for the campaign.

campaign_name: str | None : The name of the marketing campaign.

clicks: str | None : Number of clicks on the ad.

clicks_on_music_disc: float | None : Number of clicks on the music disc.

comments: float | None : Number of comments.

conversion: str | None : Number of conversions.

conversion_rate: str | None : Rate of conversions.

cost_per_1000_reached: str | None : Cost per 1000 unique users reached.

cost_per_conversion: str | None : Cost per conversion.

cost_per_result: str | None : Cost per result.

cost_per_secondary_goal_result: str | None : Cost per secondary goal result.

cpc: str | None : Cost per click.

cpm: str | None : Cost per thousand impressions.

ctr: str | None : Click-through rate.

follows: float | None : Number of follows.

frequency: str | None : Average number of times each person saw the ad.

impressions: str | None : Number of times the ad was displayed.

likes: float | None : Number of likes.

model_config : The type of the None singleton.

placement_type: str | None : Type of ad placement.

profile_visits: float | None : Number of profile visits.

reach: str | None : Total number of unique users reached.

real_time_app_install: float | None : Real-time app installations.

real_time_app_install_cost: float | None : Cost of real-time app installations.

real_time_conversion: str | None : Real-time conversions.

real_time_conversion_rate: str | None : Real-time conversion rate.

real_time_cost_per_conversion: str | None : Real-time cost per conversion.

real_time_cost_per_result: str | None : Real-time cost per result.

real_time_result: str | None : Real-time results.

real_time_result_rate: str | None : Real-time result rate.

result: str | None : Number of results.

result_rate: str | None : Rate of results.

secondary_goal_result: str | None : Results for secondary goals.

secondary_goal_result_rate: str | None : Rate of secondary goal results.

shares: float | None : Number of shares.

spend: str | None : Total amount of money spent.

video_play_actions: float | None : Number of video play actions.

video_views_p100: float | None : Number of times video was watched to 100%.

video_views_p25: float | None : Number of times video was watched to 25%.

video_views_p50: float | None : Number of times video was watched to 50%.

video_views_p75: float | None : Number of times video was watched to 75%.

video_watched_2s: float | None : Number of times video was watched for at least 2 seconds.

video_watched_6s: float | None : Number of times video was watched for at least 6 seconds.

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

ad_format: str | None : The format of the ad

ad_id: int | None : The unique identifier of the ad

ad_name: str | None : The name of the ad

ad_text: str | None : The text content of the ad

adgroup_id: int | None : The unique identifier of the ad group

adgroup_name: str | None : The name of the ad group

advertiser_id: int | None : The unique identifier of the advertiser

campaign_id: int | None : The unique identifier of the campaign

campaign_name: str | None : The name of the campaign

create_time: str | None : The timestamp when the ad was created

landing_page_url: str | None : The URL of the landing page for the ad

model_config : The type of the None singleton.

modify_time: str | None : The timestamp when the ad was last modified

operation_status: str | None : The operational status of the ad

secondary_status: str | None : The secondary status of the ad

video_id: str | None : The unique identifier of the video

Advertiser(**data: Any) : TikTok advertiser 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

license_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.

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

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

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

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

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

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

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

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

AdvertisersListResultMeta(**data: Any) : Metadata for advertisers.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdvertisersReportDaily(**data: Any) : Daily performance report at the advertiser level

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AdvertisersReportsDailyListResultMeta(**data: Any) : Metadata for advertisers_reports_daily.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AdvertisersReportsDailySearchData(**data: Any) : Search result data for advertisers_reports_daily 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

advertiser_id: int | None : The unique identifier for the advertiser.

app_install: float | None : Number of app installations.

average_video_play: float | None : Average video play duration.

average_video_play_per_user: float | None : Average video play duration per user.

cash_spend: str | None : The amount of money spent in cash.

clicks: str | None : Number of clicks on the ad.

clicks_on_music_disc: float | None : Number of clicks on the music disc.

comments: float | None : Number of comments.

cost_per_1000_reached: str | None : Cost per 1000 unique users reached.

cpc: str | None : Cost per click.

cpm: str | None : Cost per thousand impressions.

ctr: str | None : Click-through rate.

follows: float | None : Number of follows.

frequency: str | None : Average number of times each person saw the ad.

impressions: str | None : Number of times the ad was displayed.

likes: float | None : Number of likes.

model_config : The type of the None singleton.

profile_visits: float | None : Number of profile visits.

reach: str | None : Total number of unique users reached.

real_time_app_install: float | None : Real-time app installations.

real_time_app_install_cost: float | None : Cost of real-time app installations.

shares: float | None : Number of shares.

spend: str | None : Total amount of money spent.

stat_time_day: str | None : The date for which the statistical data is recorded (YYYY-MM-DD HH:MM:SS format).

video_play_actions: float | None : Number of video play actions.

video_views_p100: float | None : Number of times video was watched to 100%.

video_views_p25: float | None : Number of times video was watched to 25%.

video_views_p50: float | None : Number of times video was watched to 50%.

video_views_p75: float | None : Number of times video was watched to 75%.

video_watched_2s: float | None : Number of times video was watched for at least 2 seconds.

video_watched_6s: float | None : Number of times video was watched for at least 6 seconds.

voucher_spend: str | None : Amount spent using vouchers.

AdvertisersSearchData(**data: Any) : Search result data for advertisers 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

address: str | None : The physical address of the advertiser.

advertiser_account_type: str | None : The type of advertiser's account (e.g., individual, business).

advertiser_id: int | None : Unique identifier for the advertiser.

balance: float | None : The current balance in the advertiser's account.

brand: str | None : The brand name associated with the advertiser.

cellphone_number: str | None : The cellphone number of the advertiser.

company: str | None : The name of the company associated with the advertiser.

contacter: str | None : The contact person for the advertiser.

country: str | None : The country where the advertiser is located.

create_time: int | None : The timestamp when the advertiser account was created.

currency: str | None : The currency used for transactions in the account.

description: str | None : A brief description or bio of the advertiser or company.

display_timezone: str | None : The timezone for display purposes.

email: str | None : The email address associated with the advertiser.

industry: str | None : The industry or sector the advertiser operates in.

language: str | None : The preferred language of communication for the advertiser.

license_city: str | None : The city where the advertiser's license is registered.

license_no: str | None : The license number of the advertiser.

license_province: str | None : The province or state where the advertiser's license is registered.

license_url: str | None : The URL link to the advertiser's license documentation.

model_config : The type of the None singleton.

name: str | None : The name of the advertiser or company.

promotion_area: str | None : The specific area or region where the advertiser focuses promotion.

promotion_center_city: str | None : The city at the center of the advertiser's promotion activities.

promotion_center_province: str | None : The province or state at the center of the advertiser's promotion activities.

rejection_reason: str | None : Reason for any advertisement rejection by the platform.

role: str | None : The role or position of the advertiser within the company.

status: str | None : The current status of the advertiser's account.

telephone_number: str | None : The telephone number of the advertiser.

timezone: str | None : The timezone setting for the advertiser's activities.

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.tiktok_marketing.models.AirbyteSearchResult[AdGroupsReportsDailySearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdGroupsSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdsReportsDailySearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdsReportsHourlySearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdsReportsLifetimeSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdsSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdvertisersReportsDailySearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AdvertisersSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[AudiencesSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[CampaignsReportsDailySearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[CampaignsSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[CreativeAssetsImagesSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[CreativeAssetsVideosSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[SparkAdsSearchData]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.AirbyteSearchResult[dict[str, Any]]

Class variables

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

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

model_config : The type of the None singleton.

AirbyteSearchResult[AdGroupsReportsDailySearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdGroupsReportsDailySearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AdGroupsSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdGroupsSearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AdsReportsDailySearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdsReportsDailySearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AdsReportsHourlySearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdsReportsHourlySearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AdsReportsLifetimeSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdsReportsLifetimeSearchResult(**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.tiktok_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.tiktok_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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AdvertisersReportsDailySearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdvertisersReportsDailySearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AdvertisersSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdvertisersSearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[AudiencesSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AudiencesSearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[CampaignsReportsDailySearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CampaignsReportsDailySearchResult(**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.tiktok_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.tiktok_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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[CreativeAssetsImagesSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CreativeAssetsImagesSearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[CreativeAssetsVideosSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CreativeAssetsVideosSearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

AirbyteSearchResult[SparkAdsSearchData](**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SparkAdsSearchResult(**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.tiktok_marketing.models.AirbyteSearchResult
• pydantic.main.BaseModel
• typing.Generic

Audience(**data: Any) : TikTok custom audience

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

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

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

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

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

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

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

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

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

is_valid: 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.

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

AudiencesListResultMeta(**data: Any) : Metadata for audiences.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

AudiencesSearchData(**data: Any) : Search result data for audiences 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

audience_id: str | None : Unique identifier for the audience

audience_type: str | None : Type of audience

cover_num: int | None : Number of audience members covered

create_time: str | None : Timestamp indicating when the audience was created

is_valid: bool | None : Flag indicating if the audience data is valid

model_config : The type of the None singleton.

name: str | None : Name of the audience

shared: bool | None : Flag indicating if the audience is shared

Campaign(**data: Any) : TikTok marketing 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

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

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

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

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

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

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

campaign_automation_type: 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.

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

split_test_variable: str | 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

model_config : The type of the None singleton.

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

CampaignsReportDaily(**data: Any) : Daily performance report at the campaign level

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CampaignsReportsDailyListResultMeta(**data: Any) : Metadata for campaigns_reports_daily.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

CampaignsReportsDailySearchData(**data: Any) : Search result data for campaigns_reports_daily 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

app_install: float | None : Number of app installations.

average_video_play: float | None : Average video play duration.

average_video_play_per_user: float | None : Average video play duration per user.

campaign_id: int | None : The unique identifier for the campaign.

campaign_name: str | None : The name of the marketing campaign.

clicks: str | None : Number of clicks on the ad.

clicks_on_music_disc: float | None : Number of clicks on the music disc.

comments: float | None : Number of comments.

cost_per_1000_reached: str | None : Cost per 1000 unique users reached.

cpc: str | None : Cost per click.

cpm: str | None : Cost per thousand impressions.

ctr: str | None : Click-through rate.

follows: float | None : Number of follows.

frequency: str | None : Average number of times each person saw the ad.

impressions: str | None : Number of times the ad was displayed.

likes: float | None : Number of likes.

model_config : The type of the None singleton.

profile_visits: float | None : Number of profile visits.

reach: str | None : Total number of unique users reached.

real_time_app_install: float | None : Real-time app installations.

real_time_app_install_cost: float | None : Cost of real-time app installations.

shares: float | None : Number of shares.

spend: str | None : Total amount of money spent.

stat_time_day: str | None : The date for which the statistical data is recorded (YYYY-MM-DD HH:MM:SS format).

video_play_actions: float | None : Number of video play actions.

video_views_p100: float | None : Number of times video was watched to 100%.

video_views_p25: float | None : Number of times video was watched to 25%.

video_views_p50: float | None : Number of times video was watched to 50%.

video_views_p75: float | None : Number of times video was watched to 75%.

video_watched_2s: float | None : Number of times video was watched for at least 2 seconds.

video_watched_6s: float | None : Number of times video was watched for at least 6 seconds.

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

advertiser_id: int | None : The unique identifier of the advertiser associated with the campaign

app_promotion_type: str | None : Type of app promotion being used in the campaign

bid_type: str | None : Type of bid strategy being used in the campaign

budget: float | None : Total budget allocated for the campaign

budget_mode: str | None : Mode in which the budget is being managed (e.g., daily, lifetime)

budget_optimize_on: bool | None : The metric or event that the budget optimization is based on

campaign_id: int | None : The unique identifier of the campaign

campaign_name: str | None : Name of the campaign for easy identification

campaign_type: str | None : Type of campaign (e.g., awareness, conversion)

create_time: str | None : Timestamp when the campaign was created

deep_bid_type: str | None : Advanced bid type used for campaign optimization

is_new_structure: bool | None : Flag indicating if the campaign utilizes a new campaign structure

is_search_campaign: bool | None : Flag indicating if the campaign is a search campaign

is_smart_performance_campaign: bool | None : Flag indicating if the campaign uses smart performance optimization

model_config : The type of the None singleton.

modify_time: str | None : Timestamp when the campaign was last modified

objective: str | None : The objective or goal of the campaign

objective_type: str | None : Type of objective selected for the campaign

operation_status: str | None : Current operational status of the campaign

optimization_goal: str | None : Specific goal to be optimized for in the campaign

rf_campaign_type: str | None : Type of RF (reach and frequency) campaign being run

roas_bid: float | None : Return on ad spend goal set for the campaign

secondary_status: str | None : Additional status information of the campaign

split_test_variable: str | None : Variable being tested in a split test campaign

Catalog(**data: Any) : TikTok product catalog

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

CatalogsListResultMeta(**data: Any) : Metadata for catalogs.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

CreativeAssetImage(**data: Any) : TikTok creative asset image

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

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

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

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

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

CreativeAssetVideo(**data: Any) : TikTok creative asset video

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

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

allowed_placements: list[str | None] | None : The type of the None singleton.

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

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

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

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

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

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

flaw_types: list[typing.Any] | None : The type of the None singleton.

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

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

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

model_config : The type of the None singleton.

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

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

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

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

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

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

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

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

CreativeAssetsImagesListResultMeta(**data: Any) : Metadata for creative_assets_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

model_config : The type of the None singleton.

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

CreativeAssetsImagesSearchData(**data: Any) : Search result data for creative_assets_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

create_time: str | None : The timestamp when the image was created.

file_name: str | None : The name of the image file.

format: str | None : The format type of the image file.

height: int | None : The height dimension of the image.

image_id: str | None : The unique identifier for the image.

image_url: str | None : The URL to access the image.

model_config : The type of the None singleton.

modify_time: str | None : The timestamp when the image was last modified.

size: int | None : The size of the image file.

width: int | None : The width dimension of the image.

CreativeAssetsVideosListResultMeta(**data: Any) : Metadata for creative_assets_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

model_config : The type of the None singleton.

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

CreativeAssetsVideosSearchData(**data: Any) : Search result data for creative_assets_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

create_time: str | None : Timestamp when the video was created.

duration: float | None : Duration of the video in seconds.

file_name: str | None : Name of the video file.

format: str | None : Format of the video file.

height: int | None : Height of the video in pixels.

model_config : The type of the None singleton.

modify_time: str | None : Timestamp when the video was last modified.

size: int | None : Size of the video file in bytes.

video_cover_url: str | None : URL for the cover image of the video.

video_id: str | None : ID of the video.

width: int | None : Width of the video in pixels.

SparkAd(**data: Any) : TikTok Spark Ad post authorization

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

auth_info: airbyte_agent_sdk.connectors.tiktok_marketing.models.SparkAdAuthInfo | None : The type of the None singleton.

item_info: airbyte_agent_sdk.connectors.tiktok_marketing.models.SparkAdItemInfo | None : The type of the None singleton.

model_config : The type of the None singleton.

user_info: airbyte_agent_sdk.connectors.tiktok_marketing.models.SparkAdUserInfo | None : The type of the None singleton.

video_info: airbyte_agent_sdk.connectors.tiktok_marketing.models.SparkAdVideoInfo | None : The type of the None singleton.

SparkAdAuthInfo(**data: Any) : Information about the authorization

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_auth_status: str | None : The authorization status (e.g. AUTHORIZED)

auth_end_time: str | None : The time when the authorization code expires (UTC+0)

auth_start_time: str | None : The time when the authorization code becomes valid (UTC+0)

invite_start_time: str | None : The time when the authorization starts (UTC+0)

model_config : The type of the None singleton.

SparkAdItemInfo(**data: Any) : Information about the Spark Ads post

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

auth_code: str | None : The authorization code for the Spark Ads post

item_id: str | None : The ID of the Spark Ads post

item_type: str | None : The type of Spark Ads post (VIDEO or CAROUSEL)

model_config : The type of the None singleton.

status: str | None : Item status (e.g. HESITATE_RECOMMEND)

text: str | None : The description of the Spark Ads post

SparkAdUserInfo(**data: Any) : Information about the TikTok 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

identity_id: str | None : Identity ID

identity_type: str | None : Identity type

model_config : The type of the None singleton.

tiktok_name: str | None : The user name of the TikTok account

SparkAdVideoInfo(**data: Any) : Information about the video post

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

duration: float | None : The duration of the video, in seconds

height: int | None : The height of the video

model_config : The type of the None singleton.

poster_url: str | None : The URL to the video poster

preview_url: str | None : The preview URL for the video

size: int | None : The size of the video, in bytes

width: int | None : The width of the video

SparkAdsListResultMeta(**data: Any) : Metadata for spark_ads.Action.LIST operation

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

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

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

Ancestors (in MRO)

• pydantic.main.BaseModel

Class variables

model_config : The type of the None singleton.

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

SparkAdsSearchData(**data: Any) : Search result data for spark_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

auth_info: dict[str, typing.Any] | None : Authorization details including invite_start_time, auth_start_time, auth_end_time, and ad_auth_status.

item_info: dict[str, typing.Any] | None : Information about the Spark Ads post including item_id, auth_code, text, status, and item_type.

model_config : The type of the None singleton.

user_info: dict[str, typing.Any] | None : Information about the TikTok account including tiktok_name, identity_id, and identity_type.

video_info: dict[str, typing.Any] | None : Video post details including duration, preview_url, poster_url, height, width, and size.

TiktokMarketingAuthConfig(**data: Any) : OAuth 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

access_token: str : Your TikTok Marketing API access token

model_config : The type of the None singleton.

TiktokMarketingCheckResult(**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'.

TiktokMarketingExecuteResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta

Class variables

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

model_config : The type of the None singleton.

TiktokMarketingExecuteResultWithMeta(**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.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Descendants

• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[AdGroup], AdGroupsListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[AdGroupsReportDaily], AdGroupsReportsDailyListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[Ad], AdsListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[AdsReportDaily], AdsReportsDailyListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[AdsReportHourly], AdsReportsHourlyListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[AdsReportLifetime], AdsReportsLifetimeListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[Advertiser], AdvertisersListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[AdvertisersReportDaily], AdvertisersReportsDailyListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[Audience], AudiencesListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[Campaign], CampaignsListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[CampaignsReportDaily], CampaignsReportsDailyListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[Catalog], CatalogsListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[CreativeAssetImage], CreativeAssetsImagesListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[CreativeAssetVideo], CreativeAssetsVideosListResultMeta]
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta[list[SparkAd], SparkAdsListResultMeta]

Class variables

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

TiktokMarketingExecuteResultWithMeta[list[AdGroup], AdGroupsListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdGroupsListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[AdGroupsReportDaily], AdGroupsReportsDailyListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdGroupsReportsDailyListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• 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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[AdsReportDaily], AdsReportsDailyListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdsReportsDailyListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[AdsReportHourly], AdsReportsHourlyListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdsReportsHourlyListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[AdsReportLifetime], AdsReportsLifetimeListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdsReportsLifetimeListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[Advertiser], AdvertisersListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdvertisersListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[AdvertisersReportDaily], AdvertisersReportsDailyListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AdvertisersReportsDailyListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[Audience], AudiencesListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

AudiencesListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• 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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[CampaignsReportDaily], CampaignsReportsDailyListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CampaignsReportsDailyListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[Catalog], CatalogsListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CatalogsListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[CreativeAssetImage], CreativeAssetsImagesListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CreativeAssetsImagesListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[CreativeAssetVideo], CreativeAssetsVideosListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

CreativeAssetsVideosListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingExecuteResultWithMeta[list[SparkAd], SparkAdsListResultMeta](**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

Class variables

model_config : The type of the None singleton.

SparkAdsListResult(**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.tiktok_marketing.models.TiktokMarketingExecuteResultWithMeta
• airbyte_agent_sdk.connectors.tiktok_marketing.models.TiktokMarketingExecuteResult
• pydantic.main.BaseModel
• typing.Generic

TiktokMarketingReplicationConfig(**data: Any) : Replication Configuration - Settings for data replication from TikTok 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

model_config : The type of the None singleton.

start_date: str : The start date in YYYY-MM-DD format. Any data before this date will not be replicated. If not set, defaults to 2016-09-01.