本参考指南会说明各种错误消息,并定义 Meta 业务插件 API 对象字段及其各种类型的结构。
使用此对象来定义 Meta 业务插件专属的流程,例如用以配置卖家的功能和设置。
字段 | 描述 |
---|---|
类型:setup | 必要。 卖家的 Meta 设置,例如他们的唯一标识符 ( |
| 必要。 Meta 业务插件在配置 Meta 业务插件工作流程时所用的配置对象。请参阅 |
类型:布尔值 | 必要。 将此值设置为 |
使用该对象来定义最终用户的 Meta 形象设置。
字段 | 描述 |
---|---|
类型:字符串 | 必要。 代表您客户企业的唯一企业编号。我们会将此编号用作唯一标识符。例如,如果卖家的公司名为“Fubar”,则“fubar-123”可以是其 |
类型:字符串 | 必要。 企业所在的时区。请参阅可使用的时区值。 |
类型:字符串 | 必要。 以三个字母表示的 ISO 货币代码,用于表示企业目录商品的默认货币。请参阅支持的货币代码。 |
类型:Enum {'ECOMMERCE', 'APPOINTMENTS', 'RESERVATIONS', 'FOOD_AND_DRINK', 'CREATIVE', 'ADS_TARGETING', 'LEAD_ADS', 'MEASUREMENT_AND_OPTIMIZATION'} | 必要。 企业所属的垂直领域。请参阅垂直领域清单。 |
类型:字符串 | 可选。 从 Meta 业务插件 v1 升级时需使用此字段。如果您是从 v1 迁至 v2,请联系您的 Meta 代表。 |
类型:字符串 | 对 需要经过 Instagram 手动审批的网域。示例: |
类型:枚举 | 可选。 通过这类渠道,合作伙伴可以邀请用户使用其中会涉及更多步骤或限制的功能:
合作伙伴应为所有商务流程( |
类型:字符串 | 可选。 用户现有商务管理平台的商务管理平台编号;合作伙伴可传送此编号,以便在设置流程中为用户预选此编号。 |
类型:字符串 | 可选。 用户现有广告帐户的广告帐户编号;合作伙伴可传送此编号,以便在设置流程中为用户预选此编号。 |
类型:字符串 | 可选。 用户现有 Facebook 公共主页的公共主页编号;合作伙伴可传送此编号,以便在设置流程中为用户预选此编号。 |
类型:字符串 | 可选。 用户现有 Instagram 业务主页的 Instagram 业务主页编号;合作伙伴可传送此编号,以便在设置流程中为用户预选此编号。 |
类型:字符串 | 可选。 用户现有 Meta Pixel 像素代码的 Pixel 像素代码编号;合作伙伴可传递此编号,以便在设置流程中为用户预选此编号。 |
类型:字符串 | 可选。 用户现有目录的目录编号;合作伙伴可传送此编号,以便在设置流程中为用户预选此编号。 |
类型:字符串 | 可选。 当应用名称和 |
| 可选。 此字段可用于指定 |
类型:枚举 | 可选。 此字段可用于预设企业要先安装一组特定功能。参数包括: ADS AR_COMMERCE CATALOG_ADS CHECKBOX_PLUGIN CHECKBOX_PLUGIN_MARKETING COLLABORATIVE_ADS CONVERSIONS_API CREATIVE CREATIVE_WITH_ASSETS CUSTOM_AUDIENCE CUSTOMER_DATA FB_SERVICES FB_SHOP IG_CREATORS_AS_SELLERS IG_SERVICES IG_SHOP LEAD_ADS MESSENGER_CHAT MESSENGER_MARKETING |
类型:枚举 | 可选。 此字段可用于选择是否向企业显示最基本的入门设置体验,例如“功能”菜单。 |
如果用户没有管理员访问权限,或者资产不符合与其他资产一同安装的资格,则系统会略过在这些字段中输入的内容:
使用 FBEFlowConfigData
字段指定 IG_CREATORS_AS_SELLERS
渠道的设置。
字段 | 描述 |
---|---|
类型:整数 | 可选。 要与 Meta 分享或所创建目录中的商品数量。 |
类型:枚举 | 可选。 此字段可用于预设企业要先安装一组特定功能。参数包括: ADS AR_COMMERCE CATALOG_ADS CHECKBOX_PLUGIN CHECKBOX_PLUGIN_MARKETING COLLABORATIVE_ADS CONVERSIONS_API CREATIVE CREATIVE_WITH_ASSETS CUSTOM_AUDIENCE CUSTOMER_DATA FB_SERVICES FB_SHOP IG_CREATORS_AS_SELLERS IG_SERVICES IG_SHOP LEAD_ADS MESSENGER_CHAT MESSENGER_MARKETING |
类型:枚举 | 可选。 此字段可用于选择是否向企业显示最基本的入门设置体验,例如“功能”菜单。 |
使用 business_config
对象为最终用户配置业务设置。其中包括 Messenger 等设置。每个字段都包含一个链接到下方对应表格的“类型”。
business_config
支持的字段字段 | 描述 |
---|---|
| 必要。 最终用户所属企业的信息。 |
| 可选。 最终用户的 Facebook 公共主页的 Messenger 聊天功能,例如 |
| 可选。 确定 Meta 业务插件是否应使用“推送”(Feed) 方法,从 |
| 可选。 最终用户公共主页的行动号召 (CTA) 按钮,例如 |
| 可选。 公共主页上的“精选”服务卡,例如 |
| 可选。 Instagram 行动号召功能所提供的功能,例如 |
| 可选。 Messenger 固定菜单功能所提供的功能,例如 |
| 可选。 用于确定是否已启用 Messenger 对话意向功能的功能。此字段仅适用于 |
使用 FBEBusinessPropertiesConfigData 对象配置企业名称。
字段 | 描述 |
---|---|
类型:字符串 | 必要。 企业名称。 |
使用 FBECatalogFeedConfigData 对象配置目录“推送”(Feed) 或用于更新目录的“拉取”(Pull) 方法。我们通常不推荐使用“拉取”(Pull) 方法,因为此方法会导致库存数据过时,直到之后再拉取数据时才能更新库存;不过,对于自行托管库存档案且档案供公开访问的较小型企业来说,此方法很有用。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:字符串 | 必要。 用于公开托管企业库存的网址(必须采用 CSV、TSV 或 XML 格式)。 |
使用 FBEPageCtaConfigData 对象配置公共主页的行动号召按钮,包括其中的实际文本、网址和说明。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:enum {'Book Now' | 'Buy Now' | 'Reserve' | 'Order Food'} | 必要。 在企业 Facebook 公共主页行动号召 (CTA) 按钮上显示的文本。 |
类型:字符串 | 必要。 企业 Facebook 公共主页行动号召 (CTA) 按钮所开启的网址。 |
类型:字符串 | 必要。 在企业 Facebook 公共主页行动号召按钮下方显示的次要文本。通常可按需要用于标明合作伙伴,例如“由合作伙伴提供支持”。 |
使用 FBEIGCtaConfigData 对象配置企业的 Instagram 行动号召 (CTA) 按钮。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:enum {'Book Now' | 'Buy Now' | 'Reserve' | 'Order Food'} | 必要。 在企业 Instagram 业务专页行动号召 (CTA) 按钮上显示的文本。 |
类型:字符串 | 必要。 企业 Instagram 业务专页行动号召 (CTA) 按钮所开启的网址。 |
使用 FBEMessengerMenuConfigData 对象配置企业的 Messenger 菜单行动号召 (CTA) 按钮。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:enum {'Book Now' | 'Buy Now' | 'Reserve' | 'Order Food'} | 必要。 用户向企业发送消息时,显示在 Messenger 固定菜单按钮上的文本。 |
类型:字符串 | 必要。 Messenger 固定菜单按钮所开启的网址。 |
使用 FBEPageCardConfigData 对象启用页面图卡功能,以显示企业的精选服务。推荐 APPOINTMENTS
垂直领域使用。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:enum {'See All'} | 必要。 显示在精选服务页面图卡底部面板的文本,此类图卡会将用户导航至外部网址。目前仅支持“查看全部”。 |
类型:字符串 | 必要。 精选服务页面图卡底部面板所开启的网址。 |
类型:enum {'Book'} | 必要。 在各所示商品的行动号召 (CTA) 按钮上显示的文本。目前仅支持“预约”。 |
使用 FBEMessengerChatConfigData 对象配置公共主页的 Messenger 聊天选项。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:vec<string> | 必要。 可显示客户聊天插件的有效网址清单。每个网址均应为有效网址,且附上协议编号。例子: 例子: |
使用 FBEThreadIntentConfigData 对象,根据用户意向配置 Messenger 回复。推荐 APPOINTMENTS
垂直领域使用。
字段 | 描述 |
---|---|
类型:布尔值 | 必要。 启用或停用功能的标记。 |
类型:字符串 | 必要。 在 Messenger 建议中发送给用户的网址,用户可通过此网址向企业作出预约。 |
参数 | 描述 |
---|---|
类型:布尔值 | 当 |
类型:字符串 | 请求中的商品类型 ( |
类型:对象 | 包含所有请求的 JSON 对象。 |
类型:对象 | 包含商品字段及值的 JSON 对象。
|
类型:字符串 |
|
类型:字符串 | 广告主提供的商品的 |
requests.data
所支持的字段字段和类型 | 描述 |
---|---|
类型:字符串 | 必要。 服务的第三方标识符。 |
类型:字符串 | 必要。 服务名称。字符数上限:200 |
类型:字符串 | 必要。 服务的简短说明。字符数上限:9,999 |
类型:枚举 | 服务价格类型:
|
类型:字符串 | 如果 服务成本。您必须使用 示例: |
类型:枚举 | 如果是 服务时长类型:
|
类型:整数 |
服务时长。 |
类型:字符串 | 必要。 企业网站的链接,用户可借此预约服务。 |
类型:整数 | 可选。 索引,用于选择是否维持某服务在所属目录中相对于其他服务的顺序。 |
类型:对象 | 可选。 项目数量上限:20 这项服务的图像数据。 您可以为服务提供最多 20 张图像。每张图像包含两个字段: 请参阅 Image 对象参数 |
字段名称和类型 | 描述 |
---|---|
类型:字符串 | 必要。 服务图像的网址。 所有图像必须为 JPG、GIF 或 PNG 格式。 |
类型:字符串 | 可选。 说明服务内容的字符串。一张图像可以关联多个标签。 |
下表列出了 timezone
字段可接受的值。
Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville | America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral | Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon CET Chile/Continental Chile/EasterIsland CST6CDT Cuba EET Egypt Eire EST EST5EDT Etc/GMT Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad | Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich Factory GB GB-Eire GMT GMT-0 GMT+0 GMT0 Greenwich Hongkong HST Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya MET Mexico/BajaNorte Mexico/BajaSur Mexico/General MST MST7MDT Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC PST8PDT ROC ROK Singapore Turkey UCT Universal US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa UTC W-SU WET Zulu |