Index
ConversionSourcesService
(interface)AttributionSettings
(message)AttributionSettings.AttributionModel
(enum)AttributionSettings.ConversionType
(message)ConversionSource
(message)ConversionSource.Controller
(enum)ConversionSource.State
(enum)CreateConversionSourceRequest
(message)DeleteConversionSourceRequest
(message)GetConversionSourceRequest
(message)GoogleAnalyticsLink
(message)ListConversionSourcesRequest
(message)ListConversionSourcesResponse
(message)MerchantCenterDestination
(message)UndeleteConversionSourceRequest
(message)UpdateConversionSourceRequest
(message)
ConversionSourcesService
Service for managing conversion sources for a merchant account.
CreateConversionSource |
---|
Creates a new conversion source.
|
DeleteConversionSource |
---|
Archives an existing conversion source. If the conversion source is a Merchant Center Destination, it will be recoverable for 30 days. If the conversion source is a Google Analytics Link, it will be deleted immediately and can be restored by creating a new one.
|
GetConversionSource |
---|
Fetches a conversion source.
|
ListConversionSources |
---|
Retrieves the list of conversion sources the caller has access to.
|
UndeleteConversionSource |
---|
Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.
|
UpdateConversionSource |
---|
Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.
|
AttributionSettings
Represents attribution settings for conversion sources receiving pre-attribution data.
Fields | |
---|---|
attribution_lookback_window_days |
Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. |
attribution_model |
Required. Attribution model. |
conversion_type[] |
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 |
Unspecified model. |
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
Fields | |
---|---|
name |
Output only. Conversion event name, as it'll be reported by the client. |
report |
Output only. Option indicating if the type should be included in Merchant Center reporting. |
ConversionSource
Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.
Fields | |
---|---|
name |
Output only. Identifier. 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. |
expire_time |
Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. |
controller |
Output only. Controller of the conversion source. |
Union field source_data . Required. Conversion source data specific to each different type of source. source_data can be only one of the following: |
|
google_analytics_link |
Immutable. Conversion Source of type "Link to Google Analytics Property". |
merchant_center_destination |
Conversion Source of type "Merchant Center Tag Destination". |
Controller
Entity controlling the conversion source.
Enums | |
---|---|
CONTROLLER_UNSPECIFIED |
Default value. This value is unused. |
MERCHANT |
Controlled by the Merchant who owns the Conversion Source. |
YOUTUBE_AFFILIATES |
Controlled by the YT Affiliates program. |
State
Represents state of the conversion source.
Enums | |
---|---|
STATE_UNSPECIFIED |
Conversion source has unspecified state. |
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. |
CreateConversionSourceRequest
Request message for the CreateConversionSource method.
Fields | |
---|---|
parent |
Required. The merchant account that will own the new conversion source. Format: accounts/{account} |
conversion_source |
Required. The conversion source description. A new ID will be automatically assigned to it upon creation. |
DeleteConversionSourceRequest
Request message for the DeleteConversionSource method.
Fields | |
---|---|
name |
Required. The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source} |
GetConversionSourceRequest
Request message for the GetConversionSource method.
Fields | |
---|---|
name |
Required. The name of the conversion source to be fetched. Format: accounts/{account}/conversionSources/{conversion_source} |
GoogleAnalyticsLink
"Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account.
Fields | |
---|---|
property_id |
Required. Immutable. ID of the Google Analytics property the merchant is linked to. |
attribution_settings |
Output only. Attribution settings for the linked Google Analytics property. |
property |
Output only. Name of the Google Analytics property the merchant is linked to. |
ListConversionSourcesRequest
Request message for the ListConversionSources method.
Fields | |
---|---|
parent |
Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account} |
page_size |
Optional. The maximum number of conversion sources to return in a page. If no |
page_token |
Optional. Page token. |
show_deleted |
Optional. Show deleted (archived) option. |
ListConversionSourcesResponse
Response message for the ListConversionSources method.
Fields | |
---|---|
conversion_sources[] |
List of conversion sources. |
next_page_token |
Token to be used to fetch the next results page. |
MerchantCenterDestination
"Merchant Center Destination" sources can be used to send conversion events from an online store using a Google tag directly to a Merchant Center account where the source is created.
Fields | |
---|---|
destination |
Output only. Merchant Center Destination ID. |
attribution_settings |
Required. Attribution settings being used for the Merchant Center Destination. |
display_name |
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. |
currency_code |
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. |
UndeleteConversionSourceRequest
Request message for the UndeleteConversionSource method.
Fields | |
---|---|
name |
Required. The name of the conversion source to be undeleted. Format: accounts/{account}/conversionSources/{conversion_source} |
UpdateConversionSourceRequest
Request message for the UpdateConversionSource method.
Fields | |
---|---|
conversion_source |
Required. The new version of the conversion source data. Format: accounts/{account}/conversionSources/{conversion_source} |
update_mask |
Required. List of fields being updated. |