Package google.shopping.merchant.datasources.v1beta

索引

DataSourcesService

用于管理主要数据源、补充数据源、商品目录和其他数据源的服务。如需了解详情，请参阅 Merchant Center 帮助文章。

CreateDataSource

rpc CreateDataSource(CreateDataSourceRequest) returns (DataSource)

为指定账号创建新的“数据源”配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。
DeleteDataSource

rpc DeleteDataSource(DeleteDataSourceRequest) returns (Empty)

从您的 Merchant Center 账号中删除数据源。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。
FetchDataSource

rpc FetchDataSource(FetchDataSourceRequest) returns (Empty)

立即（即使在提取时间表之外）对 Merchant Center 账号中的数据源执行数据提取。如果您每天需要调用此方法多次，则应改用商品服务更新商品数据。此方法仅适用于设置了文件输入的数据源。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

检索指定账号的数据源配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

列出指定账号的数据源配置。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。
UpdateDataSource

rpc UpdateDataSource(UpdateDataSourceRequest) returns (DataSource)

更新现有数据源配置。在更新掩码中设置但未在资源中提供的字段将被删除。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。

FileUploadsService

用于管理数据源文件上传的服务。

GetFileUpload

rpc GetFileUpload(GetFileUploadRequest) returns (FileUpload)

获取最新的数据源文件上传内容。文件上传仅接受 latest 别名。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/content

如需了解详情，请参阅 OAuth 2.0 概览。

CreateDataSourceRequest

CreateDataSource 方法的请求消息。

字段
parent

string

必需。将在其中创建此数据源的账号。格式：accounts/{account}
data_source

DataSource

必需。要创建的数据源。

DataSource

Merchant Center 账号的数据源。

字段
name

string

标识符。数据源的名称。格式：{datasource.name=accounts/{account}/dataSources/{datasource}}
data_source_id

int64

仅限输出。数据源 ID。
display_name

string

必需。Merchant Center 界面中显示的数据源名称。
input

Input

仅限输出。确定数据源的输入类型。根据输入内容，某些设置可能无法正常运行。只能通过 API 创建通用数据源。
file_input

FileInput

可选。仅当通过文件管理数据时，才会用到此字段。
联合字段 Type。数据源类型。Type 只能是下列其中一项：
primary_product_data_source

PrimaryProductDataSource

必需。本地商品和线上商品的主要数据源。
supplemental_product_data_source

SupplementalProductDataSource

必需。本地和在线商品的补充数据源。
local_inventory_data_source

LocalInventoryDataSource

必需。本地商品目录数据源。
regional_inventory_data_source

RegionalInventoryDataSource

必需。地区性商品目录数据源。
promotion_data_source

PromotionDataSource

必需。促销数据源。
product_review_data_source

ProductReviewDataSource

必需。商品评价数据源。
merchant_review_data_source

MerchantReviewDataSource

必需。商家评价数据源。

输入

确定数据源的输入类型。根据输入，某些设置可能不受支持。

枚举
INPUT_UNSPECIFIED 未指定输入。
API 表示主要通过 API 为其提供数据的数据源。
FILE 表示主要通过文件输入提供数据的数据源。仍可通过 API 提供数据。
UI

直接在 Merchant Center 中添加的商品的数据源。

您无法通过此 API 创建或更新此类数据源，只能通过 Merchant Center 界面进行操作。

此类型的数据源是只读的。
AUTOFEED 这也称为自动 Feed，用于自动构建商品数据。您可以通过“账号”软件包启用或停用此类数据源。

DataSourceReference

数据源引用可用于在数据源服务中管理相关数据源。

字段

联合字段 data_source_id。

data_source_id 只能是下列其中一项：
self

bool

应使用“self”来引用主要数据源本身。
primary_data_source_name

string

可选。主要数据源的名称。格式：accounts/{account}/dataSources/{datasource}
supplemental_data_source_name

string

可选。补充数据源的名称。格式：accounts/{account}/dataSources/{datasource}

DeleteDataSourceRequest

DeleteDataSource 方法的请求消息。

字段
name

string

必需。要删除的数据源的名称。格式：accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

FetchDataSource 方法的请求消息。

字段
name

string

必需。要提取的数据源资源的名称。格式：accounts/{account}/dataSources/{datasource}

FileInput

文件数据源专用的数据。对于其他数据源输入，此字段为空。

字段
fetch_settings

FetchSettings

可选。提取详细信息以传送数据源。它包含 FETCH 和 GOOGLE_SHEETS 文件输入类型的设置。必填字段因提取频率而异。
file_name

string

可选。数据源的文件名。对于 UPLOAD 文件输入类型，此属性为必填项。
file_input_type

FileInputType

仅限输出。文件输入的类型。

FetchSettings

提取详细信息以提交数据源。

字段
enabled

bool

可选。启用或暂停提取时间表。
day_of_month

int32

可选。应提取数据源文件的月份（1-31）。只能为每月频率设置此字段。
time_of_day

TimeOfDay

可选。应在一天中的哪个时段提取数据源文件。不支持分钟和秒，系统会忽略这些信息。
day_of_week

DayOfWeek

可选。应提取数据源文件的星期几。此字段只能针对每周频次进行设置。
time_zone

string

可选。用于时间表的时区。默认为世界协调时间 (UTC)。例如，“America/Los_Angeles”。
frequency

Frequency

必需。用于描述提取时间表的频率。
fetch_uri

string

可选。可提取数据源文件的网址。Google Merchant Center 支持使用 HTTP、HTTPS 或 SFTP 协议进行自动按计划上传，因此该值需要是使用这三种协议之一的有效链接。对于 Google 表格文件，此字段不可变。
username

string

可选。[提取网址][google.shopping.content.bundles.DataSources.FileInput.fetch_url] 的可选用户名。用于通过 SFTP 提交数据源。
password

string

可选。[提取网址][google.shopping.content.bundles.DataSources.FileInput.fetch_url]的选填密码。用于通过 SFTP 提交数据源。

频率

必填字段因提取频率而异。对于每月提取时间安排，[星期几][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] 和 [时段][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]。对于每周提取时间表，[星期][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] 和 [小时][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] 是必需的。对于每日提取时间表，只需提供 [小时][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] 即可。

枚举
FREQUENCY_UNSPECIFIED 未指定频率。
FREQUENCY_DAILY 提取每天进行一次。
FREQUENCY_WEEKLY 提取每周进行一次。
FREQUENCY_MONTHLY 系统会每月提取一次。

FileInputType

文件提交方式。

枚举
FILE_INPUT_TYPE_UNSPECIFIED 文件输入类型未指定。
UPLOAD 文件通过 SFTP、Google Cloud Storage 或在 Merchant Center 中手动上传。
FETCH 系统会从配置的 [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] 提取文件。
GOOGLE_SHEETS 系统会从 [fetch_uri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] 中指定的 Google 表格中提取文件。

FileUpload

特定数据源的文件上传，即在数据源处理完成时异步计算的特定时间戳的数据源检索结果。仅适用于文件数据源。

字段
name

string

标识符。所上传的数据源文件的名称。格式：{datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}
data_source_id

int64

仅限输出。数据源 ID。
processing_state

ProcessingState

仅限输出。数据源的处理状态。
issues[]

Issue

仅限输出。数据源中出现的问题列表。
items_total

int64

仅限输出。数据源中已处理的项数。
items_created

int64

仅限输出。数据源中已创建的项数。
items_updated

int64

仅限输出。数据源中已更新的项的数量。
upload_time

Timestamp

仅限输出。数据源文件的上传日期。

问题

数据源中发生错误，例如“价格无效”。

字段
title

string

仅限输出。问题的标题，例如“商品太大”。
description

string

仅限输出。错误说明，例如“您的数据源中包含的商品属性过多或商品过大。这些内容将被舍弃”。
code

string

仅限输出。错误的代码，例如“validation/invalid_value”。如果代码未知，则返回“?”。
count

int64

仅限输出。文件上传中出现该错误的次数。
severity

Severity

仅限输出。问题的严重程度。
documentation_uri

string

仅限输出。指向详细说明问题的文档链接（如果有）。

严重程度

问题的严重程度。

枚举
SEVERITY_UNSPECIFIED 未指定严重级别。
WARNING 问题在于警告。
ERROR 问题是错误。

ProcessingState

数据源的处理状态。

枚举
PROCESSING_STATE_UNSPECIFIED 未指定处理状态。
FAILED 无法处理数据源，或者所有项都存在错误。
IN_PROGRESS 数据源正在处理中。
SUCCEEDED 数据源已成功处理，但部分项可能存在错误。

GetDataSourceRequest

GetDataSource 方法的请求消息。

字段
name

string

必需。要检索的数据源的名称。格式：accounts/{account}/dataSources/{datasource}

GetFileUploadRequest

GetFileUploadRequest 方法的请求消息。

字段
name

string

必需。要检索的数据源文件上传内容的名称。格式：accounts/{account}/dataSources/{datasource}/fileUploads/latest

ListDataSourcesRequest

对 ListDataSources 方法的请求消息。

字段
parent

string

必需。要为其列出数据源的账号。格式：accounts/{account}
page_size

int32

可选。要返回的数据源数量上限。服务返回的值可能小于此值。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。如果未指定，则返回的数据源数将达到上限。
page_token

string

可选。从之前的 ListDataSources 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 ListDataSources 的所有其他参数必须与提供页面令牌的调用匹配。

ListDataSourcesResponse

ListDataSources 方法的响应消息。

字段
data_sources[]

DataSource

指定账号中的数据源。
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

LocalInventoryDataSource

本地商品目录数据源。

字段
feed_label

string

必需。不可变。提供本地商品目录的商品的 Feed 标签。

不得超过 20 个字符，且只能包含大写字母 (A-Z)、数字 (0-9) 和短划线 (-)。

另请参阅迁移到 Feed 标签。
content_language

string

必需。不可变。提供本地商品目录的商品的双字母 ISO 639-1 语言。

MerchantReviewDataSource

此类型没有字段。

商家评价数据源。

PrimaryProductDataSource

本地商品和在线商品的主要数据源。

字段
channel

Channel

必需。不可变。指定数据源渠道的类型。
countries[]

string

可选。商品可能展示的国家/地区。表示为 CLDR 地区代码。
default_rule

DefaultRule

可选。数据源的默认规则管理。如果设置，则关联的数据源将被替换。
feed_label

string

可选。不可变。在数据源级别指定的 Feed 标签。

不得超过 20 个字符，且只能包含大写字母 (A-Z)、数字 (0-9) 和短划线 (-)。

另请参阅迁移到 Feed 标签。

对于商品内容类型的数据源，feedLabel 和 contentLanguage 必须同时设置或同时取消设置。必须为包含文件输入的数据源设置此类属性。

如果设置了此属性，则数据源将仅接受与此组合匹配的商品。如果未设置，则数据源将接受不受此限制的商品。
content_language

string

可选。不可变。数据源中项的双字母 ISO 639-1 语言代码。

feedLabel 和 contentLanguage 必须同时设置或同时取消设置。只能为没有文件输入的数据源取消设置这些字段。

如果设置，数据源将仅接受与此组合匹配的商品。如果未设置，则数据源将接受不受此限制的商品。

频道

数据源渠道。

渠道用于区分不同产品行业的数据源。

枚举
CHANNEL_UNSPECIFIED 未指定。
ONLINE_PRODUCTS 在线产品。
LOCAL_PRODUCTS 本地商品。
PRODUCTS 用于本地商品和线上商品的统一数据源。注意：此渠道不支持通过 API 管理商品。

DefaultRule

数据源的默认规则管理。

字段
take_from_data_sources[]

DataSourceReference

必需。默认规则中关联的数据源列表。此列表按照联接数据的默认规则优先级排序。它可能不包含任何对 self 和补充数据源的引用，也可能包含多个对这些数据源的引用。

列表不得为空。

如需将数据源与默认规则相关联，您需要向此列表添加新引用（按顺序）。

如需解除数据源与默认规则的关联，您需要从此列表中移除给定引用。

更改此列表的顺序会导致默认规则中数据源的优先级发生变化。

例如，提供以下列表：[1001, self] 将从补充数据源 1001 获取属性值，如果 1001 中未设置该属性，则回退到 self。

ProductReviewDataSource

此类型没有字段。

商品评价数据源。

PromotionDataSource

促销数据源。

字段
target_country

string

必需。不可变。作为唯一标识符一部分使用的目标国家/地区。表示为 CLDR 地区代码。

促销活动仅适用于部分国家/地区。
content_language

string

必需。不可变。数据源中项的双字母 ISO 639-1 语言代码。

RegionalInventoryDataSource

地区性商品目录数据源。

字段
feed_label

string

必需。不可变。提供地区商品目录的商品的 Feed 标签。

不得超过 20 个字符，且只能包含大写字母 (A-Z)、数字 (0-9) 和短划线 (-)。

另请参阅迁移到 Feed 标签。
content_language

string

必需。不可变。提供地区商品目录的商品的双字母 ISO 639-1 语言。

SupplementalProductDataSource

本地商品和在线商品的补充数据源。创建后，您应确保将补充商品数据源关联到一个或多个主要商品数据源。

字段
referencing_primary_data_sources[]

DataSourceReference

仅限输出。在默认规则或自定义规则中与此数据源相关联的所有主要数据源的列表（已排序且去重）。在移除所有关联之前，无法删除补充数据源。
feed_label

string

可选。不可变。在数据源一级指定的 Feed 标签。

不得超过 20 个字符，且只能包含大写字母 (A-Z)、数字 (0-9) 和短划线 (-)。

另请参阅迁移到 Feed 标签。

对于具有商品内容类型的数据源，必须同时设置或取消设置 feedLabel 和 contentLanguage。

必须为具有 file input 的数据源设置这些属性。对于没有 file input 的数据源，必须取消设置这些字段。

如果设置了此属性，则数据源将仅接受与此组合匹配的商品。如果未设置，数据源将接受不受此限制约束的产品。
content_language

string

可选。不可变。数据源中项的双字母 ISO 639-1 语言代码。

feedLabel 和 contentLanguage 必须同时设置或同时取消设置。只能为没有文件输入的数据源取消设置这些字段。

如果设置了此属性，则数据源将仅接受与此组合匹配的商品。如果未设置，则数据源将接受不受此限制的商品。

UpdateDataSourceRequest

UpdateDataSource 方法的请求消息。

字段
data_source

DataSource

必需。要更新的数据源资源。
update_mask

FieldMask

必需。要更新的数据源字段的列表。

如果更新掩码中指定的字段在正文中未指定值，则系统会将其从数据源中删除。

不支持为完全替换数据源提供特殊“*”值。