Package google.shopping.merchant.conversions.v1beta

索引

• ConversionSourcesService（接口）
• AttributionSettings（消息）
• AttributionSettings.AttributionModel（枚举）
• AttributionSettings.ConversionType（消息）
• ConversionSource（消息）
• ConversionSource.Controller（枚举）
• ConversionSource.State（枚举）
• CreateConversionSourceRequest（消息）
• DeleteConversionSourceRequest（消息）
• GetConversionSourceRequest（消息）
• GoogleAnalyticsLink（消息）
• ListConversionSourcesRequest（消息）
• ListConversionSourcesResponse（消息）
• MerchantCenterDestination（消息）
• UndeleteConversionSourceRequest（消息）
• UpdateConversionSourceRequest（消息）

ConversionSourcesService

用于管理商家账号转化来源的服务。

CreateConversionSource
rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource) 创建新的转化来源。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

DeleteConversionSource
rpc DeleteConversionSource(DeleteConversionSourceRequest) returns (Empty) 归档现有转化来源。如果转化来源是 Merchant Center 目标账号，则可以在 30 天内恢复。如果转化来源是 Google Analytics 关联，系统会立即将其删除，您可以通过创建新的关联来恢复该转化来源。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

GetConversionSource
rpc GetConversionSource(GetConversionSourceRequest) returns (ConversionSource) 提取转化来源。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

ListConversionSources
rpc ListConversionSources(ListConversionSourcesRequest) returns (ListConversionSourcesResponse) 检索调用方有权访问的转化来源列表。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

UndeleteConversionSource
rpc UndeleteConversionSource(UndeleteConversionSourceRequest) returns (ConversionSource) 重新启用已归档的转化来源。仅适用于 Merchant Center 目标转化来源。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

UpdateConversionSource
rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource) 更新现有转化来源的信息。仅适用于 Merchant Center 目标转化来源。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

AttributionSettings

表示接收归因前数据的转化来源的归因设置。

字段
attribution_lookback_window_days	int32 必需。此来源中用于归因的回溯期（以天为单位）。支持的值为 7、30、40。
attribution_model	AttributionModel 必需。归因模型。
conversion_type[]	ConversionType 不可变。无序列表。转化事件可归类为的不同转化类型的列表。如果此列表在创建时为空，系统会自动创建标准的“购买”类型。

AttributionModel

此来源使用的归因模型。我们支持 Google Analytics 4 提供的一组模型，如 https://support.google.com/analytics/answer/10596866 中所述。

枚举
ATTRIBUTION_MODEL_UNSPECIFIED	未指定型号。
CROSS_CHANNEL_LAST_CLICK	“跨渠道最终点击”模型。
ADS_PREFERRED_LAST_CLICK	“首选 Google Ads 最终点击”模型。
CROSS_CHANNEL_DATA_DRIVEN	以数据为依据的跨渠道模型。
CROSS_CHANNEL_FIRST_CLICK	跨渠道首次点击模型。
CROSS_CHANNEL_LINEAR	跨渠道线性模型。
CROSS_CHANNEL_POSITION_BASED	跨渠道“根据位置”模型。
CROSS_CHANNEL_TIME_DECAY	跨渠道时间衰减模型。

ConversionType

表示转化事件类型的消息

字段
name	string 仅限输出。转化事件名称，客户端会报告此名称。
report	bool 仅限输出。用于指明应否在 Merchant Center 报告中包含相应类型的选项。

ConversionSource

表示商家账号拥有的转化来源。一个商家账号最多可以有 200 个转化来源。

字段
name	string 仅限输出。标识符。在创建新的 ConversionSource 时由 Content API 生成。格式：[a-z]{4}:.+ 英文冒号前的四个字符表示转化来源的类型。冒号后的内容表示相应类型中的转化来源的 ID。不同类型的两个转化来源的 ID 可能相同。支持以下类型前缀：- galk：适用于 GoogleAnalyticsLink 来源。- mcdn：适用于 MerchantCenterDestination 来源。
state	State 仅限输出。此转化来源的当前状态。无法通过 API 进行修改。
expire_time	Timestamp 仅限输出。归档的转化来源被永久删除且无法再取消删除的时间。
controller	Controller 仅限输出。转化来源的控制器。
联合字段 source_data。必需。特定于每种不同类型来源的转化来源数据。source_data 只能是下列其中一项：
google_analytics_link	GoogleAnalyticsLink 不可变。类型为“关联到 Google Analytics 媒体资源”的转化来源。
merchant_center_destination	MerchantCenterDestination 类型为“Merchant Center 代码目标位置”的转化来源。

控制器

控制转化来源的实体。

枚举
CONTROLLER_UNSPECIFIED	默认值。此值未使用。
MERCHANT	由拥有相应转化来源的商家控制。
YOUTUBE_AFFILIATES	由 YouTube 联属营销计划控制。

州

表示转化来源的状态。

枚举
STATE_UNSPECIFIED	转化来源的状态未指定。
ACTIVE	转化来源完全正常运行。
ARCHIVED	转化来源在过去 30 天内已归档，目前无法使用。可以使用取消删除方法恢复。
PENDING	转化来源的创建已开始，但尚未完全完成。

CreateConversionSourceRequest

CreateConversionSource 方法的请求消息。

字段
parent	string 必需。将拥有新转化来源的商家账号。格式：accounts/{account}
conversion_source	ConversionSource 必需。转化来源说明。系统会在创建时自动为其分配一个新 ID。

DeleteConversionSourceRequest

DeleteConversionSource 方法的请求消息。

字段
name	string 必需。要删除的转化来源的名称。格式：accounts/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

GetConversionSource 方法的请求消息。

字段
name	string 必需。要提取的转化来源的名称。格式：accounts/{account}/conversionSources/{conversion_source}

GoogleAnalyticsLink

您可以使用“Google Analytics 关联”来源将现有 Google Analytics 媒体资源中的转化数据导入关联的 Merchant Center 账号。

字段
property_id	int64 必需。不可变。商家关联的 Google Analytics 媒体资源的 ID。
attribution_settings	AttributionSettings 仅限输出。关联的 Google Analytics 媒体资源的归因设置。
property	string 仅限输出。商家关联到的 Google Analytics 媒体资源的名称。

ListConversionSourcesRequest

ListConversionSources 方法的请求消息。

字段
parent	string 必需。拥有转化来源集合的商家账号。格式：accounts/{account}
page_size	int32 可选。在一页中返回的转化来源的数量上限。如果未指定 page_size，则系统会使用 100 作为默认值。最大值为 200。高于 200 的值将被强制转换为 200。无论是否分页，系统最多只会返回 200 个转化来源。
page_token	string 可选。页面令牌。
show_deleted	bool 可选。显示“已删除（已归档）”选项。

ListConversionSourcesResponse

ListConversionSource 方法的响应消息。

字段
conversion_sources[]	ConversionSource 转化来源列表。
next_page_token	string 用于提取下一页结果的令牌。

MerchantCenterDestination

借助“Merchant Center 目标账号”来源，您可以使用 Google 代码将来自网店的转化事件直接发送到创建该来源的 Merchant Center 账号。

字段
destination	string 仅限输出。Merchant Center 目标账号 ID。
attribution_settings	AttributionSettings 必需。用于 Merchant Center 目标账号的归因设置。
display_name	string 必需。商家为目标账号指定的显示名称。此名称用于在 Merchant Center 界面中标识转化来源。不得超过 64 个字符。
currency_code	string 必需。由 3 个字母组成的货币代码（ISO 4217）。货币代码用于指定发送到此目标位置的转化在 Merchant Center 中以哪种货币进行报告。

UndeleteConversionSourceRequest

UndeleteConversionSource 方法的请求消息。

字段
name	string 必需。要取消删除的转化来源的名称。格式：accounts/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

UpdateConversionSource 方法的请求消息。

字段
conversion_source	ConversionSource 必需。转化来源数据的新版本。格式：accounts/{account}/conversionSources/{conversion_source}
update_mask	FieldMask 可选。要更新的字段的列表。