- Resource: ConversionSource
- GoogleAnalyticsLink
- AttributionSettings
- AttributionModel
- ConversionType
- MerchantCenterDestination
- State
- Methods
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 ( |
Fields | |
---|---|
conversionSourceId |
Output only. Generated by the Content API upon creation of a new |
state |
Output only. Current state of this conversion source. Can't be edited through the API. |
expireTime |
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: |
|
googleAnalyticsLink |
Immutable. Conversion Source of type "accounts.link to Google Analytics Property". |
merchantCenterDestination |
Conversion Source of type "Merchant Center Tag Destination". |
GoogleAnalyticsLink
"Google Analytics accounts.link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account.
JSON representation |
---|
{
"propertyId": string,
"attributionSettings": {
object ( |
Fields | |
---|---|
propertyId |
Required. Immutable. ID of the Google Analytics property the merchant is linked to. |
attributionSettings |
Output only. Attribution settings for the linked Google Analytics property. |
propertyName |
Output only. Name of the Google Analytics property the merchant is linked to. |
AttributionSettings
Represents attribution settings for conversion sources receiving pre-attribution data.
JSON representation |
---|
{ "attributionLookbackWindowInDays": integer, "attributionModel": enum ( |
Fields | |
---|---|
attributionLookbackWindowInDays |
Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. |
attributionModel |
Required. Attribution model. |
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 |
Output only. Conversion event name, as it'll be reported by the client. |
includeInReporting |
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 ( |
Fields | |
---|---|
destinationId |
Output only. Merchant Center Destination ID. |
attributionSettings |
Required. Attribution settings being used for the Merchant Center Destination. |
displayName |
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 |
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 |
|
---|---|
|
Creates a new conversion source. |
|
Archives an existing conversion source. |
|
Fetches a conversion source. |
|
Retrieves the list of conversion sources the caller has access to. |
|
Updates information of an existing conversion source. |
|
Re-enables an archived conversion source. |