搜索表单

API的对话：检索并提交消费者生成的内容(CGC)，检索您的产品目录和关于CGC的统计信息。

资料显示

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

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

内容

（+显示 ——隐藏）

返回关于内容作者的数据。

例子

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

请求所有作者

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

请求所有写过被推荐的评论的作者

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&include=reviews&filter_reviews=IsRecommended:eq:true

请求所有写了20条以上评论的作者

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&filter=TotalCommentCount:gte:20

按ID请求作者

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&filter=id:yums

您可以通过Id请求多个作者，Id之间用逗号分隔。例如过滤器= id: 1234、4567、3456。

通过ID请求作者以及作者所写的问题和评论，按提交时间排序

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&filter=id:yums&include=reviews,questions&sort_reviews=submissiontime:desc&sort_questions=submissiontime:desc

作者编写的评论和问题可以通过指定limit_reviews、limit_questions、sort_reviews、sort_questions、filter_reviews、filter_questions等来过滤、排序和限制。

参数

的名字 描述 要求 默认值
ApiVersion API版本，例如5.4。 是的
(格式) 回应格式(xml或json) 是的
万能钥匙 API密钥需要验证API用户和检查访问特定客户端数据的权限。 是的
属性 返回内容时要包含的属性。例如，如果包含和&attributes=ModeratorCodes参数一起被请求，则包含和结果都将包含主持人代码。为了通过ModeratorCode进行筛选，您必须请求ModeratorCodes属性参数。 没有
回调 与JSONP一起使用的回调函数名。Value为字符串，由以下字符组成:a - z、a - z 0 - 9, _(不含逗号)。看到JSONP教程获取更多信息。 没有
过滤器 查询主要内容的筛选条件。支持多个过滤条件。 没有
Filter_(类型) 包含的内容或主题类型的筛选条件。TYPE可以是评论、问题、答案或评论。每个内容类型都支持多个筛选条件。 没有
IncentivizedStats 如果设置为真正的，显示的个数鼓励评论由每个作者在响应中返回的IncentivizedReviewCount元素。参数必须与FilteredStats或统计数据参数，以在响应中包含评审的统计信息。 没有 假
包括 由作者撰写的内容类型(例如问题、评论、答案或评论)。还可以指定产品和类别等主题类型。必威手机版本 没有
限制 返回的最大记录数。如果传递的值超过100，则返回错误。 没有 10
Limit_(类型) 包含内容的限制选项。类型可以是评论，问题，答案或评论。如果传递的值超过20，则返回错误。 没有 10
语言环境 中显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。 没有
抵消 返回结果所在的索引。默认情况下，在发出查询时，索引从0开始。使用Limit=100, Offset=0返回0-99的结果。当将其更改为Offset=1时，将返回结果1-100。最大支持300000。 没有 0
排序 查询的主要内容类型的排序条件。需要排序顺序(asc或desc)。支持对每个内容/主题类型进行多属性排序。 没有
Sort_(类型) 包含内容的排序标准。类型可以是评论，问题，答案或评论。 没有
统计数据

应该为作者计算统计信息的内容类型。可用的内容类型有:评论、问题、答案．注:统计数字也可以计算包括。

 没有

过滤选项

  • 每个筛选器参数指定要筛选的属性，后跟以逗号分隔的值列表。例如，“Filter=ModeratorCode:eq:LI,PD”将与LI(责任关注)或PD(产品描述不准确)的审核代码值匹配所有内容。
  • 先进的运营商可用于定义筛选器。例如，"Filter=TotalReviewCount:gte:10"将匹配TotalReviewCount值大于或等于10的所有内容。文档中记录了所有高级操作符API的对话页面。
  • 如果过滤器值包含逗号或冒号，则该字符需要用反斜杠(\，或\:)转义。如果筛选值包含&号(&)，该&号必须在筛选值中编码，用%26替换&。
  • 多个过滤器被允许作为URL参数，在这种情况下过滤器是AND的。例如，“Filter=ContextDataValue_gender:eq:female&Filter=ContextDataValue_age:eq:21to34”将匹配年龄在21到34岁之间的女性所写的所有内容。
  • 基于时间的过滤器可以用于SubmissionTime和LastModeratedTime。基于时间的过滤器中的日期是按照自1970年1月1日00:00:00 UTC以来的秒数计算的。在未来的版本中，我们将添加对比较日期/时间字符串值的支持。下面的示例返回在2009年11月9日提交的内容:&filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800

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

的名字 描述
Id
作者的标识符。
AdditionalField_ [FIELD_NAME]
要过滤的附加字段，例如filter=AdditionalField_[FIELD_NAME]:eq:[FIELD_VALUE]
ContentLocale
要显示的内容的区域设置。如果未定义此筛选器，则返回所有内容(无论其语言环境如何)。若要按地区返回特定内容，请在筛选器中定义值。通配符“*”可以用来定义值，例如，“en*”返回所有英文内容(en_US, en_CA, en_GB等)，或者您可以使用单个ContentLocale代码(例如，“fr_FR”)。ContentLocale代码区分大小写。
ContextDataValue_ [DIMENSION_EXTERNAL_ID]
内容的上下文数据值。DIMENSION_EXTERNAL_ID可以是年龄，性别等，例如filter=contextdatavalue_age:under21
HasPhotos
布尔标志，指示作者配置文件是否有照片。
HasVideos
布尔标志，指示作者配置文件是否有视频。有关将返回的VideoUrl插入HTML的更多信息，请参见API的对话页面。
LastAnswerTime
作者最近一次答卷的提交时间。
LastCommentTime
作者最近一次发表评论的时间。
LastModeratedTime
内容最近一次审核的日期/时间。有关使用高级操作符进行过滤的示例，请参见介绍。
LastReviewTime
作者撰写的最新评论的提交时间。
LastQuestionTime
作者最近一次提问的提交时间。
ModeratorCode
表示被拒绝内容的主持人代码的字符串值，例如，&Filter=ModeratorCode:eq:CR返回包含CR(竞争对手参考)代码的UGC。可以在逗号分隔的列表中输入多个代码，例如，&Filter=ModeratorCode:eq:CS,IU返回带有CS(客户服务投诉)或IU(不适当/不可用内容)代码的UGC。有关所有主持人代码的列表，请参见API的对话页面。注意，为了使用这个筛选器，必须显式地请求ModeratorCodes属性参数。请参阅上面的参数部分。
SubmissionTime
内容的提交日期/时间。有关使用高级操作符进行过滤的示例，请参见介绍。
TotalAnswerCount
作者所写的答案的数量。
TotalCommentCount
作者所写评论的数量。
TotalQuestionCount
作者所写的问题数。
TotalReviewCount
作者所写评论的数量。
UserLocation
作者所在地

排序选项

  • 排序条件指定为<排序选项>:asc(升序)和<排序选项>:desc(降序)
  • 通过对内容/主题类型使用逗号分隔的排序标准列表，支持多属性排序。例如，Sort=TotalReviewCount:desc,Id:asc对作者进行排序，首先根据他们的总评论计数(从多到少)，然后如果有具有相同评论数量的作者，则根据Id按字母顺序排序。

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

的名字 描述
Id
作者的标识符。
AdditionalField_ [FIELD_NAME]
需要排序的附加字段，例如sort=AdditionalField_[FIELD_NAME]:desc
ContentLocale
内容的区域设置值
ContextDataValue_ [DIMENSION_EXTERNAL_ID]
内容的上下文数据值。DIMENSION_EXTERNAL_ID可以是年龄，性别等，例如sort=contextdatavalue_age:desc
HasPhotos
布尔标志，指示作者配置文件是否有照片。
HasVideos
布尔标志，指示作者配置文件是否有视频。有关将返回的VideoUrl插入HTML的更多信息，请参见API的对话页面。
LastAnswerTime
作者最近一次答卷的提交时间。
LastCommentTime
作者最近一次发表评论的时间。
LastModeratedTime
内容最近一次审核的日期/时间
LastReviewTime
作者撰写的最新评论的提交时间。
LastQuestionTime
作者最近一次提问的提交时间。
SubmissionTime
内容的提交日期/时间
TotalAnswerCount
作者所写的答案的数量。
TotalCommentCount
作者所写评论的数量。
TotalQuestionCount
作者所写的问题数。
TotalReviewCount
作者所写评论的数量。
UserLocation
作者所在地

响应格式

这是查询列表Authors的示例响应，该查询将结果限制为1个条目，并包含该作者所写的评论的统计信息(平均总体评分、评分分布、二级评分平均值等)。

{"包括":{},“HasErrors”:假的,“抵消”:0,“TotalResults”:36053年,“语言环境”:“en_US”,“错误”:[],“结果”:[{“AdditionalFieldsOrder”:[],《阿凡达》:{},“照片”:[],“ContextDataValues”:{“年龄”:{“价值”:“under21”、“ValueLabel”:“ReviewStatistics”:{“AverageOverallRating”:5“OverallRatingRange”:5“TotalReviewCount”:1“RatingDistribution”:[{“计数”:1、“RatingValue”:2},{“计数”:2,“RatingValue”:3}{“计数”:3,“RatingValue”:5  } ] } }, " SecondaryRatingsAveragesOrder”:[“设计”、“价格”、“RatingDimension3”),“SecondaryRatingsAverages”:{" RatingDimension3 ": {" Id ":“RatingDimension3”、“AverageRating”:1},“价格”:{" Id ":“价格”、“AverageRating”:2},“设计”:{" Id ":“设计”,“AverageRating”:3},}“SecondaryRatingsOrder”:[],“UserNickname”:“bfggbbd”、“ProductRecommendationIds”:[],“AdditionalFields ":{},“SubmissionTime”:“2012 - 03 - 01 - t05:58:03.000 - 00:00”、“ModerationStatus”:“批准”、“ReviewIds”:[]， "Id": "zzl7lx3wm8"， "CommentIds": []， "SecondaryRatings": {}， "LastModeratedTime": " 2012-03-01t06:00:47 - 000-00:00"}]， "Limit": 1}

错误的示例响应:

{"错误":{“代码”:“(ERROR_CODE)”,“消息”:“[ERROR_MESSAGE]”}}

响应的元素

的名字 描述
数据
节，其中包含按内容/主题类型分组的查询所匹配的所有数据。在每个数据部分中都有一个以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_UNKNOWN

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

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