参考文档

使用此参考文档查看 POST /{catalog_id}/items_batch 端点和 POST /{catalog_id}/batch 的支持字段及相应示例。

虽然 /{catalog_id}/batch/{catalog_id}/items_batch 的参数名称可能看起来相似,但是这两个参数截然不同。

建议使用 /{catalog_id}/items_batch API,因为该 API 支持更多用例,同时我们会积极维护这一 API。

支持的字段 - 发送商品更新 - /{catalog_id}/batch

CREATEUPDATE 方法支持以下字段。

取消设置字段

更新商品时,如要取消设置某个可选字段,请提供空字符串作为该字段的值。如果将值设为 null不会取消设置此字段。

字段 描述

additional_image_urls

类型:

array<string>

非必要

最多 9 至 10 张不同图片的网址。

additional_variant_attributes

类型:

list<KeyValue:string,string>

非必要

用来区分商品款式组中某款商品的其他属性。

示例:{"Scent" : "Fruity", "Style" : "Classic"}

availability

类型:字符串

必要

表示库存状态:

  • in stock - 商品可立即发货。
  • out of stock - 无补货计划
  • available for order - 1 至 2 周后可发货
  • discontinued

age_group

类型:字符串

非必要

由年龄相同或相仿的用户构成的小组。接受的值为 newborninfanttoddlerkidsadult

applinks

类型:

对象数组

非必要

移动应用的链接。

category

类型:字符串

可选项;但建议为进阶赋能型目录广告使用此字段(可能有助于提升广告表现)。对于 Instagram 购物和公共主页店铺是可选项;如果在这些渠道启用站内结账功能(仅限美国),此字段则是必要项。对于 Marketplace,是必要项(仅限美国)

商品的 Google 商品类别 (GPC)。使用该类别的分类路径或编号,如此处所列。

如果您使用 Instagram 或 Facebook 快速结账(仅限美国),商品的 GPC 会影响其税费和退货政策。详细了解广告帮助中心 > 目录商品的 Google 商品类别

示例:Apparel & Accessories > Clothing > Shirts & Tops212

color

类型:字符串

非必要

字符数上限:100。

商品的颜色。

condition

类型:字符串

必要

商品的状态:newrefurbishedused

currency

类型:字符串

必要

指定值的货币。市场营销 API 支持广告账户支持的所有货币。使用 ISO 4217 作为货币标准。

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

类型:字符串

非必要

字符数上限:100

商品的其他信息。提供空字符串以取消设置。

description

类型:字符串

必要

字符数上限:5,000。

商品的简短描述。

gender

类型:字符串

非必要

尺寸适合的性别。值包括 malefemaleunisex

gtin

类型:字符串

非必要

字符数上限:70。

全球贸易商品代码可包括 UPCEANJANISBN

image_url

类型:字符串

必要

广告中所使用商品图片的链接。提供适当的图片尺寸。

对于包含一张图片的进阶赋能型目录广告

  • 图片分辨率的最低要求是 500px * 500px
  • 宽高比最低要求是 4:5
  • 宽高比最高要求是 1.91:1。

如果图片尺寸不符合宽高比要求,Facebook 将根据图片的原始宽高比,将图片裁剪为尽量接近宽高比最低要求或最高要求的尺寸。

对于包含轮播图片的进阶赋能型目录广告 - 图片分辨率的最低要求是 500px * 500px,并且 Facebook 会按照 1:1 的宽高比裁剪图片。

建议:避免频繁更改 image url。图片网址中不应该包含参数(例如 pricetimestamp),因为参数常常会发生变化。

inventory

类型:数字

非必要

整数,广告主可用来存储库存水平的相关信息。

marked_for_product_launch

类型:字符串

不适用于进阶赋能型目录广告。对于商业广告是可选项

表示是否会在商品发布计划中使用某件商品。支持的值:

  • marked:在创建商品发布计划之前,将对买家隐藏某件商品。这可以防止在预期的发布计划时间之前,买家就能查看和购买该商品。
  • not_marked(默认):该商品不会纳入商品发布计划中。

name

类型:字符串

必要

字符数上限:100。

商品的名称。

pattern

类型:字符串

非必要

字符数上限:100。

商品上的图案或印花。

price

类型:整数

必要

对于所有货币,此字段是将价格乘以 100 后得到的值。例如:490 与 USD 一起使用时,表示 $4.90;49,000 与 JPY 一起使用时,表示 ¥490。

product_type

类型:字符串

非必要

字符数上限:750。

零售商定义的商品类别。

示例:TSV 格式 - Home & Garden > Kitchen & Dining > Appliances > Refrigerators。

示例:XML 格式 - product_type > Home & Garden > Kitchen & Dining > Appliances > Refrigerators > product_type。

retailer_product_group_id

类型:字符串

非必要

可使用字符串。广告主可使用此字段对商品进行分组。

sale_price

类型:整数

非必要

促销商品的折扣价。对于所有货币,此字段是将优惠价乘以 100 后得到的值。例如:490 与 USD 一起使用时,表示 $4.90;49,000 与 JPY 一起使用时,表示 ¥490。

sale_price_start_date

类型:字符串

非必要

促销的结束日期和时间。

示例:2014-12-01T00:00-0300

sale_price_end_date

类型:字符串

非必要

促销的开始日期和时间。

示例:2014-11-01T12:00-0300

shipping

类型:

array<object>

非必要

配送信息。

size

类型:字符串

非必要

商品的尺寸。示例:SmallXL

url

类型:字符串

必要

可供买家购买商品的商家网站链接。

vendor_id

类型:字符串

非必要

出售商品的供应商或卖家的编号。

请求示例 - /{catalog_id}/batch

{
  "access_token": "<ACCESS_TOKEN>",
  "requests": [
    {
      "method": "DELETE",
      "retailer_id": "retailer-1"
    },
    {
      "method": "CREATE",
      "retailer_id": "retailer-2",
      "data": {
        "availability": "in stock",
        "brand": "Nike",
        "category": "t-shirts",
        "description": "product description",
        "image_url": "http://www.images.example.com/t-shirts/1.png",
        "name": "product name",
        "price": 1000,
        "currency": "USD",
        "shipping": [
           {
              "country": "US",
              "region": "CA",
              "service": "service",
              "price_value": "10",
              "price_currency": "USD"
           }
        ],
        "condition": "new",
        "url":"http://www.images.example.com/t-shirts/1.png",
        "retailer_product_group_id": "product-group-1"
      },
      "applinks": {
          "android": [{
              "app_name": "Electronic Example Android",
              "package": "com.electronic",
              "url": "example-android://electronic"
              }],
          "ios": [{
              "app_name": "Electronic Example iOS",
              "app_store_id": 2222,
              "url": "example-ios://electronic"
              }]
      },
    },
    {
      "method": "UPDATE",
      "retailer_id": "retailer-3",
      "data": {
        "availability": "out of stock",
      }
    }
  ]
}

响应示例 - /{catalog_id}/batch

系统将返回一个或多个句柄。

"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch

支持的字段 - 发送商品更新 - /{catalog_id}/items_batch

对于商品目录:如果您更新商品信息的频率高于每小时一次,请使用此 API(如果低于该频率,请使用动态 API)。您可通过单个 HTTP 请求更新多种商品。

PRODUCT_ITEM

CREATEUPDATE 方法支持以下商品字段(适用于 3.3 和 3.2 版本)

字段描述

additional_image_link

类型:

array<string>

非必要

最多 9 至 10 张不同图片的链接。

additional_variant_attribute

类型:

list<KeyValue:string,string>

非必要

用来区分商品款式组中某款商品的其他属性。

示例:"Scent:Fruity,Flavor:Apple"

age_group

类型:字符串

非必要

由年龄相同或相仿的用户构成的小组。接受的值为 newborninfanttoddlerkidsadult

applink

类型:

object<string>

非必要

移动应用的链接。

示例:

"applink" : {
  "ios_url": "example-ios://electronic",
  "ios_app_store_id": "42",
  "ios_app_name": "Electronic Example iOS",
  "iphone_url": "example-iphone://electronic",
  "iphone_app_store_id": "43",
  "iphone_app_name": "Electronic Example iPhone",
  "ipad_url": "example-ipad://electronic",
  "ipad_app_store_id": "44",
  "ipad_app_name": "Electronic Example iPad",
  "android_url": "example-android://electronic",
  "android_package": "com.electronic",
  "android_class": "com.electronic.Example",
  "android_app_name": "Electronic Example Android",
  "windows_phone_url": "example-windows://electronic",
  "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
  "windows_phone_app_name": "Electronic Example Windows",
}

availability

类型:字符串

必要

表示库存状态:

  • in stock - 商品可立即发货
  • out of stock - 无补货计划
  • available for order - 1 至 2 周后可发货
  • discontinued

brand

类型:字符串

非必要

商品的品牌。

color

类型:字符串

非必要

字符数上限:100。

商品的颜色。

condition

类型:字符串

必要

商品的状态:newrefurbishedused

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

类型:字符串

非必要

字符数上限:100

商品的其他信息。

description

类型:字符串

必要

字符数上限:5,000。

描述商品的简短文本。

disabled_capabilities

类型:

array<string>

非必要

由要禁用的功能组成的清单。可能的值是:marketplaceb2c_marketplacebuy_on_facebookcpas_parent_catalogmarketplace_shopsshopsdaily_dealsig_onsite_shoppingig_product_taggingc2c_marketplacegroupsprofiledawhatsappldpmini_shopsbusiness_inbox_in_messengerneighborhoodstest_capability

gender

类型:字符串

非必要

尺寸适合的性别。值包括 malefemaleunisex

google_product_category

类型:字符串

非必要

字符数上限:250。

来自 Google 产品分类的预定义值(字符串或类别编号)。

示例:“Apparel & Accessories > Clothing > Dresses”或“2271”。

gtin

类型:字符串

非必要

字符数上限:70。

全球贸易商品代码 (GTIN) 可包括 UPCEANJANISBN

id

类型:字符串

必要

零售商编号

image

类型:array<object>

要在广告或店铺中使用的图片的网址和标签。最多支持 20 张不同的图片。标签是可选项。如果使用标签,应描述图片中的内容。


示例:

"image": [
      {
        "url":"http://example.com/image_1.jpg",
        "tag": ['Swimming pool','Gym'],
      }
]

image_link

类型:字符串

如果提供了 image,此字段不是必要项

建议改为使用 image。如果提供 imageimage_linkadditional_image_link 会被忽略。

广告中所使用商品图片的链接。提供适当的图片尺寸。

对于包含一张图片的进阶赋能型目录广告

  • 图片分辨率的最低要求是 500px * 500px。
  • 宽高比最低要求是 4:5。
  • 宽高比最高要求是 1.91:1。如果图片尺寸不符合宽高比要求,Facebook 将根据图片的原始宽高比,将图片裁剪为尽量接近宽高比最低要求或最高要求的尺寸。

对于包含轮播图片的进阶赋能型目录广告:图片分辨率的最低要求是 500px * 500px,并且 Facebook 会按照 1:1 的宽高比裁剪图片。

internal_label

类型:字符串

添加内部标签,可在您创建商品系列时帮助筛选商品。例如,您可以为属于夏季促销的所有商品添加“夏季”标签,然后将这些商品筛选为一个系列。标签仅对您个人可见

请用单引号 (') 括起每个标签,并用逗号 (,) 分隔多个标签。标签的开头或结尾不要包含空格。字符数上限:每个商品最多 5,000 个标签,每个标签 110 个字符。

示例(TSV、XLSX、Google 表格):['summer','trending']

示例 (CSV):“['summer','trending']”

注意:如果您目前使用自定义标签(custom_label_0custom_label_4)来筛选商品系列,建议改用内部标签 (internal_label)。与自定义标签不同,您可以根据需要多次添加或更新内部标签,而无需每次都发送商品完成政策审核,从而避免对广告投放造成影响。

此字段之前被称为 product_tags。虽然之前的字段名称仍受支持,但建议您使用新名称。

inventory

类型:对象

非必要

整数,广告主可用来存储库存水平的相关信息。

item_group_id

类型:字符串

非必要

广告主提供的商品组编号,不是 Facebook 编号。可使用字符串。可供广告主用来对各种对象(例如商品、车辆、酒店、航班等)进行分组。

link

类型:字符串

必要

可供买家购买商品的商家网站链接。

manufacturer_part_number

类型:字符串

非必要

商品的独立制造商编号。

pattern

类型:字符串

非必要

字符数上限:100。

商品上的图案或印花。

price

类型:字符串

必要

商品的价格。将价格的格式设置为价格数值后加 3 位数 ISO 货币代码,价格数值与货币单位之间应留有一个空格。

示例:9.99 USD

rating_count

类型:数字

非必要

购买者为商品提供的评分次数。必须大于 0。应与 user_rating 一起使用。

示例:100

sale_price

类型:字符串

可选项;如果将叠加功能用于进阶赋能型目录广告,则为必要项

促销商品的折扣价。将价格的格式设置为价格数值后加 3 位数 ISO 货币代码,价格数值与货币单位之间应留有一个空格。

示例:9.99 USD25.00 EUR

sale_price_effective_date

类型:字符串

非必要

促销开始和结束的日期和时间,用斜线分隔。以 YYYY-MM-DD 的格式输入开始和结束日期。在每个日期后面添加“T”,然后注明时间。以 24 小时制的格式(0:00 到 23:59)提供时间。

示例:2014-11-01T12:00-0300/2014-12-01T00:00-0300

shipping

类型:字符串

非必要

与各个国家和地区的相应价格组合在一起。不同地区之间用英文逗号隔开。格式应为 COUNTRY:STATE:SHIPPING_TYPE:PRICE

示例:US:CA:Ground:9.99 USD, US:NY:Air:15.99 USD

size

类型:字符串

非必要

商品的尺寸。示例:SmallXL

title

类型:字符串

必要

字符数上限:100。

商品的名称。

user_rating

类型:数字

非必要

购买者为商品提供的平均评分。值介于 1.0 到 5.0 之间。允许小数点后一位数。应与 rating_count 一起使用。

示例:4.5

video

类型:array<object>

要在广告或店铺中使用的视频的网址和标签。在目录层级最多支持 30,000 个视频。标签是可选项。如果使用标签,应描述视频中的内容。


视频文件大小不得超过 200 MB。支持的格式包括 .3g2、.3gp、.3gpp、.asf、.avi、.dat、.divx、.dv、.f4v、.flv、.gif、.m2ts、.m4v、.mkv、.mod、.mov、.mp4、.mpe、.mpeg、.mpeg4、.mpg、.mts、.nsv、.ogm、.ogv、.qt、.tod、.ts、.vob 和 .wmv


示例:

"video": [
      {
        "url":"http://example.com/video_1.mp4",
        "tag": ['Swimming pool','Gym'],
      }
]

注意:当商品中包含视频 1 和视频 2 时,如要删除视频 1,请从该数组中移除视频 1:

[
  {
    "method": "UPDATE",
    "data": {
      "video": [
        {
          "url": "https://google.com/video_2.mp4",
          "tag": ["video_2"]
        }
      ]
    }
  }
]

如要删除所有视频,请发送空数组:

[
  {
    "method": "UPDATE",
    "data": {
      "video": []
    }
  }
]

UPDATE 方法也可以用于创建当前不存在的商品。

如需进一步了解商品字段,请参阅 API 参考文档

请求示例 - PRODUCT_ITEM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "PRODUCT_ITEM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "id": "retailer-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "id": "retailer-2",
            "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "availability": "in stock",
          "brand": "Nike",
          "google_product_category": "t-shirts",
          "description": "product description",
          "image_link": "http://www.images.example.com/t-shirts/1.png",
          "title": "product name",
          "price": "10.00 USD",
          "shipping": [
               {
                  "shipping_country": "US",
                  "shipping_region": "CA",
                  "shipping_service": "service",
                  "shipping_price_value": "10",
                  "shipping_price_currency": "USD"
               }
          ],
          "condition": "new",
          "link":"http://www.images.example.com/t-shirts/1.png",
          "item_group_id": "product-group-1"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "availability": "out of stock",
          "id": "retailer-3",
        }
      }
    ]
  }

响应示例 - PRODUCT_ITEM

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

详细了解使用数据信息库添加目录商品


HOTEL

对于 HOTEL 类型,CREATEUPDATE 方法支持以下商品字段(适用于 3.2 版本)

字段描述

address

类型:

object<string>

必要

酒店地址。

applink

类型:

非必要

移动应用的链接。

base_price

类型:字符串

必要

酒店客房每晚的起价。将货币类型添加到价格中。将价格的格式设置为价格数值后加 ISO 货币代码,价格数值与货币单位之间应留有一个空格。示例:USD 表示美元。

brand

类型:字符串

非必要

连锁酒店的品牌。

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

类型:字符串

字符数上限:100

最多五个自定义字段,用于在创建商品系列时输入所需的任何附加信息,以作为商品筛选依据。例如,您可以使用一个自定义字段来表示构成某次夏季促销一部分的所有客房,然后将这些客房筛选到一个系列中。此字段支持输入任何文本值,包括数字。


示例:Summer Sale

补充信息库支持此字段。

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

类型:整数

此自定义字段包含任何数字相关附加信息,您最多可添加 5 个此类字段;在创建商品系列时,您可将这些字段的信息作为商品筛选依据。通过此字段,您可以在创建商品系列时按数字大小范围(大于小于)进行筛选。例如,您可以使用此字段来表示一个酒店的开业年份,然后将特定年份范围内的商品筛选到一个系列中。


此字段支持 0 到 4294967295 之间的整数,不支持负数(例如:-2)、小数(例如:5.5)或逗号形式(例如:10,000)。


示例:2022

description

类型:字符串

必要

字符数上限:5,000。

酒店的简短描述。

guest_rating

类型:

array<object>

非必要

酒店的客人评分。

hotel_id

类型:字符串

必要

酒店的独立编号。

image

类型:

array<object>

必要

要在广告中使用的图片的网址和标签。最多支持 20 张不同的图片。标签是可选项。如果使用标签,应描述图片中的内容。示例:"reception"

latitude

类型:字符串

必要

酒店所在地的纬度。

longitude

类型:字符串

必要

酒店所在地的经度。

loyalty_program

类型:字符串

非必要

用于酒店的积分计划。

margin_level

类型:字符串

非必要

酒店盈利能力指标,值介于 110 之间。

name

类型:字符串

必要

酒店名称。

neighborhood

类型:

array<string>

非必要

酒店的一个或多个周边地点。示例:SohoLas Vegas Strip。允许的周边地点数量上限:20。

phone

类型:字符串

非必要

包含国家/地区代码的电话号码。

sale_price

类型:字符串

非必要

酒店每晚的优惠价。可用于宣传酒店正常价格的折扣。必要:将货币类型添加到价格中。将价格的格式设置为价格数值后加 ISO 货币代码,价格数值与货币单位之间应留有一个空格。示例:USD 表示美元。

star_rating

类型:字符串

非必要

酒店星级评定。数字应介于 15 之间。

url

类型:字符串

必要

预订酒店客房的外部网站链接。

UPDATE 方法也可以用于创建当前不存在的商品。

请求示例 - HOTEL

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_id": "hotel-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_id": "1234",
          "brand": "Premium_brand",
          "description": "A very nice hotel",
          "name": "The best hotel",
          "base_price": "100.00 USD",
          "longitude":"42.10",
          "latitude":"42.10",
          "address": {
              "addr1":"100 Main Street",
              "city":"North Pole",
              "region":"ABC",
              "country":"US",
              "postal_code":"11111"
          },
          "guest_rating" : [
            {
                "rating_system":"tripAdvisor",
                "score":"7.8",
                "number_of_reviewers":"300",
                "max_score":"10",
            },
            {
                "rating_system":"Yelp",
                "score":"5.1",
                "number_of_reviewers":"123",
                "max_score":"10",
            },
          ],
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ],
          "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "loyalty_program":"Premium_program",
          "margin_level": "8",
          "phone":"+61 2-96027455",
          "star_rating":"4",
          "url":"http://www.images.example.com/t-shirts/1.png"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "base_price": "90.00 USD",
          "hotel_id": "hotel-3",
        }
      }
    ]
  }

响应示例 - HOTEL

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOTEL_ROOM

对于 HOTEL_ROOM 类型,CREATEUPDATE 方法支持以下商品字段(适用于 3.2 版本)

字段描述

base_price

类型:字符串

必要

1 个晚上的起价。货币应使用 ISO 4217 货币代码表示。

示例:9.99 USD

description

类型:字符串

必要

字符数上限:5,000。

描述客房的简短文本。

hotel_retailer_id

类型:字符串

必要

酒店零售商的独立编号。

hotel_room_id

类型:字符串

必要

酒店的独立编号。

image

类型:

array<object>

必要

客房图片。

name

类型:字符串

必要

字符数上限:100。

客房名称。

url

类型:字符串

必要

可供用户预订客房的广告主网站链接。

UPDATE 方法也可以用于创建当前不存在的商品。

请求示例 - HOTEL_ROOM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL_ROOM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-1",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-2",
          "description": "product description",
          "name": "product name",
          "base_price": "100 USD",
          "url": "http://www.example.com/t-shirts/1.html",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ]
      },
      {
        "method": "UPDATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-3",
          "base_price": "120 USD",
        }
      }
    ]
  }

响应示例 - HOTEL_ROOM

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

FLIGHT

对于 FLIGHT 类型,CREATEUPDATE 方法支持以下商品字段(适用于 3.2 版本)

字段描述

description

类型:字符串

非必要

字符数上限:5,000。

有关航班的描述。

destination_airport

类型:字符串

必要

航班的到达机场。应该以 IATA 代码的格式写入。

示例:SFO

destination_city

类型:字符串

非必要

航班到达城市的名称。

image

类型:

array<object>

必要

要在广告中使用的图片的网址和标签。最多支持 20 张不同的图片。标签是可选项。如果使用标签,应描述图片中的内容。

示例:seat

origin_airport

类型:字符串

必要

航班的出发机场。应该以 IATA 代码的格式写入。

示例:SFO

origin_city

类型:字符串

非必要

航班的出发城市名称。

price

类型:字符串

非必要

航班的价格数值和货币。将价格的格式设置为数字后加货币代码;货币应使用 ISO 4217 标准货币代码表示。请使用英文句点(“.”)作为价格的小数点。

url

类型:字符串

非必要

可预订航班的网站链接。

UPDATE 方法也可以用于创建当前不存在的商品。

请求示例 - FLIGHT

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "FLIGHT",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "JFK",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "SFO",
          "description": "Best Flight to SFO",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Food'],
            }
          ],
          "price":"100.00 USD",
        }
      },
      {
        "method": "UPDATE",
        "data": {

响应示例 - FLIGHT

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

DESTINATION

对于 DESTINATION 类型,CREATEUPDATE 方法支持以下商品字段(适用于 3.2 版本)

字段描述

applink

类型:

object<string>

非必要

移动应用的链接。

address

类型:

object<string>

必要

酒店地址。

description

类型:字符串

非必要

字符数上限:5,000。

描述目的地的简短段落。

destination_id

类型:字符串

必要

字符数上限:100。

目的地的独立编号。

image

类型:

array<object>

必要

要在广告中使用的图片的网址和标签。最多支持 20 张不同的图片。标签是可选项。如果使用标签,应描述图片中的内容。

示例:seat

latitude

类型:字符串

必要

目的地所在地的纬度。

longitude

类型:字符串

必要

目的地所在地的经度。

name

类型:字符串

必要

目的地名称。

neighborhood

类型:

array<string>

非必要

允许的周边地点数量上限:20。目的地的一个或多个周边地点。

示例:SohoLas Vegas Strip

price

类型:字符串

非必要

目的地的最低平均价格数值和货币。将价格的格式设置为数字后加货币代码;货币应使用 ISO 4217 标准货币代码表示。请使用英文句点(“.”)作为价格的小数点。

price_change

类型:字符串

非必要

价格变动。可用于商品系列构建流程和广告创意中:

  • 0 - 价格不变
  • -10 - 降价 10%
  • 20 - 涨价 20%。

示例:“纽约市平均价格下降 X”或“纽约市平均价格下降”

type

类型:

array<string>

必要

目的地类型数量上限:20。目的地类型。一个目的地可拥有多种类型。

示例:parkbeach

url

类型:字符串

必要

可预订目的地的网站链接。

UPDATE 方法也可以用于创建当前不存在的商品。

请求示例 - DESTINATION

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "DESTINATION",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "destination_id": "destination-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "destination_id": "123456789",
          "description": "My destination is the best.",
          "name": "The best destination",
          "price": "199.00 USD",
          "price_change": "-20",
          "longitude":"-122.4424",
          "latitude":"37.7712",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City','Package'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Tour','Landmark'],
            }
          ],
          "address": {
              "addr1":"1 Market Street",
              "city":"San Francisco",
              "region":"California",
              "country":"United States",
              "postal_code":"94117"
          },
          "applink" : {
            "ios_url":"example-ios://travelapp",
            "ios_app_store_id":"42",
            "ios_app_name":"Travel App iOS",
            "iphone_url":"example-iphone://travelapp",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Travel App iPhone",
            "ipad_url":"example-ipad://travelapp",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Travel App iPad",
            "android_url":"example-android://travelapp",
            "android_package":"com.travelapp",
            "android_class":"com.travelapp.Example",
            "android_app_name":"Travel App Android",
            "windows_phone_url":"example-windows://travelapp",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Travel App Windows",
          },
          "type":["city","culture"],
          "neighborhood":["Mission","SoMa"],
          "url":"http://www.thebestdestination.com"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "159.99",
          "destination_id": "destination-3",
        }
      }
    ]
  }

响应示例 - DESTINATION

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOME_LISTING

对于 HOME_LISTING 类型,CREATEUPDATE 方法支持以下商品字段(适用于 3.3 和 3.2 版本)

字段描述

applink

类型:

object<string>

非必要

移动应用的链接。

address

类型:

object<string>

必要

房源的街道地址。

availability

类型:字符串

必要

房源目前的库存状况。支持的值:for_salefor_rentsale_pendingrecently_soldoff_marketavailable_soon

available_dates_price_config

类型:

array<object>

非必要

价格配置。

description

类型:字符串

非必要

字符数上限:5,000。

描述房源的简短段落。

image

类型:

array<object>

必要

要在广告中使用的图片的网址和标签。最多支持 20 张不同的图片。标签是可选项。如果使用标签,应描述图片中的内容。

示例:pool

latitude

类型:字符串

非必要

房源所在地的纬度。

longitude

类型:字符串

非必要

房源所在地的经度。

listing_type

类型:字符串

非必要

房源类型。支持的值:for_rent_by_agentfor_rent_by_ownerfor_sale_by_agentfor_sale_by_ownerforeclosednew_constructionnew_listing

name

类型:字符串

必要

房源名称。

neighborhood

类型:

array<object>

非必要

房源的周边地点。允许的周边地点数量上限:20。

num_baths

类型:字符串

非必要

卫生间数量。

num_beds

类型:字符串

非必要

卧室数量。

num_units

类型:字符串

非必要

可租房源的数量。仅当租赁式公寓或私人公寓可供出租或租赁时使用。

price

类型:字符串

必要

房源的价格数值和货币。将价格的格式设置为数字后加货币代码;货币应使用 ISO 4217 标准货币代码表示。请使用英文句点(“.”)作为价格的小数点。

price_change

类型:字符串

非必要

价格变动。可用于商品系列构建流程和广告创意中:

  • 0 - 价格不变
  • -10 - 降价 10%
  • 20 - 涨价 20%。

示例:“纽约市平均价格下降 X”或“纽约市平均价格下降”

property_type

类型:字符串

非必要

房产类型。支持的值:apartmentcondohouselandmanufacturedothertownhouse

url

类型:字符串

必要

可查看房源的网站链接。

year_built

类型:字符串

非必要

房屋建造年份。

UPDATE 方法也可以用于创建当前不存在的商品。

请求示例 - HOME_LISTING

{
  "access_token": "<ACCESS_TOKEN>",
  "item_type": "HOME_LISTING",
  "requests": [
    {
      "method": "DELETE",
      "data": {
        "home_listing_id": "home-listing-1"
      }
    },
    {
      "method": "CREATE",
      "data": {
        "home_listing_id": "12345678",
        "availability": "for_sale",
        "description": "An amazing listing",
        "name": "1 Hacker Way, Menlo Park, CA 94025",
        "price": "110000 USD",
        "longitude":"1.11414",
        "latitude":"-1.835003",
        "address": {
            "addr1":"1 Hacker Way",
            "city":"Menlo Park",
            "region":"California",
            "country":"United States",
            "postal_code":"94025"
        },
        "neighborhood":["Menlo Oaks"],
        "image": [
          {
              "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg",
          },
        ],
        "listing_type": "for_sale_by_agent",
        "num_baths":"6",
        "num_beds":"5",
        "num_units":"1",
        "property_type":"house",
        "year_built":"2007",
        "available_dates_price_config" : [
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"10000",
              "currency":"USD",
              "interval":"nightly",
          },
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"50000",
              "currency":"USD",
              "interval":"weekly",
          },
        ],
        "applink" : {
          "ios_url":"example-ios://travelapp",
          "ios_app_store_id":"42",
          "ios_app_name":"Travel App iOS",
          "android_url":"example-android://travelapp",
          "android_package":"com.travelapp",
          "android_class":"com.travelapp.Example",
          "android_app_name":"Travel App Android",
        },
        "url":"http://www.example.com/link_to_listing"
      }
    },
    {
      "method": "UPDATE",
      "data": {
        "price": "100000 USD",
        "home_listing_id": "home-listing-3",
      }
    }
  ]
}

响应示例 - HOME_LISTING

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

VEHICLE

如需查看对于 VEHICLE 类型,CREATEUPDATE 方法支持的字段,请参阅汽车库存目录字段 - 汽车

支持的字段适用于汽车经销商

UPDATE 方法也可以用于创建当前不存在的商品。

请求示例 - VEHICLE

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "VEHICLE",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "vehicle_id": "vehicle-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "vehicle_id": "i2 2017 Ford Fusion",
          "availability": "AVAILABLE",
          "make": "Ford",
          "model": "Fusion",
          "year": "2017",
          "mileage": {
            "value": "1500",
            "unit": "KM",
          },
          "image": [
            {
                "url":"http://www.facebook.com/teapic.jpg",
                "tag":["Car"],
            },
          ],
          "fuel_type":"gasoline",
          "body_style":"sedan",
          "drivetrain":"FWD",
          "vin":"1FADP5AU6DL536022",
          "condition":"EXCELLENT",
          "description": "Turbocharged! Gasoline!",
          "title": "SE Ford Certified and 6-Speed Automatic.",
          "price": "18000 USD",
          "exterior_color":"white",
          "sale_price":"16000 USD",
          "state_of_vehicle":"new",
          "longitude":"52.35",
          "latitude":"42.1",
          "address": {
              "addr1":"550 Auto Center Dr",
              "city":"Watsonville",
              "region":"CA",
              "country":"US",
              "postal_code":"96075"
          },
          "url":"http://www.example.com/test"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "16000 USD",
          "vehicle_id": "vehicle-3",
        }
      }
    ]
  }

响应示例 - VEHICLE

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

支持的字段 - 发送本地化商品批次 - /{catalog_id}/localized_items_batch

有关 /{catalog_id}/localized_items_batch 端点,请参阅支持的字段清单及每个字段相应的描述:

请参阅目录支持的字段完整清单

详细了解