API的对话:检索并提交消费者生成的内容(CGC),检索您的产品目录和关于CGC的统计信息。
完整的提交
对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息,请参阅对话API文档主页.
内容
提交对产品的评论。
概述
提交分为以下三个HTTP操作,由行动
参数:
行动 | 描述 | HTTP方法 |
---|---|---|
Action = |
Response表示创建提交表单所需的字段。的行动 该参数为可选参数。 |
GET、POST |
Action =预览 |
用于验证提交。响应将包括失败时的错误。数据将不会被存储。 | GET、POST |
Action =提交 |
成功时将存储数据,响应将包括提交ID。在失败时响应将包含错误。 | 帖子 |
Action =提交
可能会在没有第一次执行的情况下发生Action =
和Action =预览
.
例子
查看评审提交表单
https:// (stg) api.bazaarvoice.com/data/submitreview。(格式)? ApiVersion = [latestApiVersion] &ProductId = [productId]万能钥匙= [yourKey]
这个操作可以通过HTTP POST或GET来完成。
查看预先填充了用户数据的评审提交表单
https:// (stg) api.bazaarvoice.com/data/submitreview。(格式)? ApiVersion = [latestApiVersion] &ProductId = [productId]万能钥匙= (yourKey)和用户|标识= [valueOfUserOrUserId]
预览评论提交
https:// (stg) api.bazaarvoice.com/data/submitreview。(格式)? ApiVersion = [latestApiVersion] &ProductId = [productId]行动= Preview&Rating =(评级)&ReviewText = [reviewText]标题=[标题]&UserNickname =(昵称)万能钥匙= [yourKey]
这个操作可以通过HTTP POST或GET来完成。
提交评论
POST /数据/ submitreview。json HTTP/1.1 Host: [stg.]api.bazaarvoice.com Content-Type: application/x-www-form-urlencoded X-Forwarded-For: [AuthorIPAddress]…ApiVersion = [latestApiVersion] &ProductId = [productId]行动= submit&Rating =(评级)&ReviewText = [reviewText]标题=[标题]&UserNickname =(昵称)万能钥匙= [yourKey] fp = [deviceFingerprint]
上面例子中的省略号(…)表示你的应用程序可能会生成其他头文件。
此操作必须采用HTTP POST的形式。
头
名字 | 描述 |
---|---|
内容类型 |
请求体的媒体类型。值必须为 要求该字段在所有API请求中都是必需的。 |
X-Forwarded-For |
内容作者IP地址。只有在从服务器执行提交时才需要这个报头。看到真实性教程获取更多信息。 根据Bazaarvoice真实性政策,您必须在每次投稿时附上作者IP地址。如果您未能在投稿时发送作者IP地址,Bazaarvoice可自行决定采取任何必要的行动以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。 警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。 |
你的应用可能会生成其他的头文件。
参数
名字 | 描述 | |
---|---|---|
(格式) |
响应格式(json)。 要求该字段在所有API请求中都是必需的。 |
|
行动 |
提交动作——' action =', ' action =Preview'或' action =Submit'。'Action='将显示可用于构建提交表单的信息,'Action=Preview'将显示要提交的内容的草稿;'Action=Submit'将提交内容。如果'Action=Submit',请求必须是HTTP POST。了解更多. |
|
ApiVersion |
API版本,例如5.4。 要求该字段在所有API请求中都是必需的。 |
|
AdditionalField_ < Dimension-External-Id > |
参数的一个具体示例可能是'AdditionalField_Seat',其值为'24F'(描述体育场或飞机上的座位号)。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
AgreedToTermsAndConditions |
布尔值,表示用户是否同意条款和条件。必需的,取决于客户端的设置。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
CampaignId |
可以与内容一起保存的任意文本,以指示捕获内容的车辆,例如“购后电子邮件”。 |
|
ContextDataValue_ < Dimension-External-Id > |
该参数的一些示例包括以下内容。每个后面都有可能的值。
谨慎根据每个客户端的配置,可能需要这个字段。 |
|
《外交政策》 |
内容作者的设备指纹。看到真实性教程获取更多信息。 根据Bazaarvoice真实性政策,您必须在每次提交时附上设备指纹。如果您未能在提交时发送设备指纹,Bazaarvoice可自行决定采取任何必要的行动,以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。 警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。 |
|
HostedAuthentication_AuthenticationEmail |
提交人收到确认邮件的邮箱地址。如果配置为使用托管电子邮件身份验证,则此参数为必选项。看到验证用户方法获取有关托管身份验证的详细信息。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
HostedAuthentication_CallbackUrl |
用户认证邮件中链接的URL。这应该指向一个登陆页面,其中存在一个web应用程序来完成用户身份验证过程。URL的主机必须是为客户端配置的域之一。电子邮件中的链接将包含一个用户身份验证令牌(authtoken),用于验证提交者。如果配置为使用托管电子邮件身份验证,则此参数为必选项。看到主持身份验证获取更多信息的教程。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
IsRecommended |
Value为真或假;默认为空-“真”或“假”回答“我会把这个推荐给一个朋友”。必需的,取决于客户端设置。 |
|
语言环境 |
中显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。 警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。 |
|
NetPromoterComment |
值是表示用户评论的文本,用于解释数字净推广者得分。 |
|
NetPromoterScore |
Value是介于1到10之间的正整数,表示在回答“您如何评价本公司?” |
|
PhotoCaption_ < n > |
Value是照片URL的标题文本,值与 |
|
万能钥匙 |
API密钥需要验证API用户和检查访问特定客户端数据的权限。 要求该字段在所有API请求中都是必需的。 |
|
PhotoUrl_ < n > |
值为aBazaarvoice使用数据API上传照片的URL,其中 |
|
ProductId |
提交该内容的产品的id。 要求该字段在所有API请求中都是必需的。 |
|
评级 |
值为1到5之间的正整数,表示审查的总体评分。 |
|
Rating_ < Dimension-External-Id > |
一个具体的例子可能是Rating_Quality,其中的值表示用户对产品质量的意见。取值为1 ~ 5之间的正整数,表示评级维度值。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
ReviewText |
值为回顾正文文本。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
SendEmailAlertWhenCommented |
布尔值,指示用户是否希望在对内容发布评论时得到通知。 | |
SendEmailAlertWhenPublished |
布尔值,指示用户是否希望在其内容发布时得到通知。 |
|
tag_ < Dimension-External-Id > _ < n > |
参数的一个具体例子可能是'tag_Pro_1'。有效值可以是任意形式的文本。 |
|
tagid_ < Dimension-External-Id > / < Tag-Label > |
布尔值,指示标记是否应用于用户。一个具体的例子可能是'tagid_Pro/EasyToUse=true'。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
标题 |
值为内容标题文本。 谨慎根据每个客户端的配置,可能需要这个字段。 |
|
用户 |
加密用户的值。这个参数说明 |
根据API密钥配置,使用User或UserId参数。这个操作可以通过HTTP POST或GET来完成。