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 概览。

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

必需。促销数据源。

输入

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

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

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

无法通过此 API 创建或更新此类型的数据源，只能通过 Merchant Center 界面创建或更新此类数据源。

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

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 表格中提取该文件。

GetDataSourceRequest

GetDataSource 方法的请求消息。

字段
name

string

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

ListDataSourcesRequest

ListDataSources 方法的请求消息。

字段
parent

string

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

int32

可选。要返回的数据源数量上限。服务返回的值可能小于此值。最大值为 1000；大于 1000 的值将被强制转换为 1000。如果未指定，则返回的数据源数将达到上限。
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 语言。

PrimaryProductDataSource

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

字段
channel

Channel

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

string

可选。商品可以展示的国家/地区。以 CLDR 地区代码表示。
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 本地产品和在线产品的统一数据源。

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

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

字段
feed_label

string

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

不得超过 20 个大写字母 (A-Z)、数字 (0-9) 和短划线 (-)。

另请参阅迁移到 Feed 标签。

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

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

string

可选。不可变。数据源中商品的双字母 ISO 639-1 语言。

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

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

UpdateDataSourceRequest

UpdateDataSource 方法的请求消息。

字段
data_source

DataSource

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

FieldMask

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

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

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