package google.shopping.merchant.conversions.v1beta
Get desktop application:
View/edit binary Protocol Buffers messages
Service for managing conversion sources for a merchant account.
Creates a new conversion source.
message
conversionsources.proto:281Request message for the CreateConversionSource method.
string parent = 1
Required. The merchant account that will own the new conversion source. Format: accounts/{account}
optional conversion_source = 2
Required. The conversion source description. A new ID will be automatically assigned to it upon creation.
Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.
message
conversionsources.proto:298Request message for the UpdateConversionSource method.
optional conversion_source = 1
Required. The new version of the conversion source data. Format: accounts/{account}/conversionSources/{conversion_source}
optional update_mask = 2
Required. List of fields being updated.
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.
message
conversionsources.proto:310Request message for the DeleteConversionSource method.
string name = 1
Required. The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source}
Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.
message
conversionsources.proto:322Request message for the UndeleteConversionSource method.
string name = 1
Required. The name of the conversion source to be undeleted. Format: accounts/{account}/conversionSources/{conversion_source}
Fetches a conversion source.
message
conversionsources.proto:334Request message for the GetConversionSource method.
string name = 1
Required. The name of the conversion source to be fetched. Format: accounts/{account}/conversionsources/{conversion_source}
Retrieves the list of conversion sources the caller has access to.
message
conversionsources.proto:346Request message for the ListConversionSources method.
string parent = 1
Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account}
int32 page_size = 2
Optional. The maximum number of conversion sources to return in a page. If no `page_size` is specified, `100` is used as the default value. The maximum value is `200`. Values above `200` will be coerced to `200`. Regardless of pagination, at most `200` conversion sources are returned in total.
string page_token = 3
Optional. Page token.
bool show_deleted = 4
Optional. Show deleted (archived) option.
message
conversionsources.proto:371Response message for the ListConversionSources method.
repeated conversion_sources = 1
List of conversion sources.
string next_page_token = 2
Token to be used to fetch the next results page.
message
conversionsources.proto:180Represents attribution settings for conversion sources receiving pre-attribution data.
Used in: ,
int32 attribution_lookback_window_days = 1
Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40.
AttributionSettings.AttributionModel attribution_model = 2
Required. Attribution model.
repeated conversion_type = 3
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.
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.
Used in:
ATTRIBUTION_MODEL_UNSPECIFIED = 0
Unspecified model.
CROSS_CHANNEL_LAST_CLICK = 1
Cross-channel Last Click model.
ADS_PREFERRED_LAST_CLICK = 2
Ads-preferred Last Click model.
CROSS_CHANNEL_DATA_DRIVEN = 5
Cross-channel Data Driven model.
CROSS_CHANNEL_FIRST_CLICK = 6
Cross-channel First Click model.
CROSS_CHANNEL_LINEAR = 7
Cross-channel Linear model.
CROSS_CHANNEL_POSITION_BASED = 8
Cross-channel Position Based model.
CROSS_CHANNEL_TIME_DECAY = 9
Cross-channel Time Decay model.
message
conversionsources.proto:182Message representing a types of conversion events
Used in:
string name = 1
Output only. Conversion event name, as it'll be reported by the client.
bool report = 2
Output only. Option indicating if the type should be included in Merchant Center reporting.
message
conversionsources.proto:105Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.
Used as response type in: ConversionSourcesService.CreateConversionSource, ConversionSourcesService.GetConversionSource, ConversionSourcesService.UndeleteConversionSource, ConversionSourcesService.UpdateConversionSource
Used as field type in: , ,
oneof source_data
Required. Conversion source data specific to each different type of source.
google_analytics_link = 3
Immutable. Conversion Source of type "Link to Google Analytics Property".
merchant_center_destination = 4
Conversion Source of type "Merchant Center Tag Destination".
string name = 1
Output only. Identifier. 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.
ConversionSource.State state = 5
Output only. Current state of this conversion source. Can't be edited through the API.
optional expire_time = 6
Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete.
ConversionSource.Controller controller = 7
Output only. Controller of the conversion source.
Entity controlling the conversion source.
Used in:
CONTROLLER_UNSPECIFIED = 0
Default value. This value is unused.
MERCHANT = 1
Controlled by the Merchant who owns the Conversion Source.
YOUTUBE_AFFILIATES = 2
Controlled by the YT Affiliates program.
Represents state of the conversion source.
Used in:
STATE_UNSPECIFIED = 0
Conversion source has unspecified state.
ACTIVE = 1
Conversion source is fully functional.
ARCHIVED = 2
Conversion source has been archived in the last 30 days and not currently functional. Can be restored using the undelete method.
PENDING = 3
Conversion source creation has started but not fully finished yet.
message
conversionsources.proto:240"Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account.
Used in:
int64 property_id = 1
Required. Immutable. ID of the Google Analytics property the merchant is linked to.
optional attribution_settings = 2
Output only. Attribution settings for the linked Google Analytics property.
string property = 3
Output only. Name of the Google Analytics property the merchant is linked to.
message
conversionsources.proto:260"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.
Used in:
string destination = 1
Output only. Merchant Center Destination ID.
optional attribution_settings = 2
Required. Attribution settings being used for the Merchant Center Destination.
string display_name = 3
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.
string currency_code = 4
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.