REST Resource: accounts.regions

资源:区域

表示可用作 RegionalInventoryShippingSettings 服务目标的地理区域。您可以将区域定义为邮政编码的集合,在某些国家/地区,也可以使用预定义的地理位置定位条件来定义区域。如需了解详情,请参阅设置区域

JSON 表示法
{
  "name": string,
  "postalCodeArea": {
    object (PostalCodeArea)
  },
  "geotargetArea": {
    object (GeoTargetArea)
  },
  "regionalInventoryEligible": boolean,
  "shippingEligible": boolean,
  "displayName": string
}
字段
name

string

标识符。区域的资源名称。格式:accounts/{account}/regions/{region}

postalCodeArea

object (PostalCodeArea)

可选。用于定义地区区域的邮政编码列表。

geotargetArea

object (GeoTargetArea)

可选。用于定义区域区域的地理位置定位列表。

regionalInventoryEligible

boolean

仅限输出。指明该地区是否符合在地区商品目录配置中使用的条件。

shippingEligible

boolean

仅限输出。指明地区是否可以在配送服务配置中使用。

displayName

string

可选。地区的显示名称。

PostalCodeArea

用于定义地区区域的邮政编码列表。注意:可通过账号的 ShippingSettings.postalCodeGroups 资源访问使用邮政编码定义的所有地区。

JSON 表示法
{
  "regionCode": string,
  "postalCodes": [
    {
      object (PostalCodeRange)
    }
  ]
}
字段
regionCode

string

必需。CLDR 地区代码或邮政编码组所适用的国家/地区。

postalCodes[]

object (PostalCodeRange)

必需。邮政编码范围。

PostalCodeRange

用于定义地区区域的邮政编码范围。

JSON 表示法
{
  "begin": string,
  "end": string
}
字段
begin

string

必需。邮政编码或前缀* 格式的邮政编码,用于表示限定了该区域的范围的下限(含边界值)。示例值:941089410*9*

end

string

可选。邮政编码或格式为 prefix* 的模式,用于表示定义该区域的范围的上限(含边界值)。其长度必须与 postalCodeRangeBegin 相同:如果 postalCodeRangeBegin 为邮政编码,则 postalCodeRangeEnd 也必须是邮政编码;如果 postalCodeRangeBegin 是一种格式,则 postalCodeRangeEnd 必须是具有相同前缀长度的模式。可选:如果未设置,则区域定义为与 postalCodeRangeBegin 匹配的所有邮政编码。

GeoTargetArea

用于定义区域区域的地理位置定位列表。

JSON 表示法
{
  "geotargetCriteriaIds": [
    string
  ]
}
字段
geotargetCriteriaIds[]

string (int64 format)

必需。地理位置 ID 的非空列表。它们必须都属于相同的地点类型(例如州/省级行政区)。

方法

create

在 Merchant Center 账号中创建地区定义。

delete

从您的 Merchant Center 账号中删除地区定义。

get

检索 Merchant Center 账号中定义的地区。

list

列出了您的 Merchant Center 账号中的地区。

patch

更新 Merchant Center 账号中的地区定义。