Bazaarvoice开发者门户|问题显示

⚠

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

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

内容

（+显示 ——隐藏）

返回问题和相关数据。

例子

下面的例子演示了常见的对话API显示请求。有关使用对话API显示数据的完整概述，请参阅显示教程．

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

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

这个示例调用展示了如何使用多个过滤器。问题按提交时间降序排列。

https://stg.api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&Filter=Productid:data-gen-2s9kaf0ugzn0p2flzl73ahuys类型= SubmissionTime: desc

按问题ID请求问题

https://stg.api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&Filter=Id:646785

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

根据问题ID(包括答案)请求单个问题

https://stg.api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&Filter=Id:646785包括=答案

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

请求10个问题，针对特定产品按提交时间降序排序

https://stg.api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&Sort=SubmissionTime:desc&Limit=10&Filter=Productid:data-gen-2s9kaf0ugzn0p2flzl73ahuys

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

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

⚠

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

https://stg.api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4

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

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

参数

的名字	描述	要求	默认值
`ApiVersion`	API版本，例如5.4。	是的
`(格式)`	响应格式(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的对话页面。注意:这将使排序选项无效，因为搜索在返回的数据中具有优先级。	没有
`排序`	查询的主要内容类型的排序条件。需要排序顺序(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`	问题的标识符。
`AuthorId`	编写内容的作者的标识符。
`CampaignId`	与内容关联的Campaign的标识符
`CategoryAncestorId`	写入问题所在的产品类别的祖先标识符。使用此筛选器时，聚合内容将不会返回。
`ContentLocale`	要显示的内容的区域设置。如果未定义此筛选器，则返回所有内容(无论其语言环境如何)。若要按地区返回特定内容，请在筛选器中定义值。通配符“”可以用来定义值，例如，“en”返回所有英文内容(en_US, en_CA, en_GB等)，或者您可以使用单个ContentLocale代码(例如，“fr_FR”)。ContentLocale代码区分大小写。
`HasAnswers`	布尔标志，指示问题是否有答案。
`HasBestAnswer`	布尔标志，表示问题是否有最佳答案。
`HasPhotos`	布尔标志，指示内容是否有照片
`HasStaffAnswers`	布尔标志，指示问题是否有人员答案。
`IsFeatured`	布尔标志，指示内容是否具有特色
`IsSubjectActive`	布尔标志，指示内容主题是否处于活动状态
`IsSyndicated`	允许您选择是否返回的布尔标志银团或者非辛迪加问题。如果IsSyndicated:eq:true，响应只返回联合内容和一个SyndicationSource块，其中包含联合来自何处的详细信息。如果IsSyndicated:eq:false，响应只返回本机(非syndicated)内容。注意:API密钥必须配置为显示联合内容。
`LastApprovedAnswerSubmissionTime`	最迟获批准的答卷递交日期/时间。有关使用高级操作符进行过滤的示例，请参见介绍。
`LastModeratedTime`	内容最近一次审核的日期/时间。有关使用高级操作符进行过滤的示例，请参见介绍。
`LastModificationTime`	内容最近一次修改的日期/时间。有关使用高级操作符进行过滤的示例，请参见介绍。
`ModeratorCode`	表示被拒绝内容的主持人代码的字符串值，例如，&Filter=ModeratorCode:eq:CR返回包含CR(竞争对手参考)代码的UGC。可以在逗号分隔的列表中输入多个代码，例如，&Filter=ModeratorCode:eq:CS,IU返回带有CS(客户服务投诉)或IU(不适当/不可用内容)代码的UGC。有关所有主持人代码的列表，请参见API的对话页面。注意，为了使用这个筛选器，必须显式地请求ModeratorCodes属性参数。请参阅上面的参数部分。
`ProductId`	问题所在产品的标识符。
`SubmissionId`	最初提交内容时分配给内容的提交标识符
`SubmissionTime`	内容的提交日期/时间。有关使用高级操作符进行过滤的示例，请参见介绍。
`总结`	问题总结。
`TotalAnswerCount`	这个问题有答案的数目。
`TotalFeedbackCount`	收到的反馈数量
`TotalNegativeFeedbackCount`	收到的负面反馈数量
`TotalPositiveFeedbackCount`	收到的正面反馈数量
`UserLocation`	作者所在地

排序选项

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

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

的名字	描述
`Id`	问题的标识符。
`AuthorId`	问题作者的标识符。
`CampaignId`	与内容关联的Campaign的标识符
`ContentLocale`	内容的区域设置值
`HasAnswers`	布尔标志，指示问题是否有答案。
`HasBestAnswer`	布尔标志，指示问题是否有最佳答案。
`HasPhotos`	布尔标志，指示内容是否有照片
`HasStaffAnswers`	布尔标志，指示问题是否有人员答案。
`IsFeatured`	布尔标志，指示内容是否具有特色
`IsSubjectActive`	布尔标志，指示内容主题是否处于活动状态
`IsSyndicated`	布尔标志，指示内容是否已被删除银团．
`LastApprovedAnswerSubmissionTime`	最近一次获批准提交答卷的日期/时间
`LastModeratedTime`	内容最近一次审核的日期/时间
`LastModificationTime`	内容最近一次修改的日期/时间
`ProductId`	问题所在产品的标识符。
`SubmissionId`	最初提交内容时分配给内容的提交标识符
`SubmissionTime`	内容的提交日期/时间
`总结`	问题概述
`TotalAnswerCount`	已经写在问题上的答案的数目。
`TotalFeedbackCount`	收到的反馈数量
`TotalNegativeFeedbackCount`	收到的负面反馈数量
`TotalPositiveFeedbackCount`	收到的正面反馈数量
`UserLocation`	作者所在地

响应格式

这是请求审查的示例响应。使用上面的链接查看现场示例。

{"包括":{},“HasErrors”:假的,“抵消”:0,“TotalResults”:224775年,“语言环境”:“en_US”,“错误”:[],“结果”:[{…}{…}]， "Limit": 2}

响应的元素

的名字	描述
`包括`	包括与主要结果相关的结果。例如，使用请求`reviews.json吗?包括=评论`， Include节点将填充与Results节点中的评审相关联的注释。
`HasErrors`	布尔值，表示是否发生了一个或多个错误。参见下面的错误。
`抵消`	用于分页的数据集偏移量(在查询请求中作为URL参数传递)。最大支持300000。
`TotalResults`	匹配的记录总数。
`语言环境`	按与客户端实例关联的区域(language_region)指示语言。这是API返回的字段标签的值，而不是审查起源于的区域。
`错误`	如果查询语法错误或执行查询时出现问题，则填充Error部分而不是其他字段。
`结果`	节，其中包含与查询匹配的基元类型对象引用数组。
`限制`	返回的结果总数，由用户在URL中指定。默认值为10，最大值为100。

错误代码

价值	描述
`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`	对于不支持的功能，客户端等。

搜索表单

问题显示

例子