显示原理

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

本教程解释了对话API显示请求的基本原理。

概述

当使用Bazaarvoice Conversations API时，“显示请求”是一个返回用于在应用程序中显示的消费者生成内容(CGC)的请求。显示请求是通过执行一个HTTP GET请求来完成的，该请求包含一个内容类型API版本，而你的API万能钥匙．

得到https://stg.api.bazaarvoice.com/data/ [ContentType] . json ? ApiVersion = [LatestApiVersion]万能钥匙= [YourApiKey]

此外，对话API支持以下显示功能:

• 过滤
• 排序
• 免费文本搜索
• 分页
• 包括相关内容
• 跨域请求
• 实时统计
• 本地化

继续阅读以了解这些特性，并查看如何使用它们的示例。

内容类型

Bazaarvoice平台的所有显示请求都是特定的内容类型。

得到https://stg.api.bazaarvoice.com/data/评论. json

评论是最常见的内容类型，但也有其他类型。下表显示了每种内容类型的API端点。单击端点查看示例、选项和错误代码:

过滤

属性可以基于各种属性筛选显示请求过滤器参数。过滤的一般模式如下所示:

过滤器=属性:接线员:价值

一个请求可以通过使用多个过滤参数对多个属性进行过滤:

过滤器= Attribute1:接线员:Value&Filter = Attribute2:接线员:价值

针对多个值，使用逗号分隔的值列表:

过滤器=属性:接线员:Value1, Value2,家

可用的筛选器属性因内容类型而异。请参阅参考文档以查看可用筛选器属性的列表。

下表标识了过滤操作符:

排序

控件可以根据各种属性对显示请求的响应进行排序排序参数。排序的一般模式如下所示:

=属性:方向

多属性排序也可以通过使用逗号分隔的排序属性列表来支持:

= Attribute1:方向，Attribute2:方向

可用的排序属性取决于内容类型。请参阅参考文档以查看可用排序属性的列表。

方向是asc对于升序结果或desc降序结果。下表显示了排序顺序如何处理几个不同的属性类别。

全文检索

控件可以搜索所有用户生成的内容搜索参数。结果将根据与查询的相关性进行排名。最相关的结果将在顶部，不太相关的结果将在底部。由于查询处理的算法性质，您不应该期望能够预测结果的准确顺序。

搜索支持特定于区域的词干，这意味着搜索猫也会返回猫，虽然结果与猫反应可能比结果低猫．

搜索=猫

类似地，带引号的搜索文本将返回结果与结果顶部的精确匹配。

搜索= "肥皂"

全文搜索不支持通配符。

下面的列表描述了搜索每种内容类型的默认字段:

分页

分页是将总结果集划分为更小的子集以便在用户界面中显示的过程。

Bazaarvoice平台每次使用对话API发出请求时都会计算一个总结果集。方法对总结果集进行分页限制和抵消参数。限制控制响应请求时将返回的结果的计数，最多为100。抵消标识在总结果中开始返回结果的位置。通过组合这两个参数，可以遍历整个结果集。

以下组合限制和抵消将返回10个评论，从第10个评论开始，代表结果的第二页:

限制= 10抵消= 10

请参阅分页教程获取更多深入的文档。

包括相关内容

对话API可以返回与请求的主要内容类型相关的其他内容类型数据。例如，你可以提出问题并附上相关的答案。可以使用包括参数:

包括= Answers&Filter = ProductId: 1000001

通过用逗号分隔，可以包含多个内容类型:

包括= ContentType1，ContentType2，ContentTypeN

包含的内容将在与主内容分离的对象中返回。每一项主要内容都将包含一个包含内容id的列表，允许您将它们关联在一起:

{“HasErrors”:假的,“包括”:{"答案":{" 16389 ":{…}， "16390":{…}， "16391":{…}}，…},……“结果”:[{“QuestionSummary”:“测试问题…”,“Id”:“14898”,“AnswerIds”:[“16391”、“16390”、“16389”),…}]，…｝

要成功地使用includes，您必须理解所包含的内容是根据特定请求实际返回的主要内容计算的。在上面的例子中，返回答案16389、16390和16391，因为它们与问题14898相关联。如果问题14898没有在回复中，那么这些答案也不会出现。

可能包含的内容类型因所请求的主要内容类型而异。请参阅参考文档以查看可用选项的列表。

您可以对包含的内容执行以下操作:

reviews.json吗?包括=Comments&Filter_Comments = IsFeatured:情商:真的

reviews.json吗?包括=Comments&Sort_Comments = SubmissionTime: desc

reviews.json吗?包括=Comments&Limit_Comments = 10

必威手机版本products.json吗?包括=Reviews&Search_Reviews =干燥机

跨域请求

对话API支持使用CORS(跨源资源共享)和JavaScript对象填充符号(JSONP)的请求。

歌珥

要使用CORS，请确保您的要求符合“简单”CORS的要求，包括:

• 使用HTTP GET或POST方法
• 不使用自定义、禁止或不安全的头文件

请参阅歌珥教程通过对话API了解更多关于使用CORS的信息。

JSONP

要执行返回JSONP的显示请求，请添加回调参数，其值是JSON处理函数的名称。生成的JSON响应将被“包装”在该函数中。

• 没有回调函数:{"结果":{“产品”:{必威手机版本" AAA ": {" id ":“AAA”}}}}
• 使用回调函数myCallbackFunc:myCallbackFunc({“结果”:{"产品":{"必威手机版本 AAA ": {" id ":“AAA”}}}});

下面的示例演示回调参数:

回调= myCallbackFunc

请参阅JSONP教程以了解更多关于通过对话API使用JSONP的信息。

实时统计

任何要求必威手机版本products.json或任何要求，包括必威手机版本可以使用统计数据参数将产品的统计信息添加到响应中。如果在请求中包含除产品ID之外的更多过滤器，并且希望将统计信息限制为过滤后的结果，请使用FilteredStats而不是统计数据．

必威手机版本products.json

必威手机版本products.json吗?统计数据={ContentType}

包括=产品必威手机版本

reviews.json吗?ApiVersion = [LatestApiVersion]万能钥匙= [YourApiKey]过滤器= ProductId: test1包括=产品必威手机版本＆统计= {ContentType}

可以对以下内容类型进行统计:

你可以用逗号分隔多个内容类型:

必威手机版本products.json吗?统计=评论，问题

本地化

Bazaarvoice平台支持多个地区，这些地区使用language_COUNTRY格式。例如，区域代码fr_CA认定加拿大使用法语。

Bazaarvoice有很多标签

控件可以控制显示请求返回的字段标签所使用的语言语言环境参数。在以下示例中，标签将以加拿大法语返回:

语言环境= fr_CA

过滤用户提交的内容

用户提交的内容(评论、问题等)可以使用ContentLocale过滤器。在下面的例子中，只返回与fr_CA相关的内容:

过滤器= ContentLocale: fr_CA

字符编码

Bazaarvoice平台返回UTF-8编码的内容。

请参阅国际化的教程获取更多深入的文档。

下一个

• ←平台和API概念
• 投稿基础→