Package google.shopping.merchant.conversions.v1beta

索引

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

不可变。无序列表。列出了转化事件可归为的不同转化类型。如果创建时此列表为空，系统会自动创建一个标准的“purchase”类型。

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 只能是下列其中一项：
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}

ListConversionSourcesRequest

ListConversionSources 方法的请求消息。

字段
parent

string

必需。拥有转化来源集合的商家账号。格式：accounts/{account}
page_size

int32

可选。一个页面中要返回的转化来源数量上限。如果未指定 page_size，则系统会使用 100 作为默认值。最大值为 200。大于 200 的值将被强制转换为 200。无论分页如何，总共最多返回 200 个转化来源。
page_token

string

可选。页面令牌。
show_deleted

bool

可选。显示已删除（已归档）的选项。

ListConversionSourcesResponse

ListConversionSources 方法的响应消息。

字段
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

必需。要更新的字段列表。