Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 4.18 KB

File metadata and controls

85 lines (53 loc) · 4.18 KB

CreateConversionDestinationRequest

Properties

Name Type Description Notes
adAccountId String Ad account ID. For LinkedIn: numeric (e.g. "5123456") or full `urn:li:sponsoredAccount:{id}` URN. For Google: numeric customer ID (e.g. "1234567890") or `customers/{id}` form.
name String
type String Conversion type. For LinkedIn: a unified standard event name (e.g. "Purchase", "Lead", "AddToCart") or a LinkedIn rule type enum (e.g. "PURCHASE", "QUALIFIED_LEAD"). For Google: a unified standard event name (Purchase, Subscribe, CompleteRegistration, Lead, Schedule) or a Google ConversionActionCategory enum value directly (e.g. "PURCHASE", "SUBSCRIBE_PAID", "SIGNUP", "IMPORTED_LEAD", "BOOK_APPOINTMENT"). Unknown values pass through to the platform.
attributionType AttributionTypeEnum LinkedIn only. [optional]
postClickAttributionWindowSize PostClickAttributionWindowSizeEnum LinkedIn only. Default 30. 365 only allowed for LEAD, PURCHASE, ADD_TO_CART, QUALIFIED_LEAD, SUBMIT_APPLICATION rule types; the API rejects other combinations locally. [optional]
viewThroughAttributionWindowSize ViewThroughAttributionWindowSizeEnum LinkedIn only. Default 7. Same 365-day-window type restriction applies as `postClickAttributionWindowSize`. [optional]
valueType ValueTypeEnum LinkedIn only. DYNAMIC (default) uses the per-event `value` from `sendConversions`. FIXED uses the rule's `value` field. NO_VALUE drops monetary value entirely. [optional]
value CreateConversionDestinationRequestValue [optional]
autoAssociationType AutoAssociationTypeEnum LinkedIn only. Controls campaign association at rule-creation time: - ALL_CAMPAIGNS: associate the rule with every active, paused, and draft campaign in the ad account - OBJECTIVE_BASED: associate only campaigns whose objective matches the rule's type - NONE: don't auto-associate. Manage associations via the `/associations` endpoints below. Note: auto-association runs once at create time; new campaigns added after the rule still need explicit association. [optional]
countingType CountingTypeEnum Google Ads only. Whether to count multiple conversions from the same click (MANY_PER_CLICK) or at most one (ONE_PER_CLICK). Defaults to MANY_PER_CLICK if omitted. [optional]
primaryForGoal Boolean Google Ads only. When true, the conversion action is marked as primary and immediately influences Smart Bidding. Defaults to false (secondary, record-only) to avoid unintentionally steering the customer's campaigns on creation. [optional]

Enum: AttributionTypeEnum

Name Value
LAST_TOUCH_BY_CAMPAIGN "LAST_TOUCH_BY_CAMPAIGN"
LAST_TOUCH_BY_CONVERSION "LAST_TOUCH_BY_CONVERSION"

Enum: PostClickAttributionWindowSizeEnum

Name Value
NUMBER_1 1
NUMBER_7 7
NUMBER_30 30
NUMBER_90 90
NUMBER_365 365

Enum: ViewThroughAttributionWindowSizeEnum

Name Value
NUMBER_1 1
NUMBER_7 7
NUMBER_30 30
NUMBER_90 90
NUMBER_365 365

Enum: ValueTypeEnum

Name Value
DYNAMIC "DYNAMIC"
FIXED "FIXED"
NO_VALUE "NO_VALUE"

Enum: AutoAssociationTypeEnum

Name Value
ALL_CAMPAIGNS "ALL_CAMPAIGNS"
OBJECTIVE_BASED "OBJECTIVE_BASED"
NONE "NONE"

Enum: CountingTypeEnum

Name Value
MANY_PER_CLICK "MANY_PER_CLICK"
ONE_PER_CLICK "ONE_PER_CLICK"