Comment
This page provides information about the comment data set in the Displayable Content Export (DCE).
Example
The following is a generalized example. Actual comments will vary based on configurations. Continue to the Fields section for information on each field.
{
"id":"58c04ef2-c160-5b1b-b899-65db2aa6d9b8",
"type":"comment",
"client":"example-client",
"lastModificationTime":"2016-09-17T21:35:19.240Z",
"legacyId":"401777",
"submissionId":"qekz0odjlk8utw7y4n4ht8qtm",
"submissionTime":"2016-04-03T09:11:50.000Z",
"contentLocale":"en_US",
"helpfulVoteCount":0,
"notHelpfulVoteCount":0,
"authorLocation":"Austin, TX",
"contentCodes":[
"HMP"
],
"containedIn":[
{
"id":"0d36ecdc-5b4d-5a56-9034-122facd259d8",
"type":"review",
"client":"example-client"
}
],
"authorReference":{
"id":"88af605d-d14e-5fe5-922b-d86fd08e78cd",
"type":"author",
"client":"example-client"
},
"videos":[{
"caption":"see it in action",
"rawUrlInput":"http://youtu.be/KeIDiddsjR0",
"videoHost":"www.youtube.com",
"videoId":"KeIDiddsjR0"
}],
"userNickname":"cupcake",
"isFeatured":false,
"campaignId":"BV_REVIEW_DISPLAY",
"commentText":"Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Etiam vel pellentesque enim. Quisque rutrum eros ut sapien posuere ornare. Quisque vulputate ac diam eu scelerisque. Integer volutpat felis sed aliquam ornare. "
}
Relationships
Author
A comment will only have a single author. This relationship is maintained on the comment using the Author reference field.
The following diagram depicts the relationship between a comment and an author:
Review
A comment will only relate to a single review. This relationship is maintained on the comment using the Contained in field.
The following diagram depicts the relationship between a comment and a review:
Fields
Author location
"authorLocation":"Austin, TX"
Free text field submitted by the author. This value is not guaranteed to be in a standardized format.
This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.
Author reference
"authorReference":{
"id":"1f6ef1dd-7c6b-5a70-a9e2-c03a18a31849",
"type":"author",
"client":"example-client"
}
Information about the content author. Refer to the Relationships section in this document to learn how to join a comment with an author.
Campaign ID
"campaignId":"BV_REVIEW_DISPLAY",
Campaign ID is a text string identifying the action that originated the content.
Client
"client":"example-client"
The client from where this content originates. The source client.
If this value is not your client name, then this content has been syndicated to you from the client identified.
Comment text
"commentText":"Class aptent taciti sociosqu ad litora torquent per conubia nostra..."
The main text content of the submission.
This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.
Contained in
"containedIn":[
{
"id":"0d36ecdc-5b4d-5a56-9034-122facd259d8",
"type":"review",
"client":"example-client"
}
],
Information about the review to which this comment relates. Refer to the Relationships section in this document to learn how to join a comment to it's related review.
Content codes
"contentCodes":[
"HMP"
]
Codes assigned by Bazaarvoice moderators. For a list of possible codes refer to Moderator codes for content in the Conversations API documentation.
Content locale
"contentLocale":"en_US",
The locale code associated with this content.
Helpful vote count
"helpfulVoteCount":0,
The count of users who indicated the content was helpful.
ID
"id":"00092788-ca63-57f6-8e84-7862f7a82a40"
Universally unique value identifying item. This ID is generated by Bazaarvoice.
Is featured
"isFeatured":false
Indicates the content should highlighted to consumers, typically by sorting the featured content to the top and applying a badge or other graphic indicator.
Last modification time
"lastModificationTime":"2017-01-21T16:28:58.736Z"
When this content was most recently modified.
Legacy ID
"legacyId":"51332596"
This identifier is used in the Bazaarvoice portal (AKA: Workbench) and standard export feeds. It is not guaranteed to be unique across clients.
Not helpful vote count
"notNelpfulVoteCount":0
The count of users who indicated the content was not helpful.
Submission ID
"submissionId":"qekz0odjlk8utw7y4n4ht8qtm"
The unique identifier assigned to content (for example, to a comment) when it was submitted. This ID exists only on native content generated on your site. It does not exist on syndicated content or on native content generated through a manual import.
Submission time
"submissionTime":"2015-07-08T08:19:31.000Z"
When the content was submitted.
Type
"type":"comment"
The content type.
User nickname
"userNickname":"cupcake"
Public display name chosen by the author. If this value is absent, you should look for the displayName field on the associated author record.
Videos
Information about videos associated with the content. Bazaarvoice supports the following video styles:
Third party video linking
With this style, consumers can link to videos hosted on other platforms. Currently only YouTube is supported.
"videos":[{
"caption":"see it in action",
"rawUrlInput":"http://youtu.be/KeIDiddsjR0",
"videoHost":"www.youtube.com",
"videoId":"KeIDiddsjR0"
}]
See YouTube's developer documentation for more information on YouTube's current methods for displaying YouTube hosted video.
Bazaarvoice hosted video
With this style, consumers can upload video files directly to Bazaarvoice when submitting content. Videos will be hosted and served by Bazaarvoice.
"videos":[{
"VideoId": "9d637b22-fff8-aad7-4841-356422b9fb41",
"VideoHost": "BAZAARVOICE",
"VideoThumbnailUrl": "https://d32knfnyyqt5ha.cloudfront.net/9d637b22-fff8-aad7-4841-356422b9fb41/thumbnail/image-00001.png",
"VideoIframeUrl": null,
"Caption": "see it in action",
"VideoUrl": "https://d32knfnyyqt5ha.cloudfront.net/9d637b22-fff8-aad7-4841-356422b9fb41/video/movie.mp4"
}]
Updated 10 months ago