ChatGPT Ads API Ontology Specification

Ontology for the ChatGPT Ads API component schema surface across ad accounts, campaigns, ad groups, ads, targeting, custom audiences, product feeds, lead forms, conversions and insights.

This generated publication specification records the reviewed service-local TypeSpec declarations, source field names, types, constraints, and enum wire values represented by the published RDF and SHACL artifacts.

Models and fields

`AccountIntegrityReviewBody`

TypeSpec name: Chatgptads.AccountIntegrityReviewBody

Wire field	Source type	Presence	Source constraints	Description
`details`	`Chatgptads.AccountIntegrityReviewDetailsBody`	optional	—	Contains details about the account integrity review.
`review`	`Chatgptads.ReviewBody`	required in source	—	Contains the review associated with the account integrity review.

`AccountIntegrityReviewDetailsBody`

TypeSpec name: Chatgptads.AccountIntegrityReviewDetailsBody

Wire field	Source type	Presence	Source constraints	Description
`decision`	`string`	optional	—	Records the decision for the account integrity review.
`reason`	`string`	optional	—	Records the reason associated with the account integrity review decision.
`status_updated_at`	`string`	optional	—	Records when the account integrity review status was updated.

`AdAccountCreationSessionResource`

TypeSpec name: Chatgptads.AdAccountCreationSessionResource

Wire field	Source type	Presence	Source constraints	Description
`expires_in`	`int64`	required in source	—	Indicates how long the ad account creation session remains available.
`url`	`string`	required in source	—	Provides the URL for the ad account creation session.

`AdAccountResource`

TypeSpec name: Chatgptads.AdAccountResource

Wire field	Source type	Presence	Source constraints	Description
`account_integrity_review`	`Chatgptads.AccountIntegrityReviewBody`	optional	—	Contains the account integrity review associated with the ad account.
`currency_code`	`string`	required in source	—	Identifies the currency used by the ad account.
`id`	`string`	required in source	—	Identifies the ad account.
`name`	`string`	required in source	—	Provides the name of the ad account.
`negative_keywords`	`Array<string>`	optional	—	Lists the negative keywords associated with the ad account.
`preview_url`	`string \| null`	required in source	—	Provides the preview URL associated with the ad account.
`review`	`Chatgptads.ReviewBody`	required in source	—	Contains the review associated with the ad account.
`status`	`string`	optional	—	Indicates the status of the ad account.
`timezone`	`string`	required in source	—	Identifies the timezone associated with the ad account.
`url`	`string`	required in source	—	Provides the URL associated with the ad account.

`AdAccountSpendLimitWindowBody`

TypeSpec name: Chatgptads.AdAccountSpendLimitWindowBody

Wire field	Source type	Presence	Source constraints	Description
`amount_micros`	`int64`	required in source	—	Specifies the spend limit amount for the window in micros.
`can_delete`	`boolean`	required in source	—	Indicates whether the ad account spend limit window can be deleted.
`can_edit`	`boolean`	required in source	—	Indicates whether the ad account spend limit window can be edited.
`can_edit_start_date`	`boolean`	required in source	—	Indicates whether the spend limit window start date can be edited.
`end_date`	`string`	required in source	—	Specifies the end date of the ad account spend limit window.
`io_id`	`string \| null`	required in source	—	Identifies the insertion order associated with the spend limit window.
`name`	`string \| null`	required in source	—	Provides the name of the ad account spend limit window.
`spent_micros`	`int64`	optional	—	Records the amount spent against the window in micros.
`start_date`	`string`	required in source	—	Specifies the start date of the ad account spend limit window.
`status`	`string`	required in source	—	Indicates the status of the ad account spend limit window.
`window_id`	`string`	required in source	—	Identifies the ad account spend limit window.

`AdAccountSpendLimitWindowsListResource`

TypeSpec name: Chatgptads.AdAccountSpendLimitWindowsListResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.AdAccountSpendLimitWindowBody>`	required in source	—	Contains the ad account spend limit windows in the response.
`object`	`string`	required in source	—	Identifies the object represented by the spend limit windows response.

`AdAccountsResource`

TypeSpec name: Chatgptads.AdAccountsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.AdAccountResource>`	required in source	—	Contains the ad accounts in the response.
`first_id`	`string \| null`	optional	—	Identifies the first ad account in the response.
`has_more`	`boolean`	optional	—	Indicates whether more ad accounts are available.
`last_id`	`string \| null`	optional	—	Identifies the last ad account in the response.
`object`	`string`	required in source	—	Identifies the object represented by the ad accounts response.

`AdAppealBody`

TypeSpec name: Chatgptads.AdAppealBody

Wire field	Source type	Presence	Source constraints	Description
`requested_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the ad appeal was requested.
`resolved_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the ad appeal was resolved.
`status`	`Chatgptads.AppealStatus`	required in source	—	Indicates the status of the ad appeal.

`AdGroupItemBody`

TypeSpec name: Chatgptads.AdGroupItemBody

Wire field	Source type	Presence	Source constraints	Description
`bidding_config`	`Chatgptads.BiddingConfigBody`	required in source	—	Contains the bidding configuration for the ad group.
`context_hints`	`Array<string>`	required in source	—	Lists the context hints associated with the ad group.
`created_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the ad group was created.
`description`	`string \| null`	required in source	—	Provides the description of the ad group.
`id`	`string`	required in source	—	Identifies the ad group.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationBody \| null`	optional	—	Contains the landing page configuration for the ad group.
`name`	`string`	required in source	—	Provides the name of the ad group.
`product_set`	`Chatgptads.ProductSetBody \| null`	optional	—	Contains the product set associated with the ad group.
`serving_issues`	`Array<Chatgptads.AdGroupServingIssueBody>`	optional	—	Lists the serving issues associated with the ad group.
`status`	`string`	required in source	—	Indicates the status of the ad group.
`updated_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the ad group was last updated.

`AdGroupServingIssueBody`

TypeSpec name: Chatgptads.AdGroupServingIssueBody

Wire field	Source type	Presence	Source constraints	Description
`code`	`Chatgptads.AdGroupServingIssueCode`	required in source	—	Identifies the ad group serving issue.

`AdGroupsResource`

TypeSpec name: Chatgptads.AdGroupsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.AdGroupItemBody>`	required in source	—	Contains the ad groups in the response.
`first_id`	`string \| null`	required in source	—	Identifies the first ad group in the response.
`has_more`	`boolean`	required in source	—	Indicates whether more ad groups are available.
`last_id`	`string \| null`	required in source	—	Identifies the last ad group in the response.
`object`	`string`	required in source	—	Identifies the object represented by the ad groups response.

`AdImageCropBody`

TypeSpec name: Chatgptads.AdImageCropBody

Wire field	Source type	Presence	Source constraints	Description
`height`	`float64`	required in source	—	Crop height as a fraction of the EXIF-oriented source image (0-1).
`width`	`float64`	required in source	—	Crop width as a fraction of the EXIF-oriented source image (0-1).
`x`	`float64`	required in source	—	Horizontal offset as a fraction of the EXIF-oriented source image (0-1).
`y`	`float64`	required in source	—	Vertical offset as a fraction of the EXIF-oriented source image (0-1).

`AdImageCropParams`

Optional normalized square crop for chat_card creatives. Requires file_id and is not supported for product_ad_template creatives.

TypeSpec name: Chatgptads.AdImageCropParams

Wire field	Source type	Presence	Source constraints	Description
`height`	`float64`	required in source	—	Crop height as a fraction of the EXIF-oriented source image (0-1).
`width`	`float64`	required in source	—	Crop width as a fraction of the EXIF-oriented source image (0-1).
`x`	`float64`	required in source	—	Horizontal offset as a fraction of the EXIF-oriented source image (0-1).
`y`	`float64`	required in source	—	Vertical offset as a fraction of the EXIF-oriented source image (0-1).

`AdItemBody`

TypeSpec name: Chatgptads.AdItemBody

Wire field	Source type	Presence	Source constraints	Description
`appeal`	`Chatgptads.AdAppealBody \| null`	optional	—	Contains the appeal associated with the ad.
`created_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the ad was created.
`creative`	`Chatgptads.ConversationalBottomOtmSpecBody`	required in source	—	Contains the creative for the ad.
`id`	`string`	required in source	—	Identifies the ad.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationBody \| null`	optional	—	Contains the landing page configuration for the ad.
`name`	`string`	required in source	—	Provides the name of the ad.
`review`	`Chatgptads.ReviewBody`	required in source	—	Contains the review associated with the ad.
`review_status`	`Chatgptads.ReviewStatus`	required in source	—	Indicates the review status of the ad.
`serving_issues`	`Array<Chatgptads.AdServingIssueBody>`	optional	—	Lists the serving issues associated with the ad.
`status`	`string`	required in source	—	Indicates the status of the ad.
`updated_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the ad was last updated.

`AdPreviewItemBody`

TypeSpec name: Chatgptads.AdPreviewItemBody

Wire field	Source type	Presence	Source constraints	Description
`body`	`string`	required in source	—	Contains the body of the ad preview.

`AdPreviewResource`

TypeSpec name: Chatgptads.AdPreviewResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.AdPreviewItemBody>`	required in source	—	Contains the ad previews in the response.

`AdServingIssueBody`

TypeSpec name: Chatgptads.AdServingIssueBody

Wire field	Source type	Presence	Source constraints	Description
`code`	`Chatgptads.AdServingIssueCode`	required in source	—	Identifies the ad serving issue.

`AdsOAuthMeResource`

TypeSpec name: Chatgptads.AdsOAuthMeResource

Wire field	Source type	Presence	Source constraints	Description
`display_name`	`string \| null`	optional	—	Provides the display name of the authenticated ads account or entity.
`id`	`string`	required in source	—	Identifies the authenticated ads account or entity.

`AdsResource`

TypeSpec name: Chatgptads.AdsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.AdItemBody>`	required in source	—	Contains the ads in the response.
`first_id`	`string \| null`	required in source	—	Identifies the first ad in the response.
`has_more`	`boolean`	required in source	—	Indicates whether more ads are available.
`last_id`	`string \| null`	required in source	—	Identifies the last ad in the response.
`object`	`string`	required in source	—	Identifies the object represented by the ads response.

`ArchivedProductFeedResource`

TypeSpec name: Chatgptads.ArchivedProductFeedResource

Wire field	Source type	Presence	Source constraints	Description
`archived_at`	`string`	required in source	—	Records when the product feed was archived.
`feed_id`	`string`	required in source	—	Identifies the archived product feed.

`BiddingConfigBody`

TypeSpec name: Chatgptads.BiddingConfigBody

Wire field	Source type	Presence	Source constraints	Description
`billing_event_type`	`string`	required in source	—	Specifies the event type used for billing in the bidding configuration.
`custom_audience_bid_multipliers`	`Array<Chatgptads.CustomAudienceBidMultiplierBody>`	optional	—	Lists the bid multipliers for custom audiences.
`max_bid_micros`	`int64`	optional	—	Specifies the maximum bid amount in micros.
`strategy`	`Chatgptads.BiddingStrategyTypeBody`	optional	—	Specifies the bidding strategy.

`BiddingConfigParams`

TypeSpec name: Chatgptads.BiddingConfigParams

Wire field	Source type	Presence	Source constraints	Description
`billing_event_type`	`Chatgptads.BillingEventTypeParam`	required in source	—	Specifies the event type used for billing in the bidding parameters.
`custom_audience_bid_multipliers`	`Array<Chatgptads.CustomAudienceBidMultiplierParams>`	optional	—	Lists the bid multipliers for custom audiences in the bidding parameters.
`max_bid_micros`	`int64`	optional	minValue=1; maxValue=30400000000000	Represents the maximum bid amount in micros.
`strategy`	`Chatgptads.BiddingStrategyTypeParam`	optional	—	Specifies the bidding strategy in the bidding parameters.

`BudgetBody`

TypeSpec name: Chatgptads.BudgetBody

Wire field	Source type	Presence	Source constraints	Description
`daily_spend_limit_micros`	`int64`	optional	—	Specifies the daily spend limit in micros.
`lifetime_spend_limit_micros`	`int64`	optional	—	Specifies the lifetime spend limit in micros.

`BudgetParams`

TypeSpec name: Chatgptads.BudgetParams

Wire field	Source type	Presence	Source constraints	Description
`daily_spend_limit_micros`	`int64`	optional	minValue=1000000	Represents the daily spending limit in micros.
`lifetime_spend_limit_micros`	`int64`	optional	minValue=1000000	Represents the lifetime spending limit in micros.

`BusinessAgentCatalogToolBody`

TypeSpec name: Chatgptads.BusinessAgentCatalogToolBody

Wire field	Source type	Presence	Source constraints	Description
`description`	`string \| null`	required in source	—	Provides the description of the business agent catalog tool.
`id`	`string`	required in source	—	Identifies the business agent catalog tool.
`logo_url`	`string \| null`	required in source	—	Provides the logo URL for the business agent catalog tool.
`name`	`string`	required in source	—	Provides the name of the business agent catalog tool.
`type`	`string`	required in source	—	Specifies the type of the business agent catalog tool.

`BusinessAgentLeadFormSelectionBody`

TypeSpec name: Chatgptads.BusinessAgentLeadFormSelectionBody

Wire field	Source type	Presence	Source constraints	Description
`lead_form_id`	`string`	required in source	—	Identifies the selected lead form.
`lead_form_revision_id`	`string`	required in source	—	Identifies the selected lead form revision.

`BusinessAgentLeadFormSelectionBodyParam`

TypeSpec name: Chatgptads.BusinessAgentLeadFormSelectionBodyParam

Wire field	Source type	Presence	Source constraints	Description
`lead_form_id`	`string`	required in source	minLength=1	Identifies the lead form specified in the selection parameters.
`lead_form_revision_id`	`string`	required in source	minLength=1	Identifies the lead form revision specified in the selection parameters.

`BusinessAgentListItemBody`

TypeSpec name: Chatgptads.BusinessAgentListItemBody

Wire field	Source type	Presence	Source constraints	Description
`conversation_starters`	`Array<string>`	required in source	—	Lists conversation starters for the business agent.
`created_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the business agent was created.
`description`	`string \| null`	required in source	—	Provides a description of the business agent.
`disabled_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the business agent was disabled.
`has_pending_changes`	`boolean`	required in source	—	Indicates whether the business agent has pending changes.
`id`	`string`	required in source	—	Identifies the business agent.
`instructions`	`string`	required in source	—	Provides instructions for the business agent.
`lead_form`	`Chatgptads.BusinessAgentLeadFormSelectionBody`	optional	—	Provides the business agent's lead form selection.
`lead_form_id`	`string`	optional	—	Identifies the lead form associated with the business agent.
`name`	`string`	required in source	—	Identifies the business agent.
`privacy_policy_url`	`string \| null`	optional	—	Provides the URL for the business agent's privacy policy.
`product_feed_ids`	`Array<string>`	required in source	—	Lists product feed identifiers associated with the business agent.
`published_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the business agent was published.
`status`	`string`	required in source	—	Indicates the business agent's status.
`tools`	`Array<string>`	required in source	—	Lists tools associated with the business agent.
`updated_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the business agent was last updated.

`BusinessAgentPreviewMessageBody`

TypeSpec name: Chatgptads.BusinessAgentPreviewMessageBody

Wire field	Source type	Presence	Source constraints	Description
`content`	`string`	required in source	—	Provides the content of the preview message.
`role`	`string`	required in source	—	Identifies the role associated with the preview message.

`BusinessAgentPreviewResource`

TypeSpec name: Chatgptads.BusinessAgentPreviewResource

Wire field	Source type	Presence	Source constraints	Description
`message`	`Chatgptads.BusinessAgentPreviewMessageBody`	required in source	—	Contains the business agent preview message.

`CampaignItemBody`

TypeSpec name: Chatgptads.CampaignItemBody

Wire field	Source type	Presence	Source constraints	Description
`bidding_type`	`string`	required in source	—	Indicates the campaign's bidding type.
`billing_event_type`	`string`	optional	—	Indicates the event type used for campaign billing.
`budget`	`Chatgptads.BudgetBody`	required in source	—	Defines the campaign budget.
`business_agent_id`	`string \| null`	optional	—	Identifies the business agent associated with the campaign.
`conversion_event_setting_ids`	`Array<string>`	optional	—	Lists conversion event setting identifiers associated with the campaign.
`created_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the campaign was created.
`description`	`string \| null`	required in source	—	Provides a description of the campaign.
`end_time`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the campaign ends.
`id`	`string`	required in source	—	Identifies the campaign.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationBody \| null`	optional	—	Defines the campaign's landing page configuration.
`mode`	`string \| null`	optional	—	Indicates the campaign's mode.
`name`	`string`	required in source	—	Identifies the campaign by name.
`objective`	`string`	optional	—	Indicates the campaign's objective.
`product_feed_id`	`string \| null`	required in source	—	Identifies the product feed associated with the campaign.
`serving_issues`	`Array<Chatgptads.CampaignServingIssueBody>`	optional	—	Lists issues associated with serving the campaign.
`start_time`	`Chatgptads.UtcDateTimeAsUnixTimestamp \| null`	required in source	—	Records when the campaign starts.
`status`	`string`	required in source	—	Indicates the campaign's status.
`targeting`	`Chatgptads.TargetingBody`	optional	—	Defines the campaign's targeting configuration.
`updated_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the campaign was last updated.

`CampaignServingIssueBody`

TypeSpec name: Chatgptads.CampaignServingIssueBody

Wire field	Source type	Presence	Source constraints	Description
`code`	`Chatgptads.CampaignServingIssueCode`	required in source	—	Identifies the campaign serving issue.

`CampaignsResource`

TypeSpec name: Chatgptads.CampaignsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.CampaignItemBody>`	required in source	—	Contains the campaigns returned in the response.
`first_id`	`string \| null`	required in source	—	Identifies the first campaign in the response.
`has_more`	`boolean`	required in source	—	Indicates whether more campaigns are available.
`last_id`	`string \| null`	required in source	—	Identifies the last campaign in the response.
`object`	`string`	required in source	—	Identifies the resource object represented by the response.

`ChatgptadsAuth`

ChatGPT Ads bearer authentication. The document states two schemes and accepts either. `ApiKeyAuth` is HTTP bearer, carrying an Ads Manager API key in the Authorization header. `AdsOAuth` is an OAuth 2.0 authorization code flow authorizing at `https://auth.openai.com/api/accounts/authorize` and exchanging at `https://auth.openai.com/api/accounts/oauth/token`, over the scopes `ads.admin.all.read`, `ads.admin.all.write`, `offline_access`, `openid` and `profile`. Both present the resulting credential as a bearer token, which is what this ontology-only contract records; the flow itself is a property of live operations, which this contract does not declare.

TypeSpec name: Chatgptads.ChatgptadsAuth

Wire field	Source type	Presence	Source constraints	Description
`scheme`	`"Bearer"`	required in source	—	bearer auth scheme
`type`	`unknown`	required in source	—	Http authentication

`ClientDataSourceItemResource`

TypeSpec name: Chatgptads.ClientDataSourceItemResource

Wire field	Source type	Presence	Source constraints	Description
`client_type`	`string`	required in source	—	Indicates the client data source type.
`id`	`string`	required in source	—	Identifies the client data source.
`name`	`string`	required in source	—	Identifies the client data source by name.
`pixel_id`	`string`	required in source	—	Identifies the pixel associated with the client data source.

`ConversationalBottomOtmSpecBody`

TypeSpec name: Chatgptads.ConversationalBottomOtmSpecBody

Wire field	Source type	Presence	Source constraints	Description
`body`	`string`	required in source	—	Provides the body content of the conversational bottom specification.
`file_id`	`string`	optional	—	Identifies the file associated with the conversational bottom specification.
`image_crop`	`Chatgptads.AdImageCropBody`	optional	—	Normalized square crop for a chat_card creative, when present.
`image_url`	`string \| null`	optional	—	Provides the image URL associated with the conversational bottom specification.
`price`	`string`	optional	—	Provides the price associated with the conversational bottom specification.
`target_url`	`string \| null`	required in source	—	Provides the target URL for the conversational bottom specification.
`title`	`string`	required in source	—	Provides the title of the conversational bottom specification.
`type`	`Chatgptads.AdSpecType`	required in source	—	Indicates the ad specification type.

`ConversionApiKeyResource`

TypeSpec name: Chatgptads.ConversionApiKeyResource

Wire field	Source type	Presence	Source constraints	Description
`api_key`	`string`	required in source	—	Provides the conversion API key.
`name`	`string`	required in source	—	Identifies the conversion API key by name.

`ConversionEventBody`

TypeSpec name: Chatgptads.ConversionEventBody

Wire field	Source type	Presence	Source constraints	Description
`action_source`	`string \| null`	required in source	—	Indicates the source of the action associated with the conversion event.
`api_channel`	`string`	required in source	—	Indicates the API channel for the conversion event.
`custom_event_name`	`string \| null`	required in source	—	Provides the custom name of the conversion event.
`data_source_id`	`string`	required in source	—	Identifies the data source for the conversion event.
`event_data_json`	`string`	required in source	—	Provides the conversion event data in JSON form.
`event_timestamp_ms`	`int64`	required in source	—	Advertiser event time as Unix epoch milliseconds.
`event_type`	`string`	required in source	—	Indicates the conversion event type.
`received_at_ms`	`int64`	required in source	—	Wadi receive time as Unix epoch milliseconds.

`ConversionEventSettingCampaignBody`

TypeSpec name: Chatgptads.ConversionEventSettingCampaignBody

Wire field	Source type	Presence	Source constraints	Description
`id`	`string`	required in source	—	Identifies the campaign associated with the conversion event setting.
`name`	`string`	required in source	—	Identifies the associated campaign by name.

`ConversionEventSettingItemResource`

TypeSpec name: Chatgptads.ConversionEventSettingItemResource

Wire field	Source type	Presence	Source constraints	Description
`ad_account_id`	`string`	required in source	—	Identifies the ad account associated with the conversion event setting.
`archived`	`boolean`	required in source	—	Indicates whether the conversion event setting is archived.
`attribution_window_days`	`int64`	required in source	—	Specifies the attribution window in days for the conversion event setting.
`campaigns`	`Array<Chatgptads.ConversionEventSettingCampaignBody>`	required in source	—	Lists the campaigns associated with the conversion event setting.
`custom_event_name`	`string \| null`	required in source	—	Provides the custom event name configured for the conversion event setting.
`event_type`	`string`	required in source	—	Indicates the event type configured for the conversion event setting.
`id`	`string`	required in source	—	Identifies the conversion event setting.
`name`	`string`	required in source	—	Identifies the conversion event setting by name.
`source_ids`	`Array<string>`	required in source	—	Lists the identifiers of sources associated with the conversion event setting.
`sources`	`Array<Chatgptads.ConversionEventSettingSourceBody>`	required in source	—	Lists the sources associated with the conversion event setting.
`version`	`int64`	required in source	—	Identifies the version of the conversion event setting.

`ConversionEventSettingSourceBody`

TypeSpec name: Chatgptads.ConversionEventSettingSourceBody

Wire field	Source type	Presence	Source constraints	Description
`id`	`string`	required in source	—	Identifies the conversion event setting source.
`name`	`string \| null`	required in source	—	Identifies the conversion event setting source by name.

`ConversionEventsResource`

TypeSpec name: Chatgptads.ConversionEventsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.ConversionEventBody>`	required in source	—	Contains the conversion events returned in the response.
`object`	`string`	required in source	—	Identifies the resource object represented by the response.

`ConversionSummaryRowBody`

TypeSpec name: Chatgptads.ConversionSummaryRowBody

Wire field	Source type	Presence	Source constraints	Description
`click_through_conversions`	`int64`	optional	—	Reports the click-through conversions represented by the summary row.
`conversions`	`int64`	required in source	—	Reports the conversions represented by the summary row.
`country`	`string`	optional	—	Identifies the country represented by the conversion summary row.
`date`	`string`	optional	—	Specifies the date represented by the conversion summary row.
`device`	`string`	optional	—	Identifies the device represented by the conversion summary row.
`entity_id`	`string`	required in source	—	Identifies the entity represented by the conversion summary row.
`view_through_conversions`	`int64`	optional	—	Reports the view-through conversions represented by the summary row.

`ConversionSummaryRowsResource`

TypeSpec name: Chatgptads.ConversionSummaryRowsResource

Wire field	Source type	Presence	Source constraints	Description
`count`	`int64`	required in source	—	Reports the number of conversion summary rows.
`data`	`Array<Chatgptads.ConversionSummaryRowBody>`	required in source	—	Contains the conversion summary rows returned in the response.
`object`	`string`	required in source	—	Identifies the resource object represented by the response.

`CreateAdAccountCreationSessionBody`

TypeSpec name: Chatgptads.CreateAdAccountCreationSessionBody

Wire field	Source type	Presence	Source constraints	Description
`return_uri`	`string`	required in source	minLength=1; maxLength=2048	Specifies the URI to return to for the ad account creation session.
`state`	`string`	required in source	minLength=1; maxLength=512	Provides the state associated with the ad account creation session.

`CreateAdAccountSpendLimitWindowBody`

TypeSpec name: Chatgptads.CreateAdAccountSpendLimitWindowBody

Wire field	Source type	Presence	Source constraints	Description
`amount_micros`	`int64`	required in source	minValue=0	Represents the amount for an ad account spend limit window in micros.
`end_date`	`string`	required in source	minLength=10; maxLength=10	Specifies the end date of the ad account spend limit window.
`io_id`	`string`	optional	maxLength=256	Identifies the IO associated with the ad account spend limit window.
`name`	`string`	optional	maxLength=256	Provides a name for the ad account spend limit window.
`start_date`	`string`	required in source	minLength=10; maxLength=10	Specifies the start date of the ad account spend limit window.

`CreateAdBody`

TypeSpec name: Chatgptads.CreateAdBody

Wire field	Source type	Presence	Source constraints	Description
`ad_group_id`	`string`	required in source	—	Identifies the ad group for the ad.
`creative`	`Chatgptads.CreateAdCreativeParams`	required in source	—	Defines the creative for the ad.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationParams`	optional	—	Specifies the landing page configuration for the ad.
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Identifies the ad by name.
`status`	`Chatgptads.ActivePausedStatusParam`	required in source	—	Specifies the ad's active or paused status.

`CreateAdCreativeParams`

TypeSpec name: Chatgptads.CreateAdCreativeParams

Wire field	Source type	Presence	Source constraints	Description
`body`	`string`	required in source	maxLength=100	Provides the body text of the ad creative.
`file_id`	`string`	optional	—	Identifies the file associated with the ad creative.
`image_crop`	`Chatgptads.AdImageCropParams`	optional	—	Optional normalized square crop for chat_card creatives. Requires file_id and is not supported for product_ad_template creatives.
`price`	`string`	optional	maxLength=100	Provides the price associated with the ad creative.
`target_url`	`string`	optional	maxLength=2048	Specifies the URL targeted by the ad creative.
`title`	`string`	required in source	minLength=3; maxLength=50; pattern=^.\S.$	Provides the title of the ad creative.
`type`	`Chatgptads.AdCreativeTypeParam`	required in source	—	Specifies the type of ad creative.

`CreateAdGroupBody`

TypeSpec name: Chatgptads.CreateAdGroupBody

Wire field	Source type	Presence	Source constraints	Description
`bidding_config`	`Chatgptads.BiddingConfigParams`	required in source	—	Specifies the bidding configuration for the ad group.
`campaign_id`	`string`	required in source	—	Identifies the campaign containing the ad group.
`context_hints`	`Array<string>`	optional	maxItems=2000	Provides context hints for the ad group.
`description`	`string`	optional	—	Provides a description of the ad group.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationParams`	optional	—	Specifies the landing page configuration for the ad group.
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Provides the name of the ad group.
`product_set`	`Chatgptads.ProductSetParams \| null`	optional	—	Specifies the product set associated with the ad group.
`status`	`Chatgptads.ActivePausedStatusParam`	required in source	—	Specifies whether the ad group is active or paused.

`CreateApiKeyBody`

TypeSpec name: Chatgptads.CreateApiKeyBody

Wire field	Source type	Presence	Source constraints	Description
`key_name`	`string`	optional	minLength=1	Provides a name for the API key.

`CreateApiKeyResource`

TypeSpec name: Chatgptads.CreateApiKeyResource

Wire field	Source type	Presence	Source constraints	Description
`api_key`	`string`	required in source	—	Provides the API key.
`api_organization_id`	`string`	required in source	—	Identifies the API organization associated with the API key resource.
`service_account_id`	`string`	required in source	—	Identifies the service account associated with the API key resource.

`CreateBusinessAgentBody`

TypeSpec name: Chatgptads.CreateBusinessAgentBody

Wire field	Source type	Presence	Source constraints	Description
`connector_ids`	`Array<string>`	optional	maxItems=50	Identifies the connectors associated with the business agent.
`conversation_starters`	`Array<string>`	optional	maxItems=12	Provides suggested conversation starters for the business agent.
`description`	`string`	optional	minLength=1; maxLength=300	Provides a description of the business agent.
`instructions`	`string`	required in source	minLength=1; maxLength=4000	Provides instructions for the business agent.
`lead_form`	`Chatgptads.BusinessAgentLeadFormSelectionBodyParam \| null`	optional	—	Specifies the lead form selection for the business agent.
`name`	`string`	required in source	minLength=1; maxLength=50	Provides the name of the business agent.
`privacy_policy_url`	`string \| null`	optional	minLength=1; maxLength=2048	Specifies the URL of the business agent's privacy policy.
`product_feed_ids`	`Array<string>`	optional	maxItems=50	Identifies the product feeds associated with the business agent.
`tools`	`Array<string>`	optional	maxItems=50	Specifies the tools associated with the business agent.

`CreateCampaignBody`

TypeSpec name: Chatgptads.CreateCampaignBody

Wire field	Source type	Presence	Source constraints	Description
`bidding_type`	`Chatgptads.CampaignBiddingTypeParam`	optional	—	Specifies the bidding type for the campaign.
`billing_event_type`	`Chatgptads.CampaignBillingEventTypeParam`	optional	—	Specifies the billing event type for the campaign.
`budget`	`Chatgptads.BudgetParams`	required in source	—	Specifies the budget for the campaign.
`business_agent_id`	`string`	optional	—	Identifies the business agent associated with the campaign.
`conversion_event_setting_ids`	`Array<string>`	optional	—	Identifies the conversion event settings associated with the campaign.
`description`	`string`	optional	—	Provides a description of the campaign.
`end_time`	`int64`	optional	minValue=946684800; maxValue=4102444800	Specifies when the campaign ends.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationParams`	optional	—	Specifies the landing page configuration for the campaign.
`mode`	`Chatgptads.CampaignModeParam`	optional	—	Specifies the mode of the campaign.
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Provides the name of the campaign.
`objective`	`Chatgptads.CampaignObjectiveParam`	optional	—	Specifies the objective of the campaign.
`product_feed_id`	`string`	optional	—	Identifies the product feed associated with the campaign.
`start_time`	`int64`	optional	minValue=946684800; maxValue=4102444800	Specifies when the campaign starts.
`status`	`Chatgptads.ActivePausedStatusParam`	required in source	—	Specifies whether the campaign is active or paused.
`targeting`	`Chatgptads.TargetingParams \| null`	optional	—	Specifies the targeting configuration for the campaign.

`CreateConversionApiKeyBody`

TypeSpec name: Chatgptads.CreateConversionApiKeyBody

Wire field	Source type	Presence	Source constraints	Description
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Provides the name of the conversion API key.

`CreateConversionEventSettingBody`

TypeSpec name: Chatgptads.CreateConversionEventSettingBody

Wire field	Source type	Presence	Source constraints	Description
`attribution_window_days`	`int64`	required in source	—	Specifies the attribution window for the conversion event setting in days.
`custom_event_name`	`string`	optional	minLength=1	Provides the name of the custom conversion event.
`event_type`	`string`	required in source	minLength=1	Specifies the type of conversion event.
`name`	`string`	required in source	minLength=1	Provides the name of the conversion event setting.
`source_ids`	`Array<string>`	required in source	minItems=1	Identifies the conversion sources associated with the event setting.

`CreateConversionSourceBody`

TypeSpec name: Chatgptads.CreateConversionSourceBody

Wire field	Source type	Presence	Source constraints	Description
`client_type`	`Chatgptads.ClientDataSourceTypeParam`	required in source	—	Specifies the client type of the conversion source.
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Provides the name of the conversion source.

`CreateCustomAudienceBody`

TypeSpec name: Chatgptads.CreateCustomAudienceBody

Wire field	Source type	Presence	Source constraints	Description
`description`	`string`	optional	—	Provides a description of the custom audience.
`file_id`	`string`	optional	—	Uploaded file ID. Omit all file fields to create an empty audience when small audiences are enabled for the account.
`filename`	`string`	optional	minLength=1; maxLength=255	Provides the name of the file associated with the custom audience.
`file_size`	`int64`	optional	minValue=1; maxValue=500000000	Specifies the size of the file associated with the custom audience.
`identifier_resolution`	`Chatgptads.CustomAudienceIdentifierResolutionParam`	optional	—	Specifies the identifier resolution used by the custom audience.
`identifier_type`	`Chatgptads.CustomAudienceIdentifierTypeParam`	optional	—	Specifies the identifier type used by the custom audience.
`mimetype`	`string`	optional	minLength=1; maxLength=255	Specifies the media type of the file associated with the custom audience.
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Provides the name of the custom audience.

`CreatedLeadSyncSubscriptionResource`

TypeSpec name: Chatgptads.CreatedLeadSyncSubscriptionResource

Wire field	Source type	Presence	Source constraints	Description
`object`	`string`	required in source	—	Specifies the object designation of the created lead synchronization subscription.
`signing_secret`	`string`	required in source	—	Provides the signing secret for the created lead synchronization subscription.
`status`	`string`	required in source	—	Specifies the status of the created lead synchronization subscription.
`subscription_id`	`string`	required in source	—	Identifies the created lead synchronization subscription.

`CreateLeadFormBody`

TypeSpec name: Chatgptads.CreateLeadFormBody

Wire field	Source type	Presence	Source constraints	Description
`fields`	`Array<Chatgptads.CreateLeadFormFieldBodyParam>`	required in source	minItems=3; maxItems=5	Specifies the fields included in the lead form.
`name`	`string`	required in source	minLength=1; maxLength=256	Provides the name of the lead form.
`privacy_policy_url`	`string`	optional	—	Specifies the URL of the lead form's privacy policy.

`CreateLeadFormFieldBodyParam`

TypeSpec name: Chatgptads.CreateLeadFormFieldBodyParam

Wire field	Source type	Presence	Source constraints	Description
`field_id`	`string`	optional	minLength=1; maxLength=128	Identifies the lead form field.
`field_type`	`Chatgptads.PublicLeadFormFieldTypeParam`	required in source	—	Specifies the type of the lead form field.
`label`	`string`	required in source	minLength=1; maxLength=256	Provides the label displayed for the lead form field.
`options`	`Array<Chatgptads.CreateLeadFormOptionBodyParam>`	optional	maxItems=100	Specifies the options available for the lead form field.
`required`	`boolean`	required in source	—	Specifies whether the lead form field is required.

`CreateLeadFormOptionBodyParam`

TypeSpec name: Chatgptads.CreateLeadFormOptionBodyParam

Wire field	Source type	Presence	Source constraints	Description
`id`	`string`	required in source	minLength=1; maxLength=128	Identifies the lead form option.
`label`	`string`	required in source	minLength=1; maxLength=256	Provides the label for the lead form option.

`CreateLeadSyncSubscriptionBody`

TypeSpec name: Chatgptads.CreateLeadSyncSubscriptionBody

Wire field	Source type	Presence	Source constraints	Description
`ad_account_id`	`string`	required in source	minLength=1	Identifies the ad account for the lead synchronization subscription.
`destination_url`	`string`	required in source	minLength=1; maxLength=2048; pattern=^https://	Specifies the destination URL for the lead synchronization subscription.
`signing_secret`	`string`	optional	minLength=50; maxLength=50; pattern=^whsec_[A-Za-z0-9+/]{42}[AEIMQUYcgkosw048]=$	Provides the signing secret for the lead synchronization subscription.

`CreatePartnerDataUploadBody`

TypeSpec name: Chatgptads.CreatePartnerDataUploadBody

Wire field	Source type	Presence	Source constraints	Description
`data_type`	`Chatgptads.PartnerDataTypeParam`	required in source	—	Specifies the type of partner data being uploaded.
`file_name`	`string`	required in source	minLength=1; maxLength=200; pattern=^[A-Za-z0-9][A-Za-z0-9._-]*\.parquet$	Provides the name of the partner data file.
`file_size_bytes`	`int64`	required in source	minValue=1; maxValue=107374182400	Specifies the size of the partner data file in bytes.
`sha256`	`string`	required in source	pattern=^[0-9a-f]{64}$	Provides the SHA-256 value for the partner data file.
`snapshot_date`	`string`	required in source	minLength=10; maxLength=10; pattern=^\d{4}-\d{2}-\d{2}$	Specifies the date of the partner data snapshot.

`CreatePartnerDataUploadResource`

TypeSpec name: Chatgptads.CreatePartnerDataUploadResource

Wire field	Source type	Presence	Source constraints	Description
`completed_at`	`string \| null`	required in source	—	Specifies when the partner data upload was completed.
`created_at`	`string`	required in source	—	Specifies when the partner data upload was created.
`data_type`	`string`	required in source	—	Specifies the type of partner data being uploaded.
`file_name`	`string`	required in source	—	Provides the name of the partner data file.
`file_size_bytes`	`int64`	required in source	—	Specifies the size of the partner data file in bytes.
`sha256`	`string`	required in source	—	Provides the SHA-256 value for the partner data file.
`snapshot_date`	`string`	required in source	—	Specifies the date of the partner data snapshot.
`status`	`string`	required in source	—	Specifies the status of the partner data upload.
`upload_headers`	`Record<string, string>`	required in source	—	Provides the headers used for the partner data upload.
`upload_id`	`string`	required in source	—	Identifies the partner data upload.
`upload_method`	`string`	required in source	—	Specifies the method used for the partner data upload.
`upload_url`	`string`	required in source	—	Specifies the URL used for the partner data upload.
`upload_url_expires_at`	`string`	required in source	—	Specifies when the partner data upload URL expires.

`CreateProductFeedBody`

TypeSpec name: Chatgptads.CreateProductFeedBody

Wire field	Source type	Presence	Source constraints	Description
`countries`	`Array<string>`	optional	—	Specifies the countries associated with the product feed.
`name`	`string`	required in source	maxLength=255	Provides the name of the product feed.

`CreateTestLeadSubmissionBody`

TypeSpec name: Chatgptads.CreateTestLeadSubmissionBody

Wire field	Source type	Presence	Source constraints	Description
`expected_published_revision_id`	`string`	required in source	minLength=1	Identifies the published revision expected for the test lead submission.

`CustomAudienceBidMultiplierBody`

TypeSpec name: Chatgptads.CustomAudienceBidMultiplierBody

Wire field	Source type	Presence	Source constraints	Description
`bid_multiplier_micros`	`int64`	required in source	—	Specifies the bid multiplier for the custom audience in micros.
`custom_audience_id`	`string`	required in source	—	Identifies the custom audience for the bid multiplier.

`CustomAudienceBidMultiplierParams`

TypeSpec name: Chatgptads.CustomAudienceBidMultiplierParams

Wire field	Source type	Presence	Source constraints	Description
`bid_multiplier_micros`	`int64`	required in source	minValue=100000; maxValue=10000000	Represents the custom-audience bid multiplier in micros.
`custom_audience_id`	`string`	required in source	—	Identifies the custom audience for the bid multiplier.

`CustomAudienceInlineIdentifierParams`

TypeSpec name: Chatgptads.CustomAudienceInlineIdentifierParams

Wire field	Source type	Presence	Source constraints	Description
`identifier`	`string`	required in source	minLength=1	Provides the identifier used for the custom audience.
`identifier_type`	`Chatgptads.CustomAudienceIdentifierTypeParam`	required in source	—	Identifies the type of identifier supplied for the custom audience.

`CustomAudienceItemBody`

TypeSpec name: Chatgptads.CustomAudienceItemBody

Wire field	Source type	Presence	Source constraints	Description
`created_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the custom audience was created.
`description`	`string \| null`	required in source	—	Provides a description of the custom audience.
`hash_spec_version`	`string`	required in source	—	Identifies the hash specification version associated with the custom audience.
`id`	`string`	required in source	—	Identifies the custom audience.
`invalid_identifier_count_range`	`string`	required in source	—	Reports the range containing the number of invalid identifiers.
`matched_identifier_count_range`	`string`	required in source	—	Reports the range containing the number of uploaded identifiers that matched.
`matched_user_count_range`	`string`	required in source	—	Reports the range containing the number of matched users.
`membership_revision`	`int64`	optional	—	Identifies the revision of the custom audience membership.
`name`	`string`	required in source	—	Provides the name of the custom audience.
`status`	`string`	required in source	—	Reports the current status of the custom audience.
`updated_at`	`Chatgptads.UtcDateTimeAsUnixTimestamp`	required in source	—	Records when the custom audience was last updated.
`uploaded_identifier_count_range`	`string`	required in source	—	Reports the range containing the number of identifiers uploaded to the custom audience.

`CustomAudienceMembershipMutationBody`

TypeSpec name: Chatgptads.CustomAudienceMembershipMutationBody

Wire field	Source type	Presence	Source constraints	Description
`expected_revision`	`int64`	optional	minValue=0	Specifies the membership revision expected for the mutation.
`file_id`	`string`	optional	—	Identifies the file associated with the membership mutation.
`identifier_resolution`	`Chatgptads.CustomAudienceIdentifierResolutionParam`	optional	—	Specifies how identifiers in the membership mutation are resolved.
`identifiers`	`Array<Chatgptads.CustomAudienceInlineIdentifierParams>`	optional	—	Provides the identifiers included in the membership mutation.
`identifier_type`	`Chatgptads.CustomAudienceIdentifierTypeParam`	optional	—	Identifies the type of identifiers used in the membership mutation.

`CustomAudienceMembershipOperationBody`

TypeSpec name: Chatgptads.CustomAudienceMembershipOperationBody

Wire field	Source type	Presence	Source constraints	Description
`custom_audience_id`	`string`	required in source	—	Identifies the custom audience targeted by the membership operation.
`operation`	`string`	required in source	—	Reports the operation performed on custom audience membership.
`operation_id`	`string`	required in source	—	Identifies the custom audience membership operation.
`status`	`string`	required in source	—	Reports the status of the custom audience membership operation.

`CustomAudiencesResource`

TypeSpec name: Chatgptads.CustomAudiencesResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.CustomAudienceItemBody>`	required in source	—	Contains the custom audiences returned in the response.
`first_id`	`string \| null`	required in source	—	Identifies the first custom audience in the returned results.
`has_more`	`boolean`	required in source	—	Indicates whether more custom audiences are available beyond the returned results.
`last_id`	`string \| null`	required in source	—	Identifies the last custom audience in the returned results.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the custom audiences response.
`policy_revision`	`string`	optional	—	Identifies the policy revision associated with the custom audiences response.

`DeleteAdAccountSpendLimitWindowResource`

TypeSpec name: Chatgptads.DeleteAdAccountSpendLimitWindowResource

Wire field	Source type	Presence	Source constraints	Description
`deleted`	`boolean`	required in source	—	Indicates whether the spend limit window was deleted.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the deleted spend limit window.
`window_id`	`string`	required in source	—	Identifies the ad account spend limit window.

`DeletedLeadSyncSubscriptionResource`

TypeSpec name: Chatgptads.DeletedLeadSyncSubscriptionResource

Wire field	Source type	Presence	Source constraints	Description
`deleted`	`boolean`	required in source	—	Indicates whether the lead synchronization subscription was deleted.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the deleted lead synchronization subscription.
`status`	`string`	required in source	—	Reports the status of the deleted lead synchronization subscription.
`subscription_id`	`string`	required in source	—	Identifies the deleted lead synchronization subscription.

`GeoLookupEntry`

TypeSpec name: Chatgptads.GeoLookupEntry

Wire field	Source type	Presence	Source constraints	Description
`canonical_name`	`string`	required in source	—	Provides the canonical name of the geographic lookup entry.
`country_code`	`string`	required in source	—	Provides the country code for the geographic lookup entry.
`id`	`string`	required in source	—	Identifies the geographic lookup entry.
`name`	`string`	required in source	—	Provides the name of the geographic lookup entry.
`parent_country`	`string \| null`	required in source	—	Provides the country of the parent geographic entry.
`parent_id`	`string \| null`	required in source	—	Identifies the parent geographic entry.
`region_code`	`string \| null`	required in source	—	Provides the region code for the geographic lookup entry.
`type`	`string`	required in source	—	Identifies the type of geographic lookup entry.

`GeoLookupSearchResource`

TypeSpec name: Chatgptads.GeoLookupSearchResource

Wire field	Source type	Presence	Source constraints	Description
`count`	`int64`	required in source	—	Reports the number of geographic lookup results.
`query`	`string`	required in source	—	Provides the query used for the geographic lookup search.
`results`	`Array<Chatgptads.GeoLookupEntry>`	required in source	—	Contains the geographic entries matching the lookup search.

`InsightItemBody`

TypeSpec name: Chatgptads.InsightItemBody

Wire field	Source type	Presence	Source constraints	Description
`ad_account_budget_daily`	`float64 \| null`	optional	—	Represents the daily budget of the associated ad account.
`ad_account_budget_lifetime`	`float64 \| null`	optional	—	Represents the lifetime budget of the associated ad account.
`ad_account_clicks`	`int64`	optional	—	Reports clicks attributed to the ad account.
`ad_account_cpc`	`float64`	optional	—	Reports the ad account cost per click.
`ad_account_cpm`	`float64`	optional	—	Reports the ad account cost per thousand impressions.
`ad_account_ctr`	`float64`	optional	—	Reports the ad account click-through rate.
`ad_account_id`	`string \| null`	optional	—	Identifies the ad account associated with the insight item.
`ad_account_impressions`	`int64`	optional	—	Reports impressions attributed to the ad account.
`ad_account_name`	`string \| null`	optional	—	Represents the name of the ad account associated with the insight item.
`ad_account_spend`	`float64`	optional	—	Reports spend attributed to the ad account.
`ad_account_url`	`string \| null`	optional	—	Represents the URL of the ad account associated with the insight item.
`ad_clicks`	`int64`	optional	—	Reports clicks attributed to the ad.
`ad_copy`	`string \| null`	optional	—	Represents the copy of the associated ad.
`ad_cpc`	`float64`	optional	—	Reports the ad cost per click.
`ad_cpm`	`float64`	optional	—	Reports the ad cost per thousand impressions.
`ad_ctr`	`float64`	optional	—	Reports the ad click-through rate.
`ad_group_clicks`	`int64`	optional	—	Reports clicks attributed to the ad group.
`ad_group_cpc`	`float64`	optional	—	Reports the ad group cost per click.
`ad_group_cpm`	`float64`	optional	—	Reports the ad group cost per thousand impressions.
`ad_group_ctr`	`float64`	optional	—	Reports the ad group click-through rate.
`ad_group_description`	`string \| null`	optional	—	Represents the description of the associated ad group.
`ad_group_id`	`string \| null`	optional	—	Identifies the ad group associated with the insight item.
`ad_group_impressions`	`int64`	optional	—	Reports impressions attributed to the ad group.
`ad_group_name`	`string \| null`	optional	—	Represents the name of the associated ad group.
`ad_group_spend`	`float64`	optional	—	Reports spend attributed to the ad group.
`ad_group_status`	`string \| null`	optional	—	Represents the status of the associated ad group.
`ad_id`	`string \| null`	optional	—	Identifies the ad associated with the insight item.
`ad_impressions`	`int64`	optional	—	Reports impressions attributed to the ad.
`ad_link`	`string \| null`	optional	—	Represents the link of the associated ad.
`ad_name`	`string \| null`	optional	—	Represents the name of the associated ad.
`ad_review_status`	`string \| null`	optional	—	Represents the review status of the associated ad.
`ad_spend`	`float64`	optional	—	Reports spend attributed to the ad.
`ad_status`	`string \| null`	optional	—	Represents the status of the associated ad.
`ad_title`	`string \| null`	optional	—	Represents the title of the associated ad.
`attributed_sales_amount`	`float64 \| null`	optional	—	Deprecated. Total value of attributed `order_created` and `subscription_created` events, normalized to the ad account currency. Negative event values are treated as zero. Returns 0 when there are no attributed events and null when at least one attributed event does not have a value that can be normalized to the ad account currency. Rounded to two decimal places. Use `order_created_attributed_sales` instead. Scheduled for removal on August 17, 2026.
`attributed_sales_count`	`int64`	optional	—	Deprecated. Number of attributed `order_created` and `subscription_created` events, including events without a reportable value. This field has no replacement. Scheduled for removal on August 17, 2026.
`attributed_sales_currency`	`string`	optional	—	Deprecated. ISO 4217 currency code for `attributed_sales_amount`. This is the ad account currency and is returned even when `attributed_sales_amount` is null. Use `order_created_attributed_sales_currency` instead. Scheduled for removal on August 17, 2026.
`campaign_budget_daily`	`float64 \| null`	optional	—	Represents the daily budget of the associated campaign.
`campaign_budget_lifetime`	`float64 \| null`	optional	—	Represents the lifetime budget of the associated campaign.
`campaign_clicks`	`int64`	optional	—	Reports clicks attributed to the campaign.
`campaign_cpc`	`float64`	optional	—	Reports the campaign cost per click.
`campaign_cpm`	`float64`	optional	—	Reports the campaign cost per thousand impressions.
`campaign_ctr`	`float64`	optional	—	Reports the campaign click-through rate.
`campaign_description`	`string \| null`	optional	—	Represents the description of the associated campaign.
`campaign_end_time`	`string \| null`	optional	—	Represents the end time of the associated campaign.
`campaign_id`	`string \| null`	optional	—	Identifies the campaign associated with the insight item.
`campaign_impressions`	`int64`	optional	—	Reports impressions attributed to the campaign.
`campaign_name`	`string \| null`	optional	—	Represents the name of the associated campaign.
`campaign_spend`	`float64`	optional	—	Reports spend attributed to the campaign.
`campaign_start_time`	`string \| null`	optional	—	Represents the start time of the associated campaign.
`campaign_status`	`string \| null`	optional	—	Represents the status of the associated campaign.
`carousel_product_card_clicks`	`int64`	optional	—	Number of carousel product-card click actions observed for this product. This is distinct from the ad click metric. Returned only when explicitly requested and available for the requested range.
`carousel_product_card_impressions`	`int64`	optional	—	Number of carousel product-card impression actions observed for this product. This is not a billable ad impression. Returned only when explicitly requested and available for the requested range.
`clicks`	`int64`	optional	—	Counts occurrences of a click.
`conversions`	`int64`	optional	—	Represents the number of conversions.
`country_clicks`	`int64`	optional	—	Reports clicks attributed to the country.
`country_cpc`	`float64`	optional	—	Reports the country cost per click.
`country_cpm`	`float64`	optional	—	Reports the country cost per thousand impressions.
`country_ctr`	`float64`	optional	—	Reports the country click-through rate.
`country_impressions`	`int64`	optional	—	Reports impressions attributed to the country.
`country_name`	`string \| null`	optional	—	Represents the country associated with the insight item.
`country_spend`	`float64`	optional	—	Reports spend attributed to the country.
`cpa`	`float64 \| null`	optional	—	Represents the insight item's cost per acquisition, with no scale specified.
`cpc`	`float64`	optional	—	Represents the insight item's cost per click, with no scale specified.
`cpm`	`float64`	optional	—	Represents the insight item's cost per thousand impressions, with no scale specified.
`ctr`	`float64`	optional	—	Reports the click-through rate, with its numerical encoding not specified.
`data_status`	`string`	optional	—	Represents the status of the insight data.
`device_clicks`	`int64`	optional	—	Represents the number of clicks attributed to the device.
`device_cpc`	`float64`	optional	—	Represents the cost per click attributed to the device.
`device_cpm`	`float64`	optional	—	Represents the cost per thousand impressions attributed to the device.
`device_ctr`	`float64`	optional	—	Represents the click-through rate attributed to the device.
`device_impressions`	`int64`	optional	—	Represents the number of impressions attributed to the device.
`device_spend`	`float64`	optional	—	Represents the spend attributed to the device.
`device_type`	`string \| null`	optional	—	Represents the device type associated with the insight item.
`end_time`	`int64`	required in source	—	Marks the end of the insight item's reporting period.
`id`	`string`	required in source	—	Identifies the insight item.
`impressions`	`int64`	optional	—	Counts occurrences of the ad being shown.
`item_id`	`string`	optional	—	Identifies the product item associated with the insight item.
`order_created_attributed_sales`	`float64 \| null`	optional	—	Total value of attributed `order_created` events, normalized to the ad account currency. Negative event values are treated as zero. Returns 0 when there are no attributed orders and null when at least one attributed order does not have a value that can be normalized to the ad account currency. Rounded to two decimal places.
`order_created_attributed_sales_currency`	`string`	optional	—	ISO 4217 currency code for `order_created_attributed_sales`. This is the ad account currency and is returned even when `order_created_attributed_sales` is null.
`order_created_roas`	`float64 \| null`	optional	—	Return on ad spend from attributed `order_created` events, calculated using the unrounded order-created attributed sales value divided by spend for the same insight row. Rounded to at most four decimal places. Returns null when attributed sales are unavailable or spend is not greater than zero.
`platform`	`string \| null`	optional	—	Represents the platform associated with the insight item.
`platform_clicks`	`int64`	optional	—	Represents the number of clicks attributed to the platform.
`platform_cpc`	`float64`	optional	—	Represents the cost per click attributed to the platform.
`platform_cpm`	`float64`	optional	—	Represents the cost per thousand impressions attributed to the platform.
`platform_ctr`	`float64`	optional	—	Represents the click-through rate attributed to the platform.
`platform_impressions`	`int64`	optional	—	Represents the number of impressions attributed to the platform.
`platform_spend`	`float64`	optional	—	Represents the spend attributed to the platform.
`post_click_cvr`	`float64 \| null`	optional	—	Reports the post-click conversion rate, with its numerical encoding not specified.
`product_availability`	`string`	optional	—	Represents the availability of the associated product.
`product_body`	`string`	optional	—	Represents the body content of the associated product.
`product_brand`	`string`	optional	—	Represents the brand of the associated product.
`product_clicks`	`int64`	optional	—	Reports clicks attributed to the product.
`product_cpc`	`float64`	optional	—	Reports the product cost per click.
`product_cpm`	`float64`	optional	—	Reports the product cost per thousand impressions.
`product_ctr`	`float64`	optional	—	Reports the product click-through rate.
`product_description`	`string`	optional	—	Represents the description of the associated product.
`product_feed_id`	`string`	optional	—	Identifies the product feed associated with the insight item.
`product_image_url`	`string`	optional	—	Represents the image URL of the associated product.
`product_impressions`	`int64`	optional	—	Reports impressions attributed to the product.
`product_price`	`string`	optional	—	Represents the price of the associated product.
`product_seller_name`	`string`	optional	—	Represents the seller name of the associated product.
`product_spend`	`float64`	optional	—	Reports spend attributed to the product.
`product_target_url`	`string`	optional	—	Represents the target URL of the associated product.
`product_title`	`string`	optional	—	Represents the title of the associated product.
`readable_time`	`string`	optional	—	Provides a readable representation of the insight item's time period.
`roas`	`float64 \| null`	optional	—	Deprecated. Return on ad spend from attributed `order_created` and `subscription_created` events, calculated using the unrounded attributed sales value divided by spend for the same insight row. Rounded to at most four decimal places. Returns null when attributed sales are unavailable or spend is not greater than zero. Use `order_created_roas` instead. Scheduled for removal on August 17, 2026.
`spend`	`float64`	optional	—	Represents spend for the insight item, with no scale specified.
`start_time`	`int64`	required in source	—	Marks the start of the insight item's reporting period.
`timezone`	`string`	optional	—	Identifies the timezone associated with the insight item's time period.

`InsightsResource`

TypeSpec name: Chatgptads.InsightsResource

Wire field	Source type	Presence	Source constraints	Description
`count`	`int64`	required in source	—	Represents the number of insight items in the resource.
`data`	`Array<Chatgptads.InsightItemBody>`	required in source	—	Contains the insight items returned in the resource.
`first_id`	`string \| null`	required in source	—	Identifies the first insight item in the resource.
`has_more`	`boolean`	required in source	—	Indicates whether more insight items are available.
`last_id`	`string \| null`	required in source	—	Identifies the last insight item in the resource.
`object`	`string`	required in source	—	Represents the object designation for the insights resource.

`LandingPageConfigurationBody`

TypeSpec name: Chatgptads.LandingPageConfigurationBody

Wire field	Source type	Presence	Source constraints	Description
`query_string_template`	`string \| null`	required in source	—	Represents the query-string template in the landing page configuration.

`LandingPageConfigurationParams`

TypeSpec name: Chatgptads.LandingPageConfigurationParams

Wire field	Source type	Presence	Source constraints	Description
`query_string_template`	`string`	optional	—	Specifies the query-string template for the landing page configuration.

`LeadFormListItemBody`

TypeSpec name: Chatgptads.LeadFormListItemBody

Wire field	Source type	Presence	Source constraints	Description
`archived_at`	`int64 \| null`	required in source	—	Represents when the lead form was archived.
`created_at`	`int64`	required in source	—	Represents when the lead form was created.
`draft_revision_id`	`string`	required in source	—	Identifies the draft revision of the lead form.
`fields`	`Array<Chatgptads.PublicLeadFormFieldBody>`	required in source	—	Contains the public fields defined for the lead form.
`has_unpublished_changes`	`boolean`	required in source	—	Indicates whether the lead form has unpublished changes.
`id`	`string`	required in source	—	Identifies the lead form.
`name`	`string`	required in source	—	Represents the name of the lead form.
`privacy_policy_url`	`string \| null`	required in source	—	Represents the URL of the lead form's privacy policy.
`published_at`	`int64 \| null`	required in source	—	Represents when the lead form was published.
`published_revision_id`	`string \| null`	required in source	—	Identifies the published revision of the lead form.
`status`	`string`	required in source	—	Represents the status of the lead form.
`updated_at`	`int64`	required in source	—	Represents when the lead form was last updated.

`LeadSyncSubscriptionListItemBody`

TypeSpec name: Chatgptads.LeadSyncSubscriptionListItemBody

Wire field	Source type	Presence	Source constraints	Description
`object`	`string`	required in source	—	Represents the object designation for the lead synchronization subscription.
`status`	`string`	required in source	—	Represents the status of the lead synchronization subscription.
`subscription_id`	`string`	required in source	—	Identifies the lead synchronization subscription.

`LeadSyncSubscriptionResource`

TypeSpec name: Chatgptads.LeadSyncSubscriptionResource

Wire field	Source type	Presence	Source constraints	Description
`object`	`string`	required in source	—	Represents the object designation for the lead synchronization subscription resource.
`status`	`string`	required in source	—	Represents the status of the lead synchronization subscription resource.
`subscription_id`	`string`	required in source	—	Identifies the lead synchronization subscription in the resource.

`LeadSyncSubscriptionsResource`

TypeSpec name: Chatgptads.LeadSyncSubscriptionsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.LeadSyncSubscriptionListItemBody>`	required in source	—	Contains the lead synchronization subscriptions returned in the resource.
`first_id`	`string \| null`	required in source	—	Identifies the first lead synchronization subscription in the resource.
`has_more`	`boolean`	required in source	—	Indicates whether more lead synchronization subscriptions are available.
`last_id`	`string \| null`	required in source	—	Identifies the last lead synchronization subscription in the resource.
`object`	`string`	required in source	—	Represents the object designation for the lead synchronization subscriptions resource.

`LeadSyncWebhookData`

LeadSyncWebhookData

TypeSpec name: Chatgptads.LeadSyncWebhookData

Wire field	Source type	Presence	Source constraints	Description
`ad_account_id`	`string \| null`	required in source	minLength=1; maxLength=256	Identifies the ad account associated with the lead data.
`ad_group_id`	`string \| null`	required in source	minLength=1; maxLength=256	Identifies the ad group associated with the lead data.
`ad_id`	`string \| null`	required in source	minLength=1; maxLength=256	Identifies the ad associated with the lead data.
`campaign_id`	`string \| null`	required in source	minLength=1; maxLength=256	Identifies the campaign associated with the lead data.
`form_id`	`string`	required in source	maxLength=256; pattern=^leadform_[^~]+$	Identifies the form associated with the lead data.
`form_revision_id`	`string`	required in source	maxLength=256; pattern=^leadformrev_[^~]+$	Identifies the form revision associated with the lead data.
`lead_id`	`string`	required in source	maxLength=256; pattern=^leadformresp_[^~]+$	Identifies the lead associated with the webhook data.
`responses`	`Array<Chatgptads.LeadSyncWebhookScalarResponse \| Chatgptads.LeadSyncWebhookMultipleChoiceResponse>`	required in source	minItems=1; maxItems=5	Represents a list of responses in the lead-sync webhook data.
`submitted_at`	`utcDateTime`	required in source	—	Represents when the lead data was submitted.

`LeadSyncWebhookEvent`

LeadSyncWebhookEvent

TypeSpec name: Chatgptads.LeadSyncWebhookEvent

Wire field	Source type	Presence	Source constraints	Description
`created_at`	`int64`	required in source	minValue=0	Represents when the webhook event was created.
`data`	`Chatgptads.LeadSyncWebhookData`	required in source	—	Contains the lead synchronization data associated with the webhook event.
`id`	`string`	required in source	minLength=1; maxLength=256	Identifies the webhook event.
`object`	`Chatgptads.LeadSyncWebhookEventObject`	required in source	—	Represents the webhook event object, which is event.
`subscription_id`	`string`	required in source	maxLength=256; pattern=^leadsync_[^~]+_g[1-9][0-9]*$	Identifies the subscription associated with the webhook event.
`synthetic`	`true \| null`	optional	—	Indicates whether the lead-sync webhook event is synthetic.
`type`	`Chatgptads.LeadSyncWebhookEventType`	required in source	—	Represents the webhook event type, which is lead_form.response.created.

`LeadSyncWebhookMultipleChoiceResponse`

LeadSyncWebhookMultipleChoiceResponse

TypeSpec name: Chatgptads.LeadSyncWebhookMultipleChoiceResponse

Wire field	Source type	Presence	Source constraints	Description
`field_id`	`string`	required in source	minLength=1; maxLength=128	Identifies the form field associated with the multiple-choice response.
`field_type`	`Chatgptads.LeadSyncWebhookMultipleChoiceResponseFieldType`	required in source	—	Identifies this lead response as a multiple-choice field.
`label`	`string`	required in source	minLength=1; maxLength=256	Provides the label associated with the multiple-choice field.
`option`	`Chatgptads.LeadSyncWebhookOption`	required in source	—	Provides the selected option for the multiple-choice field.

`LeadSyncWebhookOption`

LeadSyncWebhookOption

TypeSpec name: Chatgptads.LeadSyncWebhookOption

Wire field	Source type	Presence	Source constraints	Description
`id`	`string`	required in source	minLength=1; maxLength=128	Identifies the lead response option.
`label`	`string`	required in source	minLength=1; maxLength=256	Provides the label for the lead response option.

`LeadSyncWebhookScalarResponse`

LeadSyncWebhookScalarResponse

TypeSpec name: Chatgptads.LeadSyncWebhookScalarResponse

Wire field	Source type	Presence	Source constraints	Description
`field_id`	`string`	required in source	minLength=1; maxLength=128	Identifies the lead field associated with the scalar response.
`field_type`	`Chatgptads.LeadSyncWebhookScalarResponseFieldType`	required in source	—	Identifies whether the scalar response represents a name, email, phone, or free-form field.
`label`	`string`	required in source	minLength=1; maxLength=256	Provides the label associated with the scalar field.
`value`	`string`	required in source	minLength=1; maxLength=4096	Provides the submitted value for the scalar field.

`ListBusinessAgentsResource`

TypeSpec name: Chatgptads.ListBusinessAgentsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.BusinessAgentListItemBody>`	required in source	—	Contains the business agents in the list.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the business-agent list.

`ListBusinessAgentToolsResource`

TypeSpec name: Chatgptads.ListBusinessAgentToolsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.BusinessAgentCatalogToolBody>`	required in source	—	Contains the catalog tools in the list.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the business-agent-tool list.

`ListClientDataSourceItemsResource`

TypeSpec name: Chatgptads.ListClientDataSourceItemsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.ClientDataSourceItemResource>`	required in source	—	Contains the client data-source items in the list.
`first_id`	`string \| null`	required in source	—	Identifies the first client data-source item in the list.
`has_more`	`boolean`	required in source	—	Indicates whether more client data-source items are available.
`last_id`	`string \| null`	required in source	—	Identifies the last client data-source item in the list.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the client data-source-item list.

`ListConversionEventSettingsResource`

TypeSpec name: Chatgptads.ListConversionEventSettingsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.ConversionEventSettingItemResource>`	required in source	—	Contains the conversion event settings in the list.
`first_id`	`string \| null`	required in source	—	Identifies the first conversion event setting in the list.
`has_more`	`boolean`	required in source	—	Indicates whether more conversion event settings are available.
`last_id`	`string \| null`	required in source	—	Identifies the last conversion event setting in the list.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the conversion-event-settings list.

`ListLeadFormsResource`

TypeSpec name: Chatgptads.ListLeadFormsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.LeadFormListItemBody>`	required in source	—	Contains the lead forms in the list.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the lead-form list.

`ListProductFeedBody`

TypeSpec name: Chatgptads.ListProductFeedBody

Wire field	Source type	Presence	Source constraints	Description
`campaign_count`	`int64`	optional	—	Reports the number of campaigns associated with the product feed.
`countries`	`Array<string>`	required in source	—	Lists the countries associated with the product feed.
`created_at`	`string`	required in source	—	Records when the product feed was created.
`currencies`	`Array<string>`	required in source	—	Lists the currencies associated with the product feed.
`feed_id`	`string`	required in source	—	Identifies the product feed.
`hosted_url_configured`	`boolean`	optional	—	Indicates whether a hosted URL is configured for the product feed.
`name`	`string`	required in source	—	Provides the name of the product feed.
`product_count`	`int64`	optional	—	Reports the number of products in the product feed.
`sftp_configured`	`boolean`	optional	—	Indicates whether SFTP is configured for the product feed.
`updated_at`	`string`	required in source	—	Records when the product feed was last updated.

`ListProductFeedsResource`

TypeSpec name: Chatgptads.ListProductFeedsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.ListProductFeedBody>`	required in source	—	Contains the product feeds in the list.
`first_id`	`string \| null`	required in source	—	Identifies the first product feed in the list.
`has_more`	`boolean`	required in source	—	Indicates whether more product feeds are available.
`last_id`	`string \| null`	required in source	—	Identifies the last product feed in the list.
`object`	`string`	required in source	—	Identifies the kind of resource returned for the product-feed list.

`ListProductFeedUploadsResource`

TypeSpec name: Chatgptads.ListProductFeedUploadsResource

Wire field	Source type	Presence	Source constraints	Description
`first_id`	`string \| null`	optional	—	Identifies the first product feed upload in the results.
`has_more`	`boolean`	optional	—	Indicates whether more product feed uploads are available.
`last_id`	`string \| null`	optional	—	Identifies the last product feed upload in the results.
`latest_uploads`	`Array<Chatgptads.ProductFeedUploadBody>`	required in source	—	Contains the latest product feed uploads.
`truncated`	`boolean`	required in source	—	Indicates whether the product feed upload results are truncated.
`uploads`	`Array<Chatgptads.ProductFeedUploadBody>`	required in source	—	Contains product feed uploads.

`MergeCustomAudiencesBody`

TypeSpec name: Chatgptads.MergeCustomAudiencesBody

Wire field	Source type	Presence	Source constraints	Description
`custom_audience_ids`	`Array<string>`	required in source	maxItems=64	Lists the custom audiences to merge.
`name`	`string`	required in source	minLength=3; maxLength=1000; pattern=^.\S.$	Provides the name for the merged custom audience.

`PartnerDataUploadResource`

TypeSpec name: Chatgptads.PartnerDataUploadResource

Wire field	Source type	Presence	Source constraints	Description
`completed_at`	`string \| null`	required in source	—	Records when the partner data upload was completed.
`created_at`	`string`	required in source	—	Records when the partner data upload was created.
`data_type`	`string`	required in source	—	Identifies the type of data in the partner data upload.
`file_name`	`string`	required in source	—	Provides the name of the uploaded file.
`file_size_bytes`	`int64`	required in source	—	Reports the size of the uploaded file in bytes.
`sha256`	`string`	required in source	—	Provides the SHA-256 value for the uploaded file.
`snapshot_date`	`string`	required in source	—	Records the snapshot date associated with the partner data upload.
`status`	`string`	required in source	—	Reports the status of the partner data upload.
`upload_id`	`string`	required in source	—	Identifies the partner data upload.

`PatchProductFeedProductsBody`

TypeSpec name: Chatgptads.PatchProductFeedProductsBody

Wire field	Source type	Presence	Source constraints	Description
`products`	`Array<Chatgptads.ProductFeedDeltaProductBodyParam>`	required in source	minItems=1	Contains the product changes submitted for the product feed.

`PostConversionInsightsBody`

TypeSpec name: Chatgptads.PostConversionInsightsBody

Wire field	Source type	Presence	Source constraints	Description
`aggregation_level`	`string`	required in source	—	Specifies the level at which conversion insights are aggregated.
`breakdown`	`Chatgptads.ConversionBreakdownParam`	optional	—	Specifies the breakdown used for conversion insights.
`entity_ids`	`Array<string>`	optional	—	Lists the entities included in the conversion insights request.
`group_by_entity`	`boolean`	optional	—	Indicates whether conversion insights are grouped by entity.
`include_zero_rows`	`boolean`	optional	—	Indicates whether conversion-insight rows with zero values are included.
`time_granularity`	`Chatgptads.ConversionTimeGranularityParam`	optional	—	Specifies the time granularity for conversion insights.
`time_ranges`	`Array<string>`	required in source	—	Lists the time ranges for which conversion insights are requested.

`PostProductFeedSftpAccessBody`

TypeSpec name: Chatgptads.PostProductFeedSftpAccessBody

Wire field	Source type	Presence	Source constraints	Description
`authentication_method`	`Chatgptads.ProductFeedSftpAuthenticationMethodParam`	required in source	—	Specifies the authentication method for product-feed SFTP access.
`ssh_public_key`	`string`	optional	—	Provides the SSH public key for product-feed SFTP access.

`PreviewBusinessAgentBody`

TypeSpec name: Chatgptads.PreviewBusinessAgentBody

Wire field	Source type	Presence	Source constraints	Description
`messages`	`Array<Chatgptads.PublicBusinessAgentPreviewMessageBodyParam>`	required in source	minItems=1; maxItems=10	Contains the messages submitted for the business-agent preview.

`ProductFeedDeltaAvailabilityBodyParam`

TypeSpec name: Chatgptads.ProductFeedDeltaAvailabilityBodyParam

Wire field	Source type	Presence	Source constraints	Description
`available`	`boolean`	optional	—	Indicates whether the product or variant is available.
`status`	`string`	optional	—	Provides the availability status of the product or variant.

`ProductFeedDeltaPriceBodyParam`

TypeSpec name: Chatgptads.ProductFeedDeltaPriceBodyParam

Wire field	Source type	Presence	Source constraints	Description
`amount`	`int64`	required in source	minValue=0	Provides the price amount for the product or variant.
`currency`	`string`	required in source	minLength=3; maxLength=3	Identifies the currency for the product or variant price.

`ProductFeedDeltaProductBodyParam`

TypeSpec name: Chatgptads.ProductFeedDeltaProductBodyParam

Wire field	Source type	Presence	Source constraints	Description
`id`	`string`	required in source	minLength=1	Identifies the product being changed.
`variants`	`Array<Chatgptads.ProductFeedDeltaVariantBodyParam>`	required in source	minItems=1	Contains the variants included in the product change.

`ProductFeedDeltaResource`

TypeSpec name: Chatgptads.ProductFeedDeltaResource

Wire field	Source type	Presence	Source constraints	Description
`accepted`	`boolean`	required in source	—	Indicates whether the product-feed delta was accepted.
`id`	`string`	required in source	—	Identifies the product-feed delta.

`ProductFeedDeltaVariantBodyParam`

TypeSpec name: Chatgptads.ProductFeedDeltaVariantBodyParam

Wire field	Source type	Presence	Source constraints	Description
`availability`	`Chatgptads.ProductFeedDeltaAvailabilityBodyParam`	optional	—	Provides the availability details for the variant being changed.
`id`	`string`	required in source	minLength=1	Identifies the variant being changed.
`price`	`Chatgptads.ProductFeedDeltaPriceBodyParam`	optional	—	Provides the price details for the variant being changed.
`title`	`string`	optional	—	Provides the title of the variant being changed.

`ProductFeedProductBody`

TypeSpec name: Chatgptads.ProductFeedProductBody

Wire field	Source type	Presence	Source constraints	Description
`body`	`string \| null`	required in source	—	Provides the product description or body content.
`brand`	`string \| null`	required in source	—	Provides the product brand.
`filter_values`	`unknown`	required in source	—	Provides filter values associated with the product.
`image_url`	`string \| null`	required in source	—	Provides the URL of the product image.
`item_id`	`string \| null`	required in source	—	Identifies the item in the product feed.
`offer_id`	`string \| null`	required in source	—	Identifies the offer associated with the product.
`price`	`string \| null`	required in source	—	Provides the product price.
`product_id`	`string`	required in source	—	Identifies the product in the product feed.
`target_url`	`string \| null`	required in source	—	Provides the URL associated with the product.
`title`	`string \| null`	required in source	—	Provides the product title.

`ProductFeedResource`

TypeSpec name: Chatgptads.ProductFeedResource

Wire field	Source type	Presence	Source constraints	Description
`countries`	`Array<string>`	required in source	—	Lists the countries associated with the product feed.
`created_at`	`string`	required in source	—	Records when the product feed was created.
`currencies`	`Array<string>`	required in source	—	Lists the currencies associated with the product feed.
`feed_id`	`string`	required in source	—	Identifies the product feed.
`name`	`string`	required in source	—	Provides the name of the product feed.
`updated_at`	`string`	required in source	—	Records when the product feed was last updated.

`ProductFeedSftpAccessCredentialsResource`

TypeSpec name: Chatgptads.ProductFeedSftpAccessCredentialsResource

Wire field	Source type	Presence	Source constraints	Description
`authentication_method`	`Chatgptads.ProductFeedSftpAuthenticationMethodResource`	required in source	—	Identifies the authentication method for product-feed SFTP access.
`connection_uri`	`string`	required in source	—	Provides the connection URI for product-feed SFTP access.
`enabled`	`boolean`	required in source	—	Indicates whether the product-feed SFTP access credentials are enabled.
`password`	`string`	optional	—	Provides the password for product-feed SFTP access.

`ProductFeedSftpAccessResource`

TypeSpec name: Chatgptads.ProductFeedSftpAccessResource

Wire field	Source type	Presence	Source constraints	Description
`authentication_method`	`Chatgptads.ProductFeedSftpAuthenticationMethodResource \| null`	required in source	—	Specifies the authentication method for the product feed’s SFTP access.
`connection_uri`	`string`	required in source	—	Identifies the URI used to connect to the product feed’s SFTP access.
`enabled`	`boolean`	required in source	—	Indicates whether the product feed’s SFTP access is enabled.

`ProductFeedUploadBody`

TypeSpec name: Chatgptads.ProductFeedUploadBody

Wire field	Source type	Presence	Source constraints	Description
`completed_at`	`string \| null`	required in source	—	Records when processing of the product feed upload completed.
`diagnostics`	`Array<Chatgptads.ProductFeedUploadDiagnosticBody>`	required in source	—	Provides diagnostics associated with the product feed upload.
`feed_id`	`string`	required in source	—	Identifies the product feed associated with the upload.
`rows_accepted`	`int64 \| null`	required in source	—	Reports the number of upload rows accepted.
`rows_ads_eligible`	`int64 \| null`	optional	—	Accepted ads-eligible product count; null when not reported.
`rows_rejected`	`int64 \| null`	required in source	—	Reports the number of upload rows rejected.
`status`	`Chatgptads.ProductFeedUploadStatusResource`	required in source	—	Reports the status of the product feed upload.
`uploaded_at`	`string`	required in source	—	Records when the product feed upload occurred.
`upload_id`	`string`	required in source	—	Identifies the product feed upload.

`ProductFeedUploadDiagnosticBody`

TypeSpec name: Chatgptads.ProductFeedUploadDiagnosticBody

Wire field	Source type	Presence	Source constraints	Description
`code`	`Chatgptads.ProductFeedUploadDiagnosticCodeResource`	required in source	—	Identifies the diagnostic code for an upload issue or condition.
`field`	`string \| null`	required in source	—	Identifies the field associated with an upload diagnostic.
`rows_affected`	`int64 \| null`	required in source	—	Reports the number of rows affected by an upload diagnostic.
`severity`	`Chatgptads.ProductFeedUploadDiagnosticSeverityResource`	required in source	—	Indicates the severity of an upload diagnostic.

`ProductSetBody`

TypeSpec name: Chatgptads.ProductSetBody

Wire field	Source type	Presence	Source constraints	Description
`filters`	`Array<Chatgptads.ProductSetFilterBody>`	required in source	—	Defines the filters applied to the product set.
`product_feed_id`	`string`	required in source	—	Identifies the product feed used by the product set.

`ProductSetFilterBody`

TypeSpec name: Chatgptads.ProductSetFilterBody

Wire field	Source type	Presence	Source constraints	Description
`field`	`string`	required in source	—	Identifies the product field to which the filter applies.
`operator`	`string`	required in source	—	Specifies how the filter is applied to the selected product field.
`values`	`Array<string>`	required in source	—	Provides the values used by the product set filter.

`ProductSetFilterParams`

TypeSpec name: Chatgptads.ProductSetFilterParams

Wire field	Source type	Presence	Source constraints	Description
`field`	`string`	required in source	—	Identifies the product field to which the filter parameter applies.
`operator`	`Chatgptads.ProductSetFilterOperatorParam`	required in source	—	Specifies how the filter parameter is applied to the selected product field.
`values`	`Array<string>`	required in source	—	Provides the values used by the product set filter parameter.

`ProductSetParams`

TypeSpec name: Chatgptads.ProductSetParams

Wire field	Source type	Presence	Source constraints	Description
`filters`	`Array<Chatgptads.ProductSetFilterParams>`	optional	—	Defines the filters for the product set parameters.
`product_feed_id`	`string`	required in source	—	Identifies the product feed used by the product set parameters.

`PublicBusinessAgentPreviewMessageBodyParam`

TypeSpec name: Chatgptads.PublicBusinessAgentPreviewMessageBodyParam

Wire field	Source type	Presence	Source constraints	Description
`content`	`string`	required in source	minLength=1; maxLength=4000	Contains the content of a message in a business agent preview.
`role`	`Chatgptads.BusinessAgentPreviewMessageRoleParam`	required in source	—	Specifies the role of a message in a business agent preview.

`PublicLeadFormFieldBody`

TypeSpec name: Chatgptads.PublicLeadFormFieldBody

Wire field	Source type	Presence	Source constraints	Description
`field_id`	`string`	required in source	—	Identifies the lead form field.
`field_type`	`string`	required in source	—	Specifies the type of lead form field.
`label`	`string`	required in source	—	Provides the label displayed for the lead form field.
`options`	`Array<Chatgptads.PublicLeadFormOptionBody>`	optional	—	Provides the options available for the lead form field.
`required`	`boolean`	required in source	—	Indicates whether the lead form field is required.

`PublicLeadFormOptionBody`

TypeSpec name: Chatgptads.PublicLeadFormOptionBody

Wire field	Source type	Presence	Source constraints	Description
`id`	`string`	required in source	—	Identifies a lead form option.
`label`	`string`	required in source	—	Provides the label displayed for a lead form option.

`PublishLeadFormBody`

TypeSpec name: Chatgptads.PublishLeadFormBody

Wire field	Source type	Presence	Source constraints	Description
`expected_draft_revision_id`	`string`	required in source	minLength=1	Identifies the draft revision expected when publishing the lead form.

`QueryProductFeedProductsBody`

TypeSpec name: Chatgptads.QueryProductFeedProductsBody

Wire field	Source type	Presence	Source constraints	Description
`after`	`string`	optional	—	Identifies the position after which the product query should continue.
`filters`	`Array<Chatgptads.ProductSetFilterParams>`	optional	—	Defines the filters for the product feed product query.
`limit`	`int64`	optional	minValue=1; maxValue=500	Specifies the maximum number of products requested by the query.

`QueryProductFeedProductsResource`

TypeSpec name: Chatgptads.QueryProductFeedProductsResource

Wire field	Source type	Presence	Source constraints	Description
`data`	`Array<Chatgptads.ProductFeedProductBody>`	required in source	—	Contains the products returned by the query.
`first_id`	`string \| null`	required in source	—	Identifies the first product in the returned results.
`has_more`	`boolean`	required in source	—	Indicates whether more products are available beyond the returned results.
`last_id`	`string \| null`	required in source	—	Identifies the last product in the returned results.
`matched_count`	`int64`	required in source	—	Reports the number of products matching the query.
`object`	`string`	required in source	—	Identifies the object represented by the product query response.
`total_count`	`int64`	required in source	—	Reports the total number of products.

`ReplaceCustomAudienceMembersBody`

TypeSpec name: Chatgptads.ReplaceCustomAudienceMembersBody

Wire field	Source type	Presence	Source constraints	Description
`expected_revision`	`int64`	required in source	minValue=0	Specifies the custom audience revision expected for the replacement.
`file_id`	`string`	required in source	—	Identifies the file containing the custom audience members.
`filename`	`string`	optional	minLength=1; maxLength=255	Provides the name of the custom audience member file.
`file_size`	`int64`	optional	minValue=1; maxValue=500000000	Reports the size of the custom audience member file.
`identifier_resolution`	`Chatgptads.CustomAudienceIdentifierResolutionParam`	optional	—	Specifies how identifiers in the custom audience member file are resolved.
`identifier_type`	`Chatgptads.CustomAudienceIdentifierTypeParam`	optional	—	Specifies the type of identifiers in the custom audience member file.
`mimetype`	`string`	optional	minLength=1; maxLength=255	Specifies the media type of the custom audience member file.

`ReviewBody`

TypeSpec name: Chatgptads.ReviewBody

Wire field	Source type	Presence	Source constraints	Description
`reason`	`string`	optional	—	Represents the reason associated with the review.
`screenshot_url`	`string`	optional	—	Provides the URL of a screenshot associated with the review.
`status`	`Chatgptads.ReviewStatus`	required in source	—	Reports the status of the review.

`TargetingBody`

TypeSpec name: Chatgptads.TargetingBody

Wire field	Source type	Presence	Source constraints	Description
`custom_audiences`	`Chatgptads.TargetingCustomAudiencesBody`	optional	—	Defines the custom audiences included in targeting.
`excluded_custom_audiences`	`Chatgptads.TargetingCustomAudiencesBody`	optional	—	Defines the custom audiences excluded from targeting.
`excluded_locations`	`Chatgptads.TargetingGeoLocationsBody`	optional	—	Defines the geographic locations excluded from targeting.
`locations`	`Chatgptads.TargetingGeoLocationsBody`	optional	—	Defines the geographic locations included in targeting.
`platforms`	`Chatgptads.TargetingPlatformsBody`	optional	—	Defines the platforms included in targeting.

`TargetingCustomAudiencesBody`

TypeSpec name: Chatgptads.TargetingCustomAudiencesBody

Wire field	Source type	Presence	Source constraints	Description
`ids`	`Array<string>`	required in source	—	Lists the custom audience identifiers included in targeting.

`TargetingCustomAudiencesParams`

TypeSpec name: Chatgptads.TargetingCustomAudiencesParams

Wire field	Source type	Presence	Source constraints	Description
`ids`	`Array<string>`	optional	—	Lists the custom audience identifiers supplied as targeting parameters.

`TargetingGeoLocationBody`

TypeSpec name: Chatgptads.TargetingGeoLocationBody

Wire field	Source type	Presence	Source constraints	Description
`country_code`	`string`	required in source	—	Identifies the country associated with a geographic location.
`id`	`string`	required in source	—	Identifies a geographic location used in targeting.
`name`	`string`	required in source	—	Provides the name of a geographic location used in targeting.
`region_code`	`string \| null`	required in source	—	Identifies the region associated with a geographic location.
`type`	`string`	required in source	—	Specifies the type of a geographic location used in targeting.

`TargetingGeoLocationParams`

TypeSpec name: Chatgptads.TargetingGeoLocationParams

Wire field	Source type	Presence	Source constraints	Description
`country_code`	`string`	optional	—	Identifies the country associated with a geographic targeting parameter.
`id`	`string`	required in source	—	Identifies a geographic location supplied as a targeting parameter.
`name`	`string`	optional	—	Provides the name of a geographic location supplied as a targeting parameter.
`region_code`	`string`	optional	—	Identifies the region associated with a geographic targeting parameter.
`type`	`string`	optional	—	Specifies the type of a geographic location supplied as a targeting parameter.

`TargetingGeoLocationsBody`

TypeSpec name: Chatgptads.TargetingGeoLocationsBody

Wire field	Source type	Presence	Source constraints	Description
`countries`	`Array<string>`	optional	—	Lists the countries included in the geographic targeting configuration.
`include`	`Array<Chatgptads.TargetingGeoLocationBody>`	optional	—	Lists the geographic locations included in the targeting configuration.

`TargetingGeoLocationsParams`

TypeSpec name: Chatgptads.TargetingGeoLocationsParams

Wire field	Source type	Presence	Source constraints	Description
`countries`	`Array<string>`	optional	—	Lists the countries supplied as geographic targeting parameters.
`include`	`Array<Chatgptads.TargetingGeoLocationParams>`	optional	maxItems=2500	Lists the geographic locations supplied as targeting parameters.

`TargetingParams`

TypeSpec name: Chatgptads.TargetingParams

Wire field	Source type	Presence	Source constraints	Description
`custom_audiences`	`Chatgptads.TargetingCustomAudiencesParams`	optional	—	Defines the custom audiences supplied for targeting.
`excluded_custom_audiences`	`Chatgptads.TargetingCustomAudiencesParams`	optional	—	Defines the custom audiences supplied for exclusion from targeting.
`excluded_locations`	`Chatgptads.TargetingGeoLocationsParams`	optional	—	Defines the geographic locations supplied for exclusion from targeting.
`locations`	`Chatgptads.TargetingGeoLocationsParams`	optional	—	Defines the geographic locations supplied for targeting.
`platforms`	`Chatgptads.TargetingPlatformsParams \| null`	optional	—	Defines the platforms supplied for targeting.

`TargetingPlatformsBody`

TypeSpec name: Chatgptads.TargetingPlatformsBody

Wire field	Source type	Presence	Source constraints	Description
`included`	`Array<Chatgptads.CampaignPlatformParam>`	optional	—	Lists the platforms included in the targeting configuration.

`TargetingPlatformsParams`

TypeSpec name: Chatgptads.TargetingPlatformsParams

Wire field	Source type	Presence	Source constraints	Description
`included`	`Array<Chatgptads.CampaignPlatformParam>`	optional	—	Lists the platforms supplied for inclusion in targeting.

`TestLeadSubmissionResource`

TypeSpec name: Chatgptads.TestLeadSubmissionResource

Wire field	Source type	Presence	Source constraints	Description
`delivery_status`	`string`	required in source	—	Reports the delivery status of the test lead submission.
`event`	`unknown`	required in source	—	Contains the event data for the test lead submission.
`form_id`	`string`	required in source	—	Identifies the lead form associated with the test submission.
`form_revision_id`	`string`	required in source	—	Identifies the form revision associated with the test submission.
`object`	`string`	required in source	—	Identifies the object represented by the test lead submission.
`subscription_id`	`string`	required in source	—	Identifies the subscription associated with the test lead submission.
`synthetic`	`boolean`	required in source	—	Indicates whether the lead submission is synthetic.
`webhook_delivery_id`	`string \| null`	optional	—	Identifies the webhook delivery associated with the test lead submission.

`UpdateAdAccountBody`

TypeSpec name: Chatgptads.UpdateAdAccountBody

Wire field	Source type	Presence	Source constraints	Description
`favicon_file_id`	`string`	optional	—	Identifies the file used for the ad account favicon.
`name`	`string`	optional	—	Provides the updated name of the ad account.
`url`	`string`	optional	minLength=1; maxLength=2048	Provides the updated URL of the ad account.

`UpdateAdAccountNegativeKeywordsBody`

TypeSpec name: Chatgptads.UpdateAdAccountNegativeKeywordsBody

Wire field	Source type	Presence	Source constraints	Description
`negative_keywords`	`Array<string>`	required in source	maxItems=100	Lists the negative keywords for the ad account.

`UpdateAdAccountSpendLimitWindowBody`

TypeSpec name: Chatgptads.UpdateAdAccountSpendLimitWindowBody

Wire field	Source type	Presence	Source constraints	Description
`amount_micros`	`int64`	optional	minValue=0	Represents the updated amount for an ad account spend limit window in micros.
`end_date`	`string`	optional	minLength=10; maxLength=10	Specifies the end date of the ad account spend limit window.
`io_id`	`string \| null`	optional	maxLength=256	Identifies the insertion order associated with the ad account spend limit window.
`name`	`string \| null`	optional	maxLength=256	Provides the name of the ad account spend limit window.
`start_date`	`string`	optional	minLength=10; maxLength=10	Specifies the start date of the ad account spend limit window.

`UpdateAdBody`

TypeSpec name: Chatgptads.UpdateAdBody

Wire field	Source type	Presence	Source constraints	Description
`creative`	`Chatgptads.UpdateAdCreativeParams`	optional	—	Contains the creative details for the ad.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationParams \| null`	optional	—	Contains the ad's landing page configuration.
`name`	`string`	optional	minLength=3; maxLength=1000; pattern=^.\S.$	Specifies the ad's name.
`status`	`Chatgptads.ActivePausedArchivedStatusParam`	optional	—	Specifies the ad's active, paused, or archived status.

`UpdateAdCreativeParams`

TypeSpec name: Chatgptads.UpdateAdCreativeParams

Wire field	Source type	Presence	Source constraints	Description
`body`	`string`	required in source	maxLength=100	Contains the body text of the ad creative.
`file_id`	`string`	optional	—	Identifies the file associated with the ad creative.
`image_crop`	`Chatgptads.AdImageCropParams`	optional	—	Optional normalized square crop for chat_card creatives. Requires file_id and is not supported for product_ad_template creatives.
`price`	`string`	optional	maxLength=100	Specifies the price associated with the ad creative.
`target_url`	`string`	optional	maxLength=2048	Specifies the URL targeted by the ad creative.
`title`	`string`	required in source	minLength=1; maxLength=50; pattern=^.\S.$	Contains the title of the ad creative.
`type`	`Chatgptads.AdCreativeTypeParam`	required in source	—	Specifies the type of ad creative.

`UpdateAdGroupBody`

TypeSpec name: Chatgptads.UpdateAdGroupBody

Wire field	Source type	Presence	Source constraints	Description
`bidding_config`	`Chatgptads.BiddingConfigParams`	optional	—	Contains the ad group's bidding configuration.
`context_hints`	`Array<string>`	optional	maxItems=2000	Contains contextual hints for the ad group.
`description`	`string \| null`	optional	—	Provides a description of the ad group.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationParams \| null`	optional	—	Contains the ad group's landing page configuration.
`name`	`string`	optional	minLength=3; maxLength=1000; pattern=^.\S.$	Specifies the ad group's name.
`product_set`	`Chatgptads.ProductSetParams \| null`	optional	—	Specifies the product set associated with the ad group.
`status`	`Chatgptads.ActivePausedArchivedStatusParam`	optional	—	Specifies the ad group's active, paused, or archived status.

`UpdateBusinessAgentBody`

TypeSpec name: Chatgptads.UpdateBusinessAgentBody

Wire field	Source type	Presence	Source constraints	Description
`connector_ids`	`Array<string>`	optional	maxItems=50	Identifies the connectors associated with the business agent.
`conversation_starters`	`Array<string>`	optional	maxItems=12	Contains conversation starters for the business agent.
`description`	`string`	optional	minLength=1; maxLength=300	Provides a description of the business agent.
`instructions`	`string`	required in source	minLength=1; maxLength=4000	Provides instructions for the business agent.
`lead_form`	`Chatgptads.BusinessAgentLeadFormSelectionBodyParam \| null`	optional	—	Specifies the lead form selection for the business agent.
`name`	`string`	required in source	minLength=1; maxLength=50	Specifies the business agent's name.
`privacy_policy_url`	`string \| null`	optional	minLength=1; maxLength=2048	Specifies the URL of the business agent's privacy policy.
`product_feed_ids`	`Array<string>`	optional	maxItems=50	Identifies the product feeds associated with the business agent.
`tools`	`Array<string>`	optional	maxItems=50	Specifies the tools associated with the business agent.

`UpdateCampaignBody`

TypeSpec name: Chatgptads.UpdateCampaignBody

Wire field	Source type	Presence	Source constraints	Description
`budget`	`Chatgptads.BudgetParams`	optional	—	Contains the campaign's budget configuration.
`conversion_event_setting_ids`	`Array<string>`	optional	—	Identifies the conversion event settings associated with the campaign.
`description`	`string \| null`	optional	—	Provides a description of the campaign.
`end_time`	`int64 \| null`	optional	minValue=946684800; maxValue=4102444800	Specifies when the campaign ends.
`landing_page_configuration`	`Chatgptads.LandingPageConfigurationParams \| null`	optional	—	Contains the campaign's landing page configuration.
`name`	`string`	optional	minLength=3; maxLength=1000; pattern=^.\S.$	Specifies the campaign's name.
`start_time`	`int64 \| null`	optional	minValue=946684800; maxValue=4102444800	Specifies when the campaign starts.
`status`	`Chatgptads.ActivePausedArchivedStatusParam`	optional	—	Specifies the campaign's active, paused, or archived status.
`targeting`	`Chatgptads.TargetingParams \| null`	optional	—	Contains the campaign's targeting configuration.

`UpdateLeadFormBody`

TypeSpec name: Chatgptads.UpdateLeadFormBody

Wire field	Source type	Presence	Source constraints	Description
`expected_draft_revision_id`	`string`	required in source	minLength=1	Identifies the draft revision expected for the lead form update.
`fields`	`Array<Chatgptads.CreateLeadFormFieldBodyParam>`	required in source	minItems=3; maxItems=5	Contains the fields included in the lead form.
`name`	`string`	required in source	minLength=1; maxLength=256	Specifies the lead form's name.
`privacy_policy_url`	`string`	optional	—	Specifies the URL of the lead form's privacy policy.

`UploadBlobBody`

TypeSpec name: Chatgptads.UploadBlobBody

Wire field	Source type	Presence	Source constraints	Description
`file`	`bytes`	required in source	—	Contains the blob file to upload.
`purpose`	`Chatgptads.UploadBlobPurposeParam`	optional	—	The upload's intended use. This field is required unless the authenticated ad account is enrolled in the custom-audience compatibility rollout. For enrolled accounts, an omitted value defaults to `custom_audience`.

`UploadBlobResource`

TypeSpec name: Chatgptads.UploadBlobResource

Wire field	Source type	Presence	Source constraints	Description
`file_id`	`string`	required in source	—	Identifies the uploaded blob file.

`UploadImageBody`

TypeSpec name: Chatgptads.UploadImageBody

Wire field	Source type	Presence	Source constraints	Description
`file`	`bytes`	optional	—	Contains the image file to upload.
`image_url`	`string`	optional	—	Specifies the URL of the image to upload.
`purpose`	`Chatgptads.UploadImagePurposeParam`	optional	—	Specifies the purpose of the image upload.

`UploadImageResource`

TypeSpec name: Chatgptads.UploadImageResource

Wire field	Source type	Presence	Source constraints	Description
`file_id`	`string`	required in source	—	Identifies the uploaded image file.

Enumerations

`ActivePausedArchivedStatusParam`

Values ActivePausedArchivedStatusParam accepts.

TypeSpec name: Chatgptads.ActivePausedArchivedStatusParam

Member	Wire value	Description
`active`	`active`	No source description.
`archived`	`archived`	No source description.
`paused`	`paused`	No source description.

`ActivePausedStatusParam`

Values ActivePausedStatusParam accepts.

TypeSpec name: Chatgptads.ActivePausedStatusParam

Member	Wire value	Description
`active`	`active`	No source description.
`paused`	`paused`	No source description.

`AdCreativeTypeParam`

Values AdCreativeTypeParam accepts.

TypeSpec name: Chatgptads.AdCreativeTypeParam

Member	Wire value	Description
`chat_card`	`chat_card`	No source description.
`product_ad_template`	`product_ad_template`	No source description.

`AdGroupItemIncludeParam`

Values AdGroupItemIncludeParam accepts.

TypeSpec name: Chatgptads.AdGroupItemIncludeParam

Member	Wire value	Description
`serving_issues`	`serving_issues`	No source description.

`AdGroupServingIssueCode`

Values AdGroupServingIssueCode accepts.

TypeSpec name: Chatgptads.AdGroupServingIssueCode

Member	Wire value	Description
`ad_account_brand_review_escalated_review`	`ad_account_brand_review_escalated_review`	No source description.
`ad_account_brand_review_in_progress`	`ad_account_brand_review_in_progress`	No source description.
`ad_account_brand_review_missing_favicon`	`ad_account_brand_review_missing_favicon`	No source description.
`ad_account_brand_review_rejected`	`ad_account_brand_review_rejected`	No source description.
`ad_account_budget_exhausted`	`ad_account_budget_exhausted`	No source description.
`ad_account_payment_method_missing_or_unauthorized`	`ad_account_payment_method_missing_or_unauthorized`	No source description.
`ad_account_persona_verification_not_approved`	`ad_account_persona_verification_not_approved`	No source description.
`ad_account_persona_verification_step_up_required`	`ad_account_persona_verification_step_up_required`	No source description.
`ad_account_suspended`	`ad_account_suspended`	No source description.
`ad_account_threshold_payment_failed`	`ad_account_threshold_payment_failed`	No source description.
`ad_group_has_no_ads`	`ad_group_has_no_ads`	No source description.
`ad_group_has_no_serving_ready_ads`	`ad_group_has_no_serving_ready_ads`	No source description.
`ad_group_not_active`	`ad_group_not_active`	No source description.
`ad_in_review`	`ad_in_review`	No source description.
`campaign_budget_exhausted`	`campaign_budget_exhausted`	No source description.
`campaign_ended`	`campaign_ended`	No source description.
`campaign_not_active`	`campaign_not_active`	No source description.
`campaign_not_started`	`campaign_not_started`	No source description.
`landing_page_crawl_issue`	`landing_page_crawl_issue`	No source description.
`partial_serving_ad_in_review`	`partial_serving_ad_in_review`	No source description.
`partial_serving_landing_page_crawl_issue`	`partial_serving_landing_page_crawl_issue`	No source description.
`partial_serving_review_not_approved`	`partial_serving_review_not_approved`	No source description.
`review_not_approved`	`review_not_approved`	No source description.

`AdGroupsListIncludeParam`

Values AdGroupsListIncludeParam accepts.

TypeSpec name: Chatgptads.AdGroupsListIncludeParam

Member	Wire value	Description
`serving_issues`	`serving_issues`	No source description.

`AdItemIncludeParam`

Values AdItemIncludeParam accepts.

TypeSpec name: Chatgptads.AdItemIncludeParam

Member	Wire value	Description
`serving_issues`	`serving_issues`	No source description.

`AdServingIssueCode`

Values AdServingIssueCode accepts.

TypeSpec name: Chatgptads.AdServingIssueCode

Member	Wire value	Description
`ad_account_brand_review_escalated_review`	`ad_account_brand_review_escalated_review`	No source description.
`ad_account_brand_review_in_progress`	`ad_account_brand_review_in_progress`	No source description.
`ad_account_brand_review_missing_favicon`	`ad_account_brand_review_missing_favicon`	No source description.
`ad_account_brand_review_rejected`	`ad_account_brand_review_rejected`	No source description.
`ad_account_budget_exhausted`	`ad_account_budget_exhausted`	No source description.
`ad_account_payment_method_missing_or_unauthorized`	`ad_account_payment_method_missing_or_unauthorized`	No source description.
`ad_account_persona_verification_not_approved`	`ad_account_persona_verification_not_approved`	No source description.
`ad_account_persona_verification_step_up_required`	`ad_account_persona_verification_step_up_required`	No source description.
`ad_account_suspended`	`ad_account_suspended`	No source description.
`ad_account_threshold_payment_failed`	`ad_account_threshold_payment_failed`	No source description.
`ad_group_not_active`	`ad_group_not_active`	No source description.
`ad_in_review`	`ad_in_review`	No source description.
`ad_not_active`	`ad_not_active`	No source description.
`ad_over_18_only`	`ad_over_18_only`	No source description.
`advertiser_name_missing`	`advertiser_name_missing`	No source description.
`campaign_budget_exhausted`	`campaign_budget_exhausted`	No source description.
`campaign_ended`	`campaign_ended`	No source description.
`campaign_not_active`	`campaign_not_active`	No source description.
`campaign_not_started`	`campaign_not_started`	No source description.
`image_or_favicon_missing`	`image_or_favicon_missing`	No source description.
`landing_page_crawl_issue`	`landing_page_crawl_issue`	No source description.
`policy_country_targeting_blocked`	`policy_country_targeting_blocked`	No source description.
`policy_country_targeting_limited`	`policy_country_targeting_limited`	No source description.
`product_feed_id_missing`	`product_feed_id_missing`	No source description.
`reserved_query_params_present`	`reserved_query_params_present`	No source description.
`review_not_approved`	`review_not_approved`	No source description.
`target_url_invalid`	`target_url_invalid`	No source description.
`title_missing`	`title_missing`	No source description.

`AdsListIncludeParam`

Values AdsListIncludeParam accepts.

TypeSpec name: Chatgptads.AdsListIncludeParam

Member	Wire value	Description
`serving_issues`	`serving_issues`	No source description.

`AdSpecType`

Values AdSpecType accepts.

TypeSpec name: Chatgptads.AdSpecType

Member	Wire value	Description
`chat_card`	`chat_card`	No source description.
`product_ad_template`	`product_ad_template`	No source description.

`AppealStatus`

Values AppealStatus accepts.

TypeSpec name: Chatgptads.AppealStatus

Member	Wire value	Description
`approved`	`approved`	No source description.
`failed`	`failed`	No source description.
`rejected`	`rejected`	No source description.
`requested`	`requested`	No source description.
`superseded`	`superseded`	No source description.

`BiddingStrategyTypeBody`

Values BiddingStrategyTypeBody accepts.

TypeSpec name: Chatgptads.BiddingStrategyTypeBody

Member	Wire value	Description
`automated_bid`	`automated_bid`	No source description.
`fixed_bid`	`fixed_bid`	No source description.
`maximize_clicks`	`maximize_clicks`	No source description.
`maximize_conversions`	`maximize_conversions`	No source description.

`BiddingStrategyTypeParam`

Values BiddingStrategyTypeParam accepts.

TypeSpec name: Chatgptads.BiddingStrategyTypeParam

Member	Wire value	Description
`fixed_bid`	`fixed_bid`	No source description.
`maximize_clicks`	`maximize_clicks`	No source description.
`maximize_conversions`	`maximize_conversions`	No source description.

`BillingEventTypeParam`

Values BillingEventTypeParam accepts.

TypeSpec name: Chatgptads.BillingEventTypeParam

Member	Wire value	Description
`click`	`click`	No source description.
`impression`	`impression`	No source description.

`BusinessAgentPreviewMessageRoleParam`

Values BusinessAgentPreviewMessageRoleParam accepts.

TypeSpec name: Chatgptads.BusinessAgentPreviewMessageRoleParam

Member	Wire value	Description
`assistant`	`assistant`	No source description.
`user`	`user`	No source description.

`CampaignBiddingTypeParam`

Values CampaignBiddingTypeParam accepts.

TypeSpec name: Chatgptads.CampaignBiddingTypeParam

Member	Wire value	Description
`clicks`	`clicks`	No source description.
`conversions`	`conversions`	No source description.
`impressions`	`impressions`	No source description.

`CampaignBillingEventTypeParam`

Values CampaignBillingEventTypeParam accepts.

TypeSpec name: Chatgptads.CampaignBillingEventTypeParam

Member	Wire value	Description
`click`	`click`	No source description.
`impression`	`impression`	No source description.

`CampaignGetItemIncludeParam`

Values CampaignGetItemIncludeParam accepts.

TypeSpec name: Chatgptads.CampaignGetItemIncludeParam

Member	Wire value	Description
`serving_issues`	`serving_issues`	No source description.

`CampaignListIncludeParam`

Values CampaignListIncludeParam accepts.

TypeSpec name: Chatgptads.CampaignListIncludeParam

Member	Wire value	Description
`serving_issues`	`serving_issues`	No source description.

`CampaignModeParam`

Values CampaignModeParam accepts.

TypeSpec name: Chatgptads.CampaignModeParam

Member	Wire value	Description
`business_agent`	`business_agent`	No source description.
`product_feed`	`product_feed`	No source description.

`CampaignObjectiveParam`

Values CampaignObjectiveParam accepts.

TypeSpec name: Chatgptads.CampaignObjectiveParam

Member	Wire value	Description
`clicks`	`clicks`	No source description.
`conversions`	`conversions`	No source description.
`reach`	`reach`	No source description.

`CampaignPlatformParam`

Values CampaignPlatformParam accepts.

TypeSpec name: Chatgptads.CampaignPlatformParam

Member	Wire value	Description
`android_app`	`android_app`	No source description.
`ios_app`	`ios_app`	No source description.
`web`	`web`	No source description.

`CampaignServingIssueCode`

Values CampaignServingIssueCode accepts.

TypeSpec name: Chatgptads.CampaignServingIssueCode

Member	Wire value	Description
`ad_account_brand_review_escalated_review`	`ad_account_brand_review_escalated_review`	No source description.
`ad_account_brand_review_in_progress`	`ad_account_brand_review_in_progress`	No source description.
`ad_account_brand_review_missing_favicon`	`ad_account_brand_review_missing_favicon`	No source description.
`ad_account_brand_review_rejected`	`ad_account_brand_review_rejected`	No source description.
`ad_account_budget_exhausted`	`ad_account_budget_exhausted`	No source description.
`ad_account_payment_method_missing_or_unauthorized`	`ad_account_payment_method_missing_or_unauthorized`	No source description.
`ad_account_persona_verification_not_approved`	`ad_account_persona_verification_not_approved`	No source description.
`ad_account_persona_verification_step_up_required`	`ad_account_persona_verification_step_up_required`	No source description.
`ad_account_suspended`	`ad_account_suspended`	No source description.
`ad_account_threshold_payment_failed`	`ad_account_threshold_payment_failed`	No source description.
`ad_group_has_no_ads`	`ad_group_has_no_ads`	No source description.
`ad_group_not_active`	`ad_group_not_active`	No source description.
`ad_in_review`	`ad_in_review`	No source description.
`campaign_budget_exhausted`	`campaign_budget_exhausted`	No source description.
`campaign_ended`	`campaign_ended`	No source description.
`campaign_has_no_ad_groups`	`campaign_has_no_ad_groups`	No source description.
`campaign_has_no_serving_ready_ad_groups`	`campaign_has_no_serving_ready_ad_groups`	No source description.
`campaign_not_active`	`campaign_not_active`	No source description.
`campaign_not_started`	`campaign_not_started`	No source description.
`landing_page_crawl_issue`	`landing_page_crawl_issue`	No source description.
`partial_serving_ad_in_review`	`partial_serving_ad_in_review`	No source description.
`partial_serving_landing_page_crawl_issue`	`partial_serving_landing_page_crawl_issue`	No source description.
`partial_serving_review_not_approved`	`partial_serving_review_not_approved`	No source description.
`review_not_approved`	`review_not_approved`	No source description.

`ClientDataSourceTypeParam`

Values ClientDataSourceTypeParam accepts.

TypeSpec name: Chatgptads.ClientDataSourceTypeParam

Member	Wire value	Description
`web`	`web`	No source description.

`ConversionBreakdownParam`

Values ConversionBreakdownParam accepts.

TypeSpec name: Chatgptads.ConversionBreakdownParam

Member	Wire value	Description
`country`	`country`	No source description.
`device`	`device`	No source description.

`ConversionTimeGranularityParam`

Values ConversionTimeGranularityParam accepts.

TypeSpec name: Chatgptads.ConversionTimeGranularityParam

Member	Wire value	Description
`daily`	`daily`	No source description.
`none`	`none`	No source description.

`CustomAudienceIdentifierResolutionParam`

Values CustomAudienceIdentifierResolutionParam accepts.

TypeSpec name: Chatgptads.CustomAudienceIdentifierResolutionParam

Member	Wire value	Description
`auto`	`auto`	No source description.

`CustomAudienceIdentifierTypeParam`

Values CustomAudienceIdentifierTypeParam accepts.

TypeSpec name: Chatgptads.CustomAudienceIdentifierTypeParam

Member	Wire value	Description
`email`	`email`	No source description.
`email_sha256`	`email_sha256`	No source description.
`gaid`	`gaid`	No source description.
`phone`	`phone`	No source description.
`phone_number_sha256`	`phone_number_sha256`	No source description.

`CustomAudienceIntendedUseParam`

Values CustomAudienceIntendedUseParam accepts.

TypeSpec name: Chatgptads.CustomAudienceIntendedUseParam

Member	Wire value	Description
`bid_multiplier`	`bid_multiplier`	No source description.
`exclusion`	`exclusion`	No source description.
`inclusion`	`inclusion`	No source description.

`CustomAudienceMatchedCountGranularityParam`

Values CustomAudienceMatchedCountGranularityParam accepts.

TypeSpec name: Chatgptads.CustomAudienceMatchedCountGranularityParam

Member	Wire value	Description
`granular`	`granular`	No source description.

`LeadSyncWebhookEventObject`

Values LeadSyncWebhookEvent.object accepts.

TypeSpec name: Chatgptads.LeadSyncWebhookEventObject

Member	Wire value	Description
`event`	`event`	No source description.

`LeadSyncWebhookEventType`

Values LeadSyncWebhookEvent.type accepts.

TypeSpec name: Chatgptads.LeadSyncWebhookEventType

Member	Wire value	Description
`leadFormResponseCreated`	`lead_form.response.created`	No source description.

`LeadSyncWebhookMultipleChoiceResponseFieldType`

Values LeadSyncWebhookMultipleChoiceResponse.field_type accepts.

TypeSpec name: Chatgptads.LeadSyncWebhookMultipleChoiceResponseFieldType

Member	Wire value	Description
`multipleChoice`	`multiple_choice`	No source description.

`LeadSyncWebhookScalarResponseFieldType`

Values LeadSyncWebhookScalarResponse.field_type accepts.

TypeSpec name: Chatgptads.LeadSyncWebhookScalarResponseFieldType

Member	Wire value	Description
`email`	`email`	No source description.
`freeForm`	`free_form`	No source description.
`name`	`name`	No source description.
`phone`	`phone`	No source description.

`ListOrderParam`

Values ListOrderParam accepts.

TypeSpec name: Chatgptads.ListOrderParam

Member	Wire value	Description
`asc`	`asc`	No source description.
`desc`	`desc`	No source description.

`PartnerDataTypeParam`

Values PartnerDataTypeParam accepts.

TypeSpec name: Chatgptads.PartnerDataTypeParam

Member	Wire value	Description
`identity_graph`	`identity_graph`	No source description.

`ProductFeedSftpAuthenticationMethodParam`

Values ProductFeedSftpAuthenticationMethodParam accepts.

TypeSpec name: Chatgptads.ProductFeedSftpAuthenticationMethodParam

Member	Wire value	Description
`password`	`password`	No source description.
`ssh_key`	`ssh_key`	No source description.

`ProductFeedSftpAuthenticationMethodResource`

Values ProductFeedSftpAuthenticationMethodResource accepts.

TypeSpec name: Chatgptads.ProductFeedSftpAuthenticationMethodResource

Member	Wire value	Description
`password`	`password`	No source description.
`ssh_key`	`ssh_key`	No source description.

`ProductFeedsListIncludeParam`

Values ProductFeedsListIncludeParam accepts.

TypeSpec name: Chatgptads.ProductFeedsListIncludeParam

Member	Wire value	Description
`product_count`	`product_count`	No source description.

`ProductFeedUploadDiagnosticCodeResource`

Values ProductFeedUploadDiagnosticCodeResource accepts.

TypeSpec name: Chatgptads.ProductFeedUploadDiagnosticCodeResource

Member	Wire value	Description
`invalid_sftp_directory_layout`	`invalid_sftp_directory_layout`	No source description.
`invalid_value`	`invalid_value`	No source description.
`missing_required_column`	`missing_required_column`	No source description.
`unsupported_file_type`	`unsupported_file_type`	No source description.

`ProductFeedUploadDiagnosticSeverityResource`

Values ProductFeedUploadDiagnosticSeverityResource accepts.

TypeSpec name: Chatgptads.ProductFeedUploadDiagnosticSeverityResource

Member	Wire value	Description
`error`	`error`	No source description.
`warning`	`warning`	No source description.

`ProductFeedUploadStatusResource`

Values ProductFeedUploadStatusResource accepts.

TypeSpec name: Chatgptads.ProductFeedUploadStatusResource

Member	Wire value	Description
`completed`	`completed`	No source description.
`completed_with_errors`	`completed_with_errors`	No source description.
`failed`	`failed`	No source description.
`processing`	`processing`	No source description.
`received`	`received`	No source description.
`scanning`	`scanning`	No source description.
`skipped`	`skipped`	No source description.

`ProductSetFilterOperatorParam`

Values ProductSetFilterOperatorParam accepts.

TypeSpec name: Chatgptads.ProductSetFilterOperatorParam

Member	Wire value	Description
`contains`	`contains`	No source description.
`gt`	`gt`	No source description.
`gte`	`gte`	No source description.
`in`	`in`	No source description.
`lt`	`lt`	No source description.
`lte`	`lte`	No source description.
`not_contains`	`not_contains`	No source description.
`not_in`	`not_in`	No source description.
`starts_with`	`starts_with`	No source description.

`PublicLeadFormFieldTypeParam`

Values PublicLeadFormFieldTypeParam accepts.

TypeSpec name: Chatgptads.PublicLeadFormFieldTypeParam

Member	Wire value	Description
`choice`	`choice`	No source description.
`text`	`text`	No source description.

`ReviewStatus`

Values ReviewStatus accepts.

TypeSpec name: Chatgptads.ReviewStatus

Member	Wire value	Description
`approved`	`approved`	No source description.
`in_review`	`in_review`	No source description.
`rejected`	`rejected`	No source description.

`UploadBlobPurposeParam`

Values UploadBlobPurposeParam accepts.

TypeSpec name: Chatgptads.UploadBlobPurposeParam

Member	Wire value	Description
`custom_audience`	`custom_audience`	No source description.

`UploadImagePurposeParam`

Values UploadImagePurposeParam accepts.

TypeSpec name: Chatgptads.UploadImagePurposeParam

Member	Wire value	Description
`account_favicon`	`account_favicon`	No source description.

`Versions`

TypeSpec name: Chatgptads.Versions

Member	Wire value	Description
`v1`	`v1`	v1 baseline

Publication contract

Reviewed surface

Known representation boundaries

Models and fields

AccountIntegrityReviewBody

AccountIntegrityReviewDetailsBody

AdAccountCreationSessionResource

AdAccountResource

AdAccountSpendLimitWindowBody

AdAccountSpendLimitWindowsListResource

AdAccountsResource

AdAppealBody

AdGroupItemBody

AdGroupServingIssueBody

AdGroupsResource

AdImageCropBody

AdImageCropParams

AdItemBody

AdPreviewItemBody

AdPreviewResource

AdServingIssueBody

AdsOAuthMeResource

AdsResource

ArchivedProductFeedResource

BiddingConfigBody

BiddingConfigParams

BudgetBody

BudgetParams

BusinessAgentCatalogToolBody

BusinessAgentLeadFormSelectionBody

BusinessAgentLeadFormSelectionBodyParam

BusinessAgentListItemBody

BusinessAgentPreviewMessageBody

BusinessAgentPreviewResource

CampaignItemBody

CampaignServingIssueBody

CampaignsResource

ChatgptadsAuth

ClientDataSourceItemResource

ConversationalBottomOtmSpecBody

ConversionApiKeyResource

ConversionEventBody

ConversionEventSettingCampaignBody

ConversionEventSettingItemResource

ConversionEventSettingSourceBody

ConversionEventsResource

ConversionSummaryRowBody

ConversionSummaryRowsResource

CreateAdAccountCreationSessionBody

CreateAdAccountSpendLimitWindowBody

CreateAdBody

CreateAdCreativeParams

CreateAdGroupBody

CreateApiKeyBody

CreateApiKeyResource

CreateBusinessAgentBody

CreateCampaignBody

CreateConversionApiKeyBody

CreateConversionEventSettingBody

CreateConversionSourceBody

CreateCustomAudienceBody

CreatedLeadSyncSubscriptionResource

CreateLeadFormBody

CreateLeadFormFieldBodyParam

CreateLeadFormOptionBodyParam

CreateLeadSyncSubscriptionBody

CreatePartnerDataUploadBody

CreatePartnerDataUploadResource

CreateProductFeedBody

CreateTestLeadSubmissionBody

CustomAudienceBidMultiplierBody

CustomAudienceBidMultiplierParams

CustomAudienceInlineIdentifierParams

CustomAudienceItemBody

CustomAudienceMembershipMutationBody

CustomAudienceMembershipOperationBody

CustomAudiencesResource

DeleteAdAccountSpendLimitWindowResource

DeletedLeadSyncSubscriptionResource

GeoLookupEntry