REST Resource: accounts.dataSources

资源:DataSource

Merchant Center 账号的数据源

JSON 表示法
{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "input": enum (Input),
  "fileInput": {
    object (FileInput)
  },

  // Union field Type can be only one of the following:
  "primaryProductDataSource": {
    object (PrimaryProductDataSource)
  },
  "supplementalProductDataSource": {
    object (SupplementalProductDataSource)
  },
  "localInventoryDataSource": {
    object (LocalInventoryDataSource)
  },
  "regionalInventoryDataSource": {
    object (RegionalInventoryDataSource)
  },
  "promotionDataSource": {
    object (PromotionDataSource)
  }
  // End of list of possible types for union field Type.
}
字段
name

string

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

dataSourceId

string (int64 format)

仅限输出。数据源 ID。

displayName

string

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

input

enum (Input)

仅限输出。确定数据源的输入类型。根据输入的内容,某些设置可能不起作用。通过该 API 只能创建通用数据源。

fileInput

object (FileInput)

可选。仅当通过文件管理数据时,才会用到此字段。

联合字段 Type。数据源类型。Type 只能是下列其中一项:
primaryProductDataSource

object (PrimaryProductDataSource)

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

supplementalProductDataSource

object (SupplementalProductDataSource)

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

localInventoryDataSource

object (LocalInventoryDataSource)

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

regionalInventoryDataSource

object (RegionalInventoryDataSource)

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

promotionDataSource

object (PromotionDataSource)

必需。促销数据源。

PrimaryProductDataSource

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

JSON 表示法
{
  "channel": enum (Channel),
  "countries": [
    string
  ],
  "feedLabel": string,
  "contentLanguage": string
}
字段
channel

enum (Channel)

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

countries[]

string

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

feedLabel

string

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

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

另请参阅迁移到 Feed 标签

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

如果设置,数据源将仅接受与此组合匹配的商品。如果未设置,该数据源将接受没有此限制的商品。

contentLanguage

string

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

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

如果设置,数据源将仅接受与此组合匹配的商品。如果未设置,该数据源将接受没有此限制的商品。

频道

数据源渠道。

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

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

SupplementalProductDataSource

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

JSON 表示法
{
  "feedLabel": string,
  "contentLanguage": string
}
字段
feedLabel

string

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

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

另请参阅迁移到 Feed 标签

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

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

contentLanguage

string

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

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

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

LocalInventoryDataSource

本地商品目录数据源。

JSON 表示法
{
  "feedLabel": string,
  "contentLanguage": string
}
字段
feedLabel

string

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

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

另请参阅迁移到 Feed 标签

contentLanguage

string

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

RegionalInventoryDataSource

地区商品目录数据源。

JSON 表示法
{
  "feedLabel": string,
  "contentLanguage": string
}
字段
feedLabel

string

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

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

另请参阅迁移到 Feed 标签

contentLanguage

string

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

PromotionDataSource

促销数据源。

JSON 表示法
{
  "targetCountry": string,
  "contentLanguage": string
}
字段
targetCountry

string

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

促销活动仅面向部分国家/地区提供。

contentLanguage

string

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

输入

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

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

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

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

此类型的数据源是只读的。

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

FileInput

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

JSON 表示法
{
  "fetchSettings": {
    object (FetchSettings)
  },
  "fileName": string,
  "fileInputType": enum (FileInputType)
}
字段
fetchSettings

object (FetchSettings)

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

fileName

string

可选。数据源的文件名。对于 UPLOAD 文件输入类型而言是必需的。

fileInputType

enum (FileInputType)

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

FetchSettings

提取详细信息以传送数据源。

JSON 表示法
{
  "enabled": boolean,
  "dayOfMonth": integer,
  "timeOfDay": {
    object (TimeOfDay)
  },
  "dayOfWeek": enum (DayOfWeek),
  "timeZone": string,
  "frequency": enum (Frequency),
  "fetchUri": string,
  "username": string,
  "password": string
}
字段
enabled

boolean

可选。启用或暂停提取时间安排。

dayOfMonth

integer

可选。应在一个月中的哪一天 (1-31) 提取数据源文件。只能为每月频率设置此字段。

timeOfDay

object (TimeOfDay)

可选。应在一天中的哪个时段提取数据源文件。分和秒不受支持,将会被忽略。

dayOfWeek

enum (DayOfWeek)

可选。应在一周的哪一天提取数据源文件。只能为每周频率设置此字段。

timeZone

string

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

frequency

enum (Frequency)

必需。描述提取计划的频率。

fetchUri

string

可选。可从中提取数据源文件的网址。Google Merchant Center 支持使用 HTTP、HTTPS 或 SFTP 协议的自动定期上传,因此该值必须是使用这三种协议之一的有效链接。对于 Google 表格文件,此元素不可更改。

username

string

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

password

string

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

TimeOfDay

表示一天中的某个时间。日期和时区不重要,或在别处指定。API 可以选择允许闰秒。相关类型为 google.type.Dategoogle.protobuf.Timestamp

JSON 表示法
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
字段
hours

integer

一天中的小时(采用 24 小时制)。值应为 0 到 23。对于业务结束时间等场景,API 可以选择允许“24:00:00”一值。

minutes

integer

一天中某小时的分钟数。值必须是介于 0 和 59 之间的数字。

seconds

integer

时间的秒数部分。通常必须是介于 0 和 59 之间的数字。如果 API 允许闰秒,则 API 可以允许 60 一值。

nanos

integer

秒数的小数部分(以纳秒为单位)。值必须是介于 0 和 999999999 之间的数字。

DayOfWeek

表示星期几。

枚举
DAY_OF_WEEK_UNSPECIFIED 未指定星期几。
MONDAY 星期一
TUESDAY 星期二
WEDNESDAY 星期三
THURSDAY 星期四
FRIDAY 星期五
SATURDAY 星期六
SUNDAY 星期日

频率

必填字段因提取频率而异。对于每月提取时间安排,[星期几][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 系统会从配置的 [fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] 中提取该文件。
GOOGLE_SHEETS 系统会从 [fetchUri][google.shopping.content.bundles.DataSources.FileInput.FetchSettings.fetch_uri] 中指定的 Google 表格中提取该文件。

方法

create

为给定账号创建新的数据源配置。

delete

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

fetch

立即对 Merchant Center 账号中的数据源执行数据提取(即使在提取时间安排之外)。

get

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

list

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

patch

更新现有数据源配置。