Standard client feed complex contextual objects

This article describes the following parts of complex contextual objects: 

  • Tags
  • Badges
  • Additional fields
  • Context data values
  • Rating values
  • Client responses
  • Client comments
  • Photos
  • Videos
  • Avatar
  • Product references

The following table describes complex contextual objects. Refer to the example to view an example of complex contextual objects in use.

Element Description Type
Tags Contains a list of tag dimensions or tags (depending on the position).

Complex Object

(sequence of Tag or TagDimension elements)

TagDimension

A dimension by which a review can be tagged, such as pros, cons, or qualities.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object

ExternalId Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
Label / Label1 Explains a specific rating, tag, or dimension. The value is taken from a client or default display configurations (if any description is available). String (varchar(255))
Tag Contains a label or tag that was attached to content by the author during submission.

Complex Object

(wraps a Label element)

Badges Contains a list of badges applied to content or its author.

Complex Object

(sequence of Badge elements)

Badge A badge assigned to content either by the client or by CMS. Complex Object
Name Name of the badge. The badge can be displayed with an image on the client's site using this value. String (varchar(255))
ContentType The type of content to which the badge belongs. Possible values: REVIEW, REVIEWER, QUESTION, ANSWER, COMMENT. Enum
BadgeType Type of badge (there are classifications of badges). Possible values: AffiliationBadge, RankBadge, BestAnswerBadge, FeaturedBadge, TopContributorBadge, ReviewerBadge. String (varchar(255))
AdditionalFields Contains a list of custom (non-default) fields configured on the submission page of the review.

Complex Object

(sequence of AdditionalField elements)

AdditionalField Contains information about an additional field and the value chosen by a reviewer (user or author). Complex Object
DisplayLabel Contains a label that describes the meaning of an additional field. String (varchar(255))
Value The value chosen by a user (reviewer) for an additional field. String (varchar(255))
ContextDataValues Contains multiple context data values.

Complex Object

(sequence of ContextDataValue elements)

ContextDataValue

A single context data value chosen by a reviewer (such as information about age, habits, or experience). This block contains dimension of evaluation and a value chosen by a user.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object

ContextDataDimension A dimension of a given context data value. It is a description of what was evaluated. Contains an external id and a label. Complex Object
RatingValues Contains a list of secondary ratings stats (ratings chosen by the author for different dimensions or product qualities).

Complex Object

(sequence of RatingValue elements)

RatingValue Contains stats of a product's rating dimension (some quality by which the product can be evaluated).

Complex Object

Rating A score chosen by the user for a specific dimension (for example, the product quality). Int (int(11))
RatingDimension

Specifies information about alternative characteristics, such as the ease of use, price, material, or comfort.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • displayType—Specifies the submission option chosen for a given rating dimension (options are SLIDER, RADIO, or NORMAL). This is a display-related property only. Enum
  • selectedValueInDisplayEnabled—A Boolean value that shows whether the selected value of the slider or radio should be shown in display. This is a display-related property only. Boolean

Complex Object

RatingRange Much like the OverallRatingRange element, this element shows the maximum value of a given secondary rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their secondary ratings functionality. This value is configured in the client's display or submission configuration. Int (int(11))
ClientResponses Contains a list of client responses to this content. These are usually submitted using the Workbench.

Complex Object

(sequence of ClientResponse elements)

ClientResponse Contains data about the response a client left for a reviewer. Complex Object 
Department Identification or location of a physical or web store from which you receive the response. String (varchar(255))
Response Response text. String (text)
ResponseMarkup Wraps possible markup options. Complex Object
PlainText A plain text version of a response. String (text)
LinkText A link version of a response. String (text)
HighlightText A highlighted version of a response. String (text)
ResponseSource Source from which a response was submitted (such as the Workbench). String (varchar(255))
Date The submission date. Responses and client comments are not moderated. Date (Timestamp)
ClientComments Contains a list of comments that were submitted for a review by a client's personnel.

Complex Object

(sequence of ClientComment elements)

ClientComment Wraps a comment from a client's personnel for a review. Complex Object
Name The name of the person who left a comment from the client side. String (varchar(255))
Comment Comment text. String (text)
Photos A set of photo references with captions left by the reviewer (author of any content).

Complex Object

(sequence of Photo elements)

Photo

Photo references with captions.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object 

Caption A description for a certain piece of media (such as photos or videos) left by a reviewer. String (text)
Sizes A list of images in different sizes (if available).

Complex Object

(sequence of Size elements)

Size

Contains a URL to an image of a certain size identified by its id attribute.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

  • url—URL to a certain image of a specific size. URL / String (varchar(255))

    Note: If the URL contains a reserved (special) character, you must URL-encode Opens in new tab the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).

Empty Object

(data in XML attributes)

Avatar

Contains the user avatar, including URLs and sizes.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • photo—Attribute of an Avatar element that specifies whether the provided URL is a photo or not. Boolean

Complex Object

Videos A set of video references with captions.

Complex Object

(sequence of Video elements)

Video Contains the URL, ID, and caption of a video left by a reviewer. Complex Object
VideoHost

The Video Hosting service (such as YouTube).

Note: If the URL contains a reserved (special) character, you must URL-encode Opens in new tab the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
VideoId Identifies a video from a certain video hosting service (such as YouTube). String (varchar(255))
RawUrlInput

URL to a video hosted on a certain video hosting service (such as YouTube).

Note: If the URL contains a reserved (special) character, you must URL-encode Opens in new tab the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ProductReferences Contains a list of references of products linked to a review.

Complex Object

(sequence of ProductReference elements)

ProductReference Contains a product element with a few fields (refer to the previous example) and a caption left by the content author (reviewer). Complex Object 
Product

A product referenced in the content body (by its author). Refer to Products and their elements for more details.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • disabled—Marks subjects that were explicitly marked as disabled by the client (using their product catalog). Boolean
  • removed—Marks subjects that were removed from the client's catalog (absent in the product catalog and marked as Inactive in the Bazaarvoice database). Boolean

Complex Object

Example

Copy Code
XML
<Review id="123456">
    ...
    <Tags>
    <TagDimension id="Pro">
    <ExternalId>Pro</ExternalId>
    <Label>Pros</Label>
    <Tags>
    <Tag>
    <Label>Entertaining Friends</Label>
    </Tag>
    <Tag>
    <Label>Daily practicing</Label>
    </Tag>
    <Tag>
    <Label>Nice sound</Label>
    </Tag>
    </Tags>
    </TagDimension>
    </Tags>

    <Badges>
    <Badge>
    <Name>top25Contributor</Name>
    <ContentType>REVIEW</ContentType>
    <BadgeType>TopContributorBadge</BadgeType>
    </Badge>
    ...
    </Badges>

    <AdditionalFields>
    <AdditionalField id="HomeDecor">
    <DisplayLabel>My home décor is:</DisplayLabel>
    <Value>Modern</Value>
    </AdditionalField>
    ...
    </AdditionalFields>

    <ContextDataValues>
    <ContextDataValue id="25to34">
    <ExternalId>25to34</ExternalId>
    <Label>25-34</Label>
    <ContextDataDimension id="Age">
    <ExternalId>Age</ExternalId>
    <Label>Age</Label>
    </ContextDataDimension>
    </ContextDataValue>
    <ContextDataValue id="Monthly">
    <ExternalId>Monthly</ExternalId>
    <Label>Monthly</Label>
    <ContextDataDimension id="Frequency">
    <ExternalId>Frequency</ExternalId>
    <Label>Frequency</Label>
    </ContextDataDimension>
    </ContextDataValue>
    ...
    </ContextDataValues>

    <RatingValues>
    <RatingValue>
    <Rating>5</Rating>
    <RatingDimension id="Quality" displayType="NORMAL" selectedValueInDisplayEnabled="false">
    <ExternalId>Quality</ExternalId>
    <RatingRange>5</RatingRange>
    <Label>Quality</Label>
    <Label1>Quality</Label1>
    </RatingDimension>
    </RatingValue>
    <RatingValue>
    <Rating>5</Rating>
    <RatingDimension id="Comfort" displayType="NORMAL" selectedValueInDisplayEnabled="false">
    <ExternalId>Comfort</ExternalId>
    <RatingRange>5</RatingRange>
    <Label>Comfort</Label>
    <Label1>Comfort</Label1>
    </RatingDimension>
    </RatingValue>
    ...
    </RatingValues>

    <ClientResponses>
    <ClientResponse>
    <Department>Something Something Guitar Corp</Department>
    <Response>Our number one priority is to deliver exceptional value to our customers every day. We will contact you directly to check how we can improve the outcome for you.</Response>
    <ResponseMarkup>
    <PlainText>Our number one priority is to deliver exceptional value to our customers every day. We will contact you directly to check how we can improve the outcome for you.</PlainText>
    </ResponseMarkup>
    <ResponseSource>Workbench</ResponseSource>
    <Date>2013-04-12T13:21:43.000-06:00</Date>
    </ClientResponse>
    ...
    </ClientResponses>

    <ClientComments>
    <ClientComment>
    <Date>2013-07-11T12:26:51.000-05:00</Date>
    <Name>client_dude</Name>
    <Comment>Approved by client.</Comment>
    </ClientComment>
    ...
    </ClientComments> 

    <Photos>
    <Photo id="104358">
    <Caption>Me and my new guitar</Caption>
    </Photo>
    ...
    </Photos>

    <Videos>
    <Video>
    <Caption>My soundcheck video</Caption>
    <VideoHost>www.youtube.com</VideoHost>
    <VideoId>abcd123</VideoId>
    <RawUrlInput>http://www.youtube.com/watch?v=abcd123</RawUrlInput>
    </Video>
    ...
    </Videos>

    <Avatar id="466578" photo="true">
    <Sizes>
    <Size id="thumbnail" url="https://reviews.clientName.com/profiles/displayCode/466578/photoThumb.jpg"/>
    <Size id="normal" url="https://reviews.clientName.com/profiles/displayCode/466578/photo.jpg"/>
    ...
    </Sizes>
    </Avatar>

    <ProductReferences>
    <ProductReference>
    <Product id="SF6105" disabled="false" removed="true">
    ...
    </Product>
    <Caption> ... </Caption>
    </ProductReference>
    ...
    </ProductReferences>
    ...
</Review>

Provide feedback button