Conversions

Create website conversion action — estimate

Price the request without executing it. Same body as POST /v1/messaging/ads/conversions/actions.

post/v1/messaging/ads/conversions/actions/estimate

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/ads/conversions/actions/estimate
  • Auth: HTTP bearer

Request body

namestring required
type'WEBPAGE' required

Only WEBPAGE is supported for creation today.

category'DEFAULT' | 'PAGE_VIEW' | 'PURCHASE' | 'SIGNUP' | 'DOWNLOAD' | 'ADD_TO_CART' | 'BEGIN_CHECKOUT' | 'SUBSCRIBE_PAID' | 'PHONE_CALL_LEAD' | 'IMPORTED_LEAD' | 'SUBMIT_LEAD_FORM' | 'BOOK_APPOINTMENT' | 'REQUEST_QUOTE' | 'GET_DIRECTIONS' | 'OUTBOUND_CLICK' | 'CONTACT' | 'ENGAGEMENT' | 'STORE_VISIT' | 'STORE_SALE' | 'QUALIFIED_LEAD' | 'CONVERTED_LEAD'

conversion_action.category. Defaults to DEFAULT on create.

accountIdstring required

SocialAccount ID. Must be a googleads account.

customerIdstring

Alias of adAccountId, kept for existing callers

adAccountIdstring

Platform ad account ID (Google customer ID, digits only). Resolved automatically when the connection has exactly one accessible customer.

countingType'ONE_PER_CLICK' | 'MANY_PER_CLICK'

ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).

defaultValuenumber

Default conversion value used when an event doesn't carry its own value.

primaryForGoalboolean

true = primary (counts toward bidding when its goal is biddable), false = secondary.

defaultCurrencystring

ISO 4217 currency of defaultValue (value_settings.default_currency_code).

alwaysUseDefaultValueboolean

When true, always use defaultValue and ignore any value sent with the event. Defaults to true when defaultValue is set.

viewThroughLookbackWindowDaysinteger

Days after an ad view a view-through conversion still counts.

clickThroughLookbackWindowDaysinteger

Days after an ad click a conversion still counts.

Response

Estimate

operationstring
estimated_creditsnumber
credits_to_reservenumber
estimated_usageobject
notestring nullable
sufficientboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.