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

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

内容

+显示 ——隐藏

返回问题以及嵌套内容(如Answers)和相关主题(如Product/)类别

例子

仅供演示用途。不要在应用程序中重用下面的API密码。

请求按提交时间排序的特定产品的所有问题

按问题ID请求特定产品的问题

https://stg.api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&Filter=Id:14902过滤器= Productid: 1000001

您可以通过用逗号分隔问题id来请求多个问题,例如filter=id:14801,14802,14902

按问题ID请求单个问题,包括特定产品的答案

你可以请求多个相关信息,用逗号分隔,例如include=products,categories,authors。必威手机版本

请求25个有答案的问题,对特定产品按提交时间降序排序

你可以通过用逗号分隔多个属性来排序,例如sort=id:desc,submissiontime:asc

请求所有本机(非联合)问题

仅限本地(非联合)内容。更多细节请继续阅读。

类的此内容类型请求ProductIdAuthorIdCategoryAncestorIdSubmissionId,或问题Id过滤器将只工作于API键配置为排除联合内容。

我们建议使用可显示内容导出服务来下载您的所有本地和联合内容。如果你仍然喜欢对话API,那么你可以联系我们的支持团队重新配置对话API键。

参数

的名字 描述 要求 默认值
ApiVersion API版本,例如5.4。 是的
(格式) 回应格式(xml或json) 是的
万能钥匙 API密钥需要验证API用户和检查访问特定客户端数据的权限。 是的
属性 返回内容时要包含的属性。例如,如果包含和&attributes=ModeratorCodes参数一起被请求,则包含和结果都将包含主持人代码。为了通过ModeratorCode进行筛选,您必须请求ModeratorCodes属性参数。 没有
回调 与JSONP一起使用的回调函数名。Value为字符串,由以下字符组成:a - z、a - z 0 - 9, _(不含逗号)。看到JSONP教程获取更多信息。 没有
ExcludeFamily 布尔标志,指示是否从与所请求产品属于同一族的其他产品中排除内容。必威手机版本例如,"&filter=productid:eq:1101& excludefamily =true"将返回的内容限制为产品1101的内容,而不是同一家族中的任何产品。必威手机版本如果未定义值,则返回家族中所有产品的内容。必威手机版本 没有
过滤器 查询主要内容的筛选条件。支持多个过滤条件。 没有
Filter_(类型) 包含的嵌套内容的过滤选项。TYPE可以是任何包含的嵌套内容。例:问题的答案。 没有
包括 包含相关主题(如产品、类别、作者或答案)。必威手机版本 没有 如果没有指定,将只返回问题
限制 返回的最大记录数。如果传递的值超过100,则返回错误。 没有 10
Limit_TYPE 返回的嵌套内容类型的限制选项。TYPE可以是任何嵌套的内容。例:问题的答案。如果传递的值超过20,则返回错误。 没有 10
语言环境 中显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。 没有
抵消 返回结果所在的索引。默认情况下,在发出查询时,索引从0开始。使用Limit=100, Offset=0返回0-99的结果。当将其更改为Offset=1时,将返回结果1-100。最大支持300000。 没有 0
搜索 全文搜索字符串用于查找UGC。有关默认搜索哪些字段的详细信息,请参见API的对话页面。

注意:这将使排序选项无效,因为搜索在返回的数据中具有优先级。
没有
Search_(类型) 包含内容的搜索选项,后面跟着全文搜索字符串。看到API的对话页中搜索所包含数据的示例。

注意:这将使排序选项无效,因为搜索在返回的数据中具有优先级。
没有
排序 查询的主要内容类型的排序条件。需要排序顺序(asc或desc)。支持对每个内容/主题类型进行多属性排序。 没有
Sort_(类型) 嵌套内容的排序选项。TYPE可以是任何嵌套的内容。例:问题的答案。 没有
统计数据

将在所包含的主题上计算的统计数据类型。可用的内容类型有:评论、问题、答案.注意:并非所有统计内容类型都适用于所有可能的include。

没有

过滤选项

  • 每个筛选器参数指定要筛选的属性,后跟以逗号分隔的值列表。例如,"Filter=Id:eq:3,4"将匹配Id为3或4的问题。
  • 先进的运营商可用于定义筛选器。例如,"Filter=Id:gt:50"将匹配Id值大于50的问题。文档中记录了所有高级操作符API的对话页面。
  • 如果过滤器值包含逗号或冒号,则该字符需要用反斜杠(\,或\:)转义。如果筛选值包含&号(&),该&号必须在筛选值中编码,用%26替换&。
  • 多个过滤器被允许作为URL参数,在这种情况下过滤器是AND的。例如,"Filter=ProductId:eq:75&Filter=isfeatured:eq:true"将匹配Id为75的产品的所有特征问题。
  • 基于时间的过滤器可以用于SubmissionTime, LastModificationTime和LastModeratedTime。基于时间的过滤器中的日期是按照自1970年1月1日00:00:00 UTC以来的秒数计算的。在未来的版本中,我们将添加对比较日期/时间字符串值的支持。下面的示例返回在2009年11月9日提交的内容:&filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800

下表列出了可用于过滤的属性。

的名字 描述
Id
问题的标识符。
AdditionalField_ [FIELD_NAME]
PRR要过滤的附加字段,例如filter=AdditionalField_[FIELD_NAME]:eq:[FIELD_VALUE]
AuthorId
编写内容的作者的标识符。
CampaignId
与内容关联的Campaign的标识符
CategoryAncestorId
写入问题所在的产品类别的祖先标识符。使用此筛选器时,聚合内容将不会返回。
被标记
PRR问题所在的产品类别的标识符。
ContentLocale
要显示的内容的区域设置。如果未定义此筛选器,则返回所有内容(无论其语言环境如何)。若要按地区返回特定内容,请在筛选器中定义值。通配符“*”可以用来定义值,例如,“en*”返回所有英文内容(en_US, en_CA, en_GB等),或者您可以使用单个ContentLocale代码(例如,“fr_FR”)。ContentLocale代码区分大小写。
ContextDataValue_ [DIMENSION_EXTERNAL_ID]
PRR内容的上下文数据值。DIMENSION_EXTERNAL_ID可以是年龄,性别等,例如filter=contextdatavalue_age:under21
HasAnswers
布尔标志,指示问题是否有答案。
HasBestAnswer
布尔标志,表示问题是否有最佳答案。
HasBrandAnswers
布尔标志,指示问题是否至少有一个品牌答案。
HasPhotos
布尔标志,指示内容是否有照片
HasStaffAnswers
布尔标志,指示问题是否有人员答案。
HasTags
PRR布尔标志,指示内容是否有标签
HasVideos
PRR布尔标志,指示内容是否有视频。有关将返回的VideoUrl插入HTML的更多信息,请参见API的对话页面。
IsFeatured
布尔标志,指示内容是否具有特色
IsSubjectActive
布尔标志,指示内容主题是否处于活动状态
LastApprovedAnswerSubmissionTime
最迟获批准的答卷递交日期/时间。有关使用高级操作符进行过滤的示例,请参见介绍。
LastModeratedTime
内容最近一次审核的日期/时间。有关使用高级操作符进行过滤的示例,请参见介绍。
LastModificationTime
内容最近一次修改的日期/时间。有关使用高级操作符进行过滤的示例,请参见介绍。
ModeratorCode
表示被拒绝内容的主持人代码的字符串值,例如,&Filter=ModeratorCode:eq:CR返回包含CR(竞争对手参考)代码的UGC。可以在逗号分隔的列表中输入多个代码,例如,&Filter=ModeratorCode:eq:CS,IU返回带有CS(客户服务投诉)或IU(不适当/不可用内容)代码的UGC。有关所有主持人代码的列表,请参见API的对话页面。注意,为了使用这个筛选器,必须显式地请求ModeratorCodes属性参数。请参阅上面的参数部分。
ProductBrandId 外部产品品牌ID的值。不区分大小写。要返回没有品牌ID关联的内容,设置productbrandid:eq:null
ProductId
问题所在产品的标识符。
SubmissionId
最初提交内容时分配给内容的提交标识符
SubmissionTime
内容的提交日期/时间。有关使用高级操作符进行过滤的示例,请参见介绍。
总结
问题总结。
Tag_ [TAG_NAME]
要过滤的标签名称,例如,filter=tag_[TAG_NAME]:eq:[TAG_VALUE]
TotalAnswerCount
这个问题有答案的数目。
TotalFeedbackCount
收到的反馈数量
TotalNegativeFeedbackCount
收到的负面反馈数量
TotalPositiveFeedbackCount
收到的正面反馈数量
UserLocation
作者所在地

排序选项

  • 需要排序顺序(asc或desc)。没有违约。
  • 通过对内容/主题类型使用逗号分隔的排序标准列表,支持多属性排序。例如=评级:asc submissiontime: desc

下表列出了可用于排序的属性。

的名字 描述
Id
问题的标识符。
AdditionalField_ [FIELD_NAME]
PRR需要排序的附加字段,例如sort=AdditionalField_[FIELD_NAME]:desc
AuthorId
问题作者的标识符。
CampaignId
与内容关联的Campaign的标识符
被标记
PRR问题所在的产品类别的标识符。
ContentLocale
内容的区域设置值
ContextDataValue_ [DIMENSION_EXTERNAL_ID]
PRR内容的上下文数据值。DIMENSION_EXTERNAL_ID可以是年龄,性别等,例如sort=contextdatavalue_age:desc
HasAnswers
布尔标志,指示问题是否有答案。
HasBestAnswer
布尔标志,指示问题是否有最佳答案。
HasPhotos
布尔标志,指示内容是否有照片
HasStaffAnswers
布尔标志,指示问题是否有人员答案。
HasTags
PRR布尔标志,指示内容是否有标签
HasVideos
PRR布尔标志,指示内容是否有视频。有关将返回的VideoUrl插入HTML的更多信息,请参见字段类型教程。
IsFeatured
布尔标志,指示内容是否具有特色
IsSubjectActive
布尔标志,指示内容主题是否处于活动状态
LastApprovedAnswerSubmissionTime
最近一次获批准提交答卷的日期/时间
LastModeratedTime
内容最近一次审核的日期/时间
LastModificationTime
内容最近一次修改的日期/时间
ProductId
问题所在产品的标识符。
SubmissionId
最初提交内容时分配给内容的提交标识符
SubmissionTime
内容的提交日期/时间
总结
问题概述
TotalAnswerCount
已经写在问题上的答案的数目。
TotalFeedbackCount
收到的反馈数量
TotalNegativeFeedbackCount
收到的负面反馈数量
TotalPositiveFeedbackCount
收到的正面反馈数量
UserLocation
作者所在地

响应格式

这是请求所有有答案的问题的响应。Answers数据也包含在响应中。

http:// (stg) api.bazaarvoice.com/data/questions.json ? ApiVersion = [latestApiVersion]万能钥匙= [yourKey]过滤器= HasAnswers: true&Include =答案,Prod必威手机版本ucts&Sort = SubmissionTime: desc

{"Includes": {}, "HasErrors": false, "Offset": 200, "TotalResults": 2320, "Locale": "en_US", "Errors": [], "Results": [{"QuestionSummary": "Take the monarch butterfly,", "TagDimensions": {"Topic": {"Values": ["Topic 2", "冗长的主题值示例"],"Label": "Topic", "Id": "Topic"}}, "TagDimensionsOrder": ["Topic"], "AdditionalFieldsOrder": [], "TotalAnswerCount": 0, "QuestionDetails":“在这个群体中,有鲱鱼和灰鲱鱼,白鲈鱼,条纹鲈鱼或岩鱼,一些鲟鱼和大西洋鲑鱼,它们都在产卵后回到大海,还有太平洋鲑鱼(五种),它们都在产卵后死亡。\n\n在我们的水域中有一个例子——普通鳗鱼”,“用户昵称”:“2hTZ”,“照片”:[{“标题”:null,“尺寸”:{“缩略图”:{“Url”:“http://testcustomer.ugc.bazaarvoice.com/answers/0001/170860/photoThumb.jpg”,“Id”:“缩略图”},“normal”:{“Url”:“http://testcustomer.ugc.bazaarvoice.com/answers/0001/170860/photo.jpg”,“Id”:“normal”}},“SizesOrder”:[“缩略图”,“normal”],“Id”:“170860”}],“CategoryId”:null,“ContextDataValues”:{},“视频”:[],“ContextDataValuesOrder”:[],“SubmissionId”:空,“LastModificationTime”:“2011 - 10 - 12 - t14:32:32.000 - 00:00”、“AnswerIds”:[],“TotalFeedbackCount”:0,“TotalPositiveFeedbackCount”:0,“TotalInappropriateFeedbackCount”:0,“InappropriateFeedbackList:[],”UserLocation”:“N”、“BadgesOrder”:“top250Contributor”,“徽章”:{" top250Contributor ": {" Id ":“top250Contributor”、“ContentType”:“问题”}},“AuthorId”:“data-gen-user-b82iyxmi2k4a8lxcaamzzyh4w”、“IsFeatured”:false, "ProductRecommendationIds": [], "ProductId": "data- genpuzri1hax8074pba42wq1hqes ", "AdditionalFields": {}, "CampaignId": null, "TotalNegativeFeedbackCount": 0, "SubmissionTime": " 2011-10-12t14:12:12 - 000-00:00", "ContentLocale": "en_US", "ModerationStatus": "APPROVED", "Id": "305209", "LastModeratedTime": " 2011-10-12t14:20:23 - 000-00:00"}], "Limit": 1}

响应的元素

的名字 描述
数据
节,其中包含按内容/主题类型分组的查询所匹配的所有数据。在每个数据部分中都有一个以id为键的对象映射
错误
如果查询语法错误或执行查询时出现问题,则填充Error部分而不是其他字段。
限制
返回的结果总数,由用户在URL中指定。默认值为10,最大值为100。
抵消
用于分页的数据集偏移量(在查询请求中作为URL参数传递)。最大支持300000。
结果
节,其中包含与查询匹配的基元类型对象引用数组。
TotalResults
匹配的记录总数。

错误代码

价值 描述
ERROR_ACCESS_DENIED

权限不足,无法执行该操作

ERROR_PARAM_INVALID_API_KEY

无效的API键值

ERROR_PARAM_INVALID_CALLBACK

无效的JsonP回调函数名

ERROR_PARAM_INVALID_FILTER_ATTRIBUTE

无效的筛选器属性名

ERROR_PARAM_INVALID_INCLUDED

无效的参数值

ERROR_PARAM_INVALID_LIMIT

无效的限值

ERROR_PARAM_INVALID_LOCALE

无效的区域代码

ERROR_PARAM_INVALID_OFFSET

无效的偏移值

ERROR_PARAM_INVALID_SORT_ATTRIBUTE

无效的排序属性名称

ERROR_REQUEST_LIMIT_REACHED

速率限制错误,即每个时间间隔请求太多

ERROR_UNKNOWN

未知错误(例如,内部服务器错误)

ERROR_UNSUPPORTED

对于不支持的功能,客户端等。