Bazaarvoice开发者门户网站|评论提交

⚠

只有API键在我们的对话PRR平台都有资格使用这个API版本。请参阅平台本处平台和API概念文档，以了解您的API密钥在哪个平台上。

对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息，请参阅对话API文档主页．

内容

（+显示 ——隐藏）

提交对审查的评论

概述

提交分为以下三个HTTP操作，由行动参数:

行动	描述	HTTP方法
`Action =`	Response表示创建提交表单所需的字段。的`行动`该参数为可选参数。	GET、POST
`Action =预览`	用于验证提交。响应将包括失败时的错误。数据将不会被存储。	GET、POST
`Action =提交`	成功时将存储数据，响应将包括提交ID。在失败时响应将包含错误。	帖子

Action =提交可能会在没有第一次执行的情况下发生Action =而且Action =预览．

例子

评论评论

查看评论提交表单

https:// (stg) api.bazaarvoice.com/data/submitreviewcomment。(格式)? ApiVersion = [latestApiVersion] &ReviewId = [reviewId] userId = (userId)万能钥匙= [yourKey]

所有评审意见提交都需要ReviewId。这个操作可以通过HTTP POST或GET来完成。

查看预先填充了用户数据的评论提交表单

https:// (stg) api.bazaarvoice.com/data/submitreviewcomment。(格式)? ApiVersion = [latestApiVersion] &ReviewId = [reviewId]万能钥匙= (yourKey)和用户|标识= [valueOfUserOrUserId]

根据API密钥配置，使用User或UserId参数。这个操作可以通过HTTP POST或GET来完成。

预览评论提交

https:// (stg) api.bazaarvoice.com/data/submitreviewcomment。(格式)? ApiVersion = [latestApiVersion] &ReviewId = [reviewId]行动= preview&CommentText = [yourCommentText] userId = (userId)万能钥匙= [yourKey]

所有评审意见提交都需要一个ReviewId。这个操作可以通过HTTP POST或GET来完成。

提交评论

POST /数据/ submitreviewcomment。(格式)HTTP/1.1 Host: [stg.]api.bazaarvoice.com Content-Type: application/x-www-form-urlencoded X-Forwarded-For: [AuthorIPAddress] ... ApiVersion=[latestApiVersion]&ReviewId=[reviewId]&Action=submit&CommentText=[yourCommentText]&UserId=[userId]&PassKey=[yourKey]&fp=[deviceFingerprint]

上面例子中的省略号(…)表明你的应用程序可能会生成其他头文件。

所有评审意见提交都需要一个ReviewId。此操作必须使用HTTP POST完成。

头

名字描述

名字	描述
`内容类型`	请求体的媒体类型。值必须为`应用程序/ x-www-form-urlencoded`．要求该字段在所有API请求中都是必需的。
`X-Forwarded-For`	内容作者IP地址。只有在从服务器执行提交时才需要这个报头。看到真实性教程获取更多信息。根据Bazaarvoice真实性政策，您必须在每次投稿时附上作者IP地址。如果您未能在投稿时发送作者IP地址，Bazaarvoice可自行决定采取任何必要的行动以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。

内容类型

请求体的媒体类型。值必须为应用程序/ x-www-form-urlencoded．

要求该字段在所有API请求中都是必需的。

X-Forwarded-For

内容作者IP地址。只有在从服务器执行提交时才需要这个报头。看到真实性教程获取更多信息。

根据Bazaarvoice真实性政策，您必须在每次投稿时附上作者IP地址。如果您未能在投稿时发送作者IP地址，Bazaarvoice可自行决定采取任何必要的行动以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。

警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。

你的应用可能会生成其他的头文件。

参数

名字	描述
`(格式)`	回应格式(xml或json) 要求该字段在所有API请求中都是必需的。
`行动`	提交动作——' action ='， ' action =Preview'或' action =Submit'。'Action='将显示可用于构建提交表单的信息，'Action=Preview'将显示要提交的内容的草稿;'Action=Submit'将提交内容。如果'Action=Submit'，请求必须是HTTP POST。了解更多．
`AgreedToTermsAndConditions`	布尔值，表示用户是否同意条款和条件。必需的，取决于客户端的设置。谨慎根据每个客户端的配置，可能需要这个字段。
`ApiVersion`	API版本，例如5.4。要求该字段在所有API请求中都是必需的。
`CampaignId`	可以与内容一起保存的任意文本，以指示捕获内容的车辆，例如“购后电子邮件”。
`CommentText`	包含注释的文本。要求该字段在所有API请求中都是必需的。
`ContextDataValue_ < Dimension-External-Id >`	该参数的一些示例包括以下内容。每个后面都有可能的值。 ContextDataValue_PurchaserRank -“top”，“top10”，“top100”，“top1000” contextdatavalue_buyer - "是"，"否" ContextDataValue_Age - "under21"， "21to34"， "35to44"， "45to54"， "55to64"， "over65" ContextDataValue_Gender - "男性"，"女性" 谨慎根据每个客户端的配置，可能需要这个字段。
`《外交政策》`	内容作者的设备指纹。看到真实性教程获取更多信息。根据Bazaarvoice真实性政策，您必须在每次提交时附上设备指纹。如果您未能在提交时发送设备指纹，Bazaarvoice可自行决定采取任何必要的行动，以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。
`HostedAuthentication_AuthenticationEmail`	提交人收到确认邮件的邮箱地址。如果配置为使用托管电子邮件身份验证，则此参数为必选项。看到验证用户方法获取有关托管身份验证的详细信息。谨慎根据每个客户端的配置，可能需要这个字段。
`HostedAuthentication_CallbackUrl`	用户认证邮件中链接的URL。这应该指向一个登陆页面，其中存在一个web应用程序来完成用户身份验证过程。URL的主机必须是为客户端配置的域之一。电子邮件中的链接将包含一个用户身份验证令牌(authtoken)，用于验证提交者。如果配置为使用托管电子邮件身份验证，则此参数为必选项。看到主持身份验证获取更多信息的教程。谨慎根据每个客户端的配置，可能需要这个字段。
`语言环境`	中显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。警报未能提交此字段将导致您的内容不符合联合、真实性或其他业务流程的资格。
`万能钥匙`	API密钥需要验证API用户和检查访问特定客户端数据的权限。要求该字段在所有API请求中都是必需的。
`PhotoCaption_ < n >`	Value是照片URL的标题文本，值与相同。 PRR此功能仅适用于我们的Conversations PRR平台上的客户。了解更多．谨慎根据每个客户端的配置，可能需要这个字段。
`PhotoUrl_ < n >`	值为aBazaarvoice使用数据API上传照片的URL，其中是非负整数。看到我们的照片上传教程获取更多信息。 PRR此功能仅适用于我们的Conversations PRR平台上的客户。了解更多．谨慎根据每个客户端的配置，可能需要这个字段。
`ProductRecommendationId_ < n >`	值为非负整数，表示'个产品推荐的产品外部ID(用于社会推荐) PRR此功能仅适用于我们的Conversations PRR平台上的客户。了解更多．
`ReviewId`	提交此评论的评审的id。要求此字段是审查评论所必需的。
`SendEmailAlertWhenPublished`	布尔值，指示用户是否希望在其内容发布时得到通知。
`标题`	值为内容标题文本。谨慎根据每个客户端的配置，可能需要这个字段。
`用户`	加密用户的值。该参数表示用户已通过认证。注意，UserId参数不包含身份验证信息，不应该用于托管身份验证。看到验证用户方法获取更多信息。谨慎根据每个客户端的配置，可能需要这个字段。
`UserEmail`	用户的电子邮件地址。谨慎根据每个客户端的配置，可能需要这个字段。
`用户标识`	用户的外部ID。这个值应该来自您的身份验证系统。看到Client-Mastered身份验证获取更多信息。警报不要为该值使用电子邮件地址。谨慎根据每个客户端的配置，可能需要这个字段。
`UserLocation`	用户位置文本。谨慎根据每个客户端的配置，可能需要这个字段。
`UserNickname`	用户昵称显示文本。谨慎根据每个客户端的配置，可能需要这个字段。
`VideoCaption_ < n >`	Value是视频URL的标题文本，值与相同。 PRR此功能仅适用于我们的Conversations PRR平台上的客户。了解更多．谨慎根据每个客户端的配置，可能需要这个字段。
`VideoUrl_ < n >`	Value是YouTube视频或Bazaarvoice的有效URL主持视频其中是非负整数。 PRR此功能仅适用于我们的Conversations PRR平台上的客户。了解更多．谨慎根据每个客户端的配置，可能需要这个字段。

响应格式

⚠ 不要在应用程序中重用下面的API密钥。

预览评论提交:

https://stg.api.bazaarvoice.com/data/submitreviewcomment.json?apiversion=5.4&ReviewId=83964&passkey=2cpdrhohmgmwfz8vqyo48f52g&action=preview

下面是通过HTTP POST提交表单后的注释提交响应示例:

{"Data":{}， "HasErrors":false， "Form":[]， "FormErrors":{}， "TypicalHoursToPost":72， "Comment":{"SendEmailAlertWhenPublished":false， "SubmissionTime":"2011-11-16 t13:51:01. 96-00:00"， "TypicalHoursToPost":null， "Id":null， "SubmissionId":null， "CommentText":"texttexttext "}， "SubmissionId":"acshmx7d74fgvdenwo4zgat19"， "Locale":"en_US"， "Errors":[]}

响应的元素

名字	描述
`数据`	节，其中包含字段和字段组。
`HasErrors`	布尔值，指示是否存在错误。
`形式`	节，其中包含字段和组引用的数组。
`FormErrors`	节，该节包含一个对象，其属性表示用户输入错误。例如，未能提交特定字段所需的最少字符。
`TypicalHoursToPost`	这是内容发布的通常时间。
`SubmissionId`	唯一的提交事件ID，指的是成功的提交事件，如提交、更新等
`评论`	包含注释数据的部分。
`语言环境`	将与此提交相关联的地区。
`错误`	如果查询语法错误或执行查询时出现问题，则填充Error部分而不是其他字段。

错误代码

价值	描述
`ERROR_ACCESS_DENIED`	权限不足，无法执行该操作
`ERROR_FORM_DUPLICATE`	这个昵称已经被使用了。
`ERROR_FORM_DUPLICATE_NICKNAME`	这个昵称已经被使用了。
`ERROR_FORM_EMOJI`	不支持表情符号。
`ERROR_FORM_INVALID_EMAILADDRESS`	电子邮件地址格式不正确。
`ERROR_FORM_INVALID_IPADDRESS`	IP地址无效。
`ERROR_FORM_INVALID_OPTION`	所选选项已被删除。
`ERROR_FORM_PATTERN_MISMATCH`	该字段格式不正确。
`ERROR_FORM_PROFANITY`	内容包含不恰当的语言。
`ERROR_FORM_REJECTED`	提案被拒绝了。
`ERROR_FORM_REQUIRED`	没有提供必需的字段。
`ERROR_FORM_REQUIRED_EITHER`	所需的两个托管身份验证参数都没有。
`ERROR_FORM_REQUIRED_NICKNAME`	您必须输入一个昵称。
`ERROR_FORM_REQUIRES_TRUE`	字段要求值为true。(例如，“你必须同意这些条款和条件。”)
`ERROR_FORM_RESTRICTED`	内容提供者的年龄太小。(例如，“13岁以下未成年人不能接受内容。”)
`ERROR_FORM_STORAGE_PROVIDER_FAILED`	上传的文件无法存储。请稍后再上传。
`ERROR_FORM_SUBMITTED_NICKNAME`	此昵称已经提交。
`ERROR_FORM_TOO_FEW`	这个字段必须有一个最低数量的条目。
`ERROR_FORM_TOO_HIGH`	这个字段的条目太多了。
`ERROR_FORM_TOO_LONG`	该字段字符太多。
`ERROR_FORM_TOO_LOW`	这个字段条目太少了。
`ERROR_FORM_TOO_SHORT`	字段没有足够的字符。
`ERROR_FORM_UPLOAD_IO`	无法上传项目。确保它是有效的文件类型。
`ERROR_PARAM_DUPLICATE_SUBMISSION`	此客户端不允许重复提交
`ERROR_PARAM_INVALID_API_KEY`	无效的API键值
`ERROR_PARAM_INVALID_LOCALE`	无效的区域代码
`ERROR_PARAM_INVALID_PARAMETERS`	内容提交时参数无效
`ERROR_PARAM_INVALID_SUBJECT_ID`	审核id
`ERROR_PARAM_MISSING_SUBJECT_ID`	提交时缺少审查向…屈服评论id
`ERROR_PARAM_MISSING_USER_ID`	此客户端不允许未经身份验证的提交。需要一个有效的用户id。
`ERROR_REQUEST_LIMIT_REACHED`	速率限制错误，即每个时间间隔请求太多
`ERROR_UNKNOWN`	未知错误(例如，内部服务器错误)
`ERROR_UNSUPPORTED`	对于不支持的功能，客户端等。

搜索表单

评论提交

概述

例子