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)
  },
  "productReviewDataSource": {
    object (ProductReviewDataSource)
  },
  "merchantReviewDataSource": {
    object (MerchantReviewDataSource)
  }
  // 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)

必需。促销活动数据源。

productReviewDataSource

object (ProductReviewDataSource)

必需。商品评价数据源。

merchantReviewDataSource

object (MerchantReviewDataSource)

必需。商家评价数据源。

PrimaryProductDataSource

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

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

enum (Channel)

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

countries[]

string

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

defaultRule

object (DefaultRule)

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

feedLabel

string

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

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

另请参阅迁移到 Feed 标签

对于商品内容类型的数据源,feedLabelcontentLanguage 必须同时设置或同时取消设置。必须为具有文件输入的数据源设置这些参数。

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

contentLanguage

string

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

feedLabelcontentLanguage 必须同时设置或同时取消设置。只有不接受文件输入的数据源才能取消设置这些字段。

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

频道

数据源渠道。

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

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

DefaultRule

数据源的默认规则管理。

JSON 表示法
{
  "takeFromDataSources": [
    {
      object (DataSourceReference)
    }
  ]
}
字段
takeFromDataSources[]

object (DataSourceReference)

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

列表不得为空。

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

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

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

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

DataSourceReference

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

JSON 表示法
{

  // Union field data_source_id can be only one of the following:
  "self": boolean,
  "primaryDataSourceName": string,
  "supplementalDataSourceName": string
  // End of list of possible types for union field data_source_id.
}
字段

联合字段 data_source_id

data_source_id 只能是下列其中一项:

self

boolean

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

primaryDataSourceName

string

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

supplementalDataSourceName

string

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

SupplementalProductDataSource

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

JSON 表示法
{
  "referencingPrimaryDataSources": [
    {
      object (DataSourceReference)
    }
  ],
  "feedLabel": string,
  "contentLanguage": string
}
字段
referencingPrimaryDataSources[]

object (DataSourceReference)

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

feedLabel

string

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

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

另请参阅迁移到 Feed 标签

对于商品内容类型的数据源,必须同时设置或取消设置 feedLabelcontentLanguage

必须为使用 file input 的数据源设置这些属性。对于不含 file input 的数据源,必须取消设置这些字段。

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

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 语言代码。

ProductReviewDataSource

此类型没有字段。

商品评价数据源。

MerchantReviewDataSource

此类型没有字段。

商家评价数据源。

输入

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

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

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

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

此类数据源为只读。

AUTOFEED 这也称为自动 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

可选。fetchUri 的可选用户名。用于通过 SFTP 提交数据源

password

string

可选。fetchUri 的可选密码。用于通过 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,且小于或等于 999,999,999。

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_SHEETS 系统会从 fetchUri 中指定的 Google 表格中提取文件。

方法

create

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

delete

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

fetch

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

get

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

list

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

patch

更新现有数据源配置。