Conversions

Create website conversion action

Creates a Google Ads website conversion action and returns the tag snippets to install on your site.

Creates a WEBPAGE conversion action (category DEFAULT) and returns it with its tag snippets, read back after creation since Google never returns them on the create response itself. Invalidates the cached list GET on this resource would otherwise keep serving. Google-only; other platforms return 501. Requires the Ads add-on.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/ads/conversions/actions

Request

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

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

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

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

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