REST Resource: conversionsources

  • Conversion sources allow Merchant Center accounts to receive conversion data from Google Analytics and websites using Google tags.

  • Conversion sources can be managed through the Content API for Shopping with methods to create, delete, retrieve, list, update and restore them.

  • Attribution settings, including lookback windows and models, can be configured for each conversion source to determine how conversions are attributed.

  • Conversion sources have different states, including active, archived, and pending, reflecting their operational status.

  • Google Analytics and Merchant Center Destination are the two types of conversion sources that can be created and linked.

Resource: ConversionSource

Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.

JSON representation 
{
  "conversionSourceId": string,
  "state": enum (State),
  "expireTime": string,

  // Union field source_data can be only one of the following:
  "googleAnalyticsLink": {
    object (GoogleAnalyticsLink)
  },
  "merchantCenterDestination": {
    object (MerchantCenterDestination)
  }
  // End of list of possible types for union field source_data.
}
Fields
conversionSourceId

string

Output only. Generated by the Content API upon creation of a new ConversionSource. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources.
state

enum (State)

Output only. Current state of this conversion source. Can't be edited through the API.
expireTime

string (Timestamp format)

Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete.
Union field source_data. Required. Conversion source data specific to each different type of source. source_data can be only one of the following:
merchantCenterDestination

object (MerchantCenterDestination)

Conversion Source of type "Merchant Center Tag Destination".

AttributionSettings

Represents attribution settings for conversion sources receiving pre-attribution data.

JSON representation 
{
  "attributionLookbackWindowInDays": integer,
  "attributionModel": enum (AttributionModel),
  "conversionType": [
    {
      object (ConversionType)
    }
  ]
}
Fields
attributionLookbackWindowInDays

integer

Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40.
attributionModel

enum (AttributionModel)
conversionType[]

object (ConversionType)

Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time.

AttributionModel

The attribution model used for this source. We support the same set of models offered by Google Analytics 4, as described in: https://support.google.com/analytics/answer/10596866.

Enums
ATTRIBUTION_MODEL_UNSPECIFIED
CROSS_CHANNEL_LAST_CLICK Cross-channel Last Click model.
ADS_PREFERRED_LAST_CLICK Ads-preferred Last Click model.
CROSS_CHANNEL_DATA_DRIVEN Cross-channel Data Driven model.
CROSS_CHANNEL_FIRST_CLICK Cross-channel First Click model.
CROSS_CHANNEL_LINEAR Cross-channel Linear model.
CROSS_CHANNEL_POSITION_BASED Cross-channel Position Based model.
CROSS_CHANNEL_TIME_DECAY Cross-channel Time Decay model.

ConversionType

Message representing a types of conversion events

JSON representation 
{
  "name": string,
  "includeInReporting": boolean
}
Fields
name

string

Output only. Conversion event name, as it'll be reported by the client.
includeInReporting

boolean

Output only. Option indicating if the type should be included in Merchant Center reporting.

MerchantCenterDestination

"Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created.

JSON representation 
{
  "destinationId": string,
  "attributionSettings": {
    object (AttributionSettings)
  },
  "displayName": string,
  "currencyCode": string
}
Fields
destinationId

string

Output only. Merchant Center Destination ID.
attributionSettings

object (AttributionSettings)

Required. Attribution settings being used for the Merchant Center Destination.
displayName

string

Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. Limited to 64 characters.
currencyCode

string

Required. Three-letter currency code (ISO 4217). The currency code defines in which currency the conversions sent to this destination will be reported in Merchant Center.

State

Enums
STATE_UNSPECIFIED
ACTIVE Conversion source is fully functional.
ARCHIVED Conversion source has been archived in the last 30 days and not currently functional. Can be restored using the undelete method.
PENDING Conversion source creation has started but not fully finished yet.

Methods

create

 Creates a new conversion source.

delete

 Archives an existing conversion source.

get

 Fetches a conversion source.

list

 Retrieves the list of conversion sources the caller has access to.

patch

 Updates information of an existing conversion source.

undelete

 Re-enables an archived conversion source.