Structure of standard client feeds

This article contains snippets and descriptions of different parts of the standard client feed using Bazaarvoice code and the feed's scheme. To view the schema, download it and use a text editor to open the file.

Note: Some XML elements, such as <Name> or <ExternalId>, and their definitions are part of different complex objects of the feed. Therefore, they will be mentioned in different sections of this topic.

Top-level elements

The following table describes the top-level elements. Refer to the example to view an example of a top-level element in use.

Element	Description	Type
`Feed`	A root element of the XML feed file. Attributes: `xmlns`—Contains schema version of a given XML file. String (varchar(255)) `name`—Client's name. String (varchar(255)) `extractDate`—Contains the date when the feed was generated. Date (Timestamp)	Complex Object
`Product`	A complex element that contains information about a certain client's subject, its content, and stats. Refer to the Products and their elements section for more details. Attributes: `id`—A unique identifier, which is not case-sensitive. String (varchar(255)) `disabled`—Marks subjects that were explicitly marked as disabled by a client (using their product catalog). Boolean `removed`—Marks subjects that were removed from a client's catalog (absent in the product catalog and marked as Inactive in Bazaarvoice database). Note: Removed or disabled subjects and their UGC are not present in the feed by default. However, if the client confirms that this data needs to be present in the daily feed, it can be configured.	Complex Object
`Category`	Another type of client's subject. Much like a product, it contains information about the category subject, its content, and stats. Refer to the Categories and their elements section for more details. Attributes: `disabled`—Marks subjects that were explicitly marked as disabled by a client (using their product catalog). Boolean	Complex Object
`UserProfile`	Contains information about a certain user (such as a reviewer) and its stats. Refer to the User profiles and their elements section for more details. Attributes: `id`—An identifier, which is not case-sensitive. String (varchar(255))	Complex Object

Important: Bazaarvoice does not guarantee the casing of the <ExternalId> element in the Content Exports feed. Therefore, clients consuming this data should implement a case-insensitive ingestion process to ensure consistency.

Example

Copy Code

XML

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="http://www.bazaarvoice.com/xs/PRR/StandardClientFeed/14.8" name="LeCoolRetailer" extractDate="2016-01-01T05:30:00.713-05:00">
  <Product id="Product_1" disabled="false" removed="false"> ... </Product>
  ...
  <Product id="Product_N" disabled="false" removed="false"> ... </Product>
  <Category disabled="false"> ... </Category>
  ... 
  <Category disabled="false"> ... </Category>
  <UserProfile id="User_1"> ... </UserProfile>
  ...
  <UserProfile id="User_N"> ... </UserProfile>
</Feed>

Products and their elements

The following table describes products and their elements. Refer to the example to view an example of products and their elements in use.

Note: To learn more about element descriptions, schemas, and structures listed in the table, refer to the following articles:

ReviewStatistics, QAStatistics, and CommentStatistics for details on statistics including NativeReviewStatistics.
Attributes, Brands, and CategoryItems for details on product metadata.
Content types for details on content elements like Questions and Reviews.

Element	Description	Type
`Source`	The source of this piece of data in the Bazaarvoice system. This is a client name.	String (varchar(255))
`ExternalId`	A unique identifier, which is not case-sensitive. The product id attribute duplicates this value.	String (varchar(255))
`Names`	Present if a product has multiple names in different languages. Otherwise, a single Name element is used. These names are found in the product catalog.	Complex Object (sequence of `Name` elements)
`Name`	Name of a product taken from the client's product catalog. The product can have multiple names specified, each for a separate locale. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (text)
`Descriptions`	Present if a product has multiple product descriptions in different languages. Otherwise, a single Description element is used. This data is found in the product catalog.	Complex Object (sequence of `Description` elements)
`Description`	Description of a product taken from the client's product catalog. The product can have multiple descriptions specified, each for a separate locale. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (text)
`ProductPageUrls`	Present if a product has multiple product page URLs for a set of locales. Otherwise, ProductPageUrl element is used.	Complex Object (sequence of `ProductPageUrl` elements)
`ProductPageUrl`	URL to a product page on the client's website. Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use `&amp` for an ampersand, use `%20` for a space, or use `%5B` and `%5D` for square brackets ([ ]). Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	URL / String (varchar(255))
`ReviewsPageTitles`	Present if a client provided multiple review page titles for each locale.	Complex Object (sequence of `ReviewsPageTitle` elements)
`ReviewsPageTitle`	A title of the review page for a certain product. The value can be locale-specific. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (varchar(255))
`ReviewsPageMetaDescriptions`	Present if a client provides multiple review page descriptions for each locale.	Complex Object (sequence of `ReviewsPageMetaDescription` elements)
`ReviewsPageMetaDescription`	A description for a certain review page for a given product. The value can be locale-specific. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (varchar(255))
`ImageUrls`	Contains multiple image URLs (in case the client provided more than one) for different locales. Note: If Ratings & Reviews is deployed on an HTTPS site, you must provide image URLs at an HTTPS location in your product catalog. If you do not, your customers will see a mixed content warning.	Complex Object (sequence of `ImageUrl` elements)
`ImageUrl`	URL to an image of the product (provided by the client using the product catalog). This element can be locale-specific. Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use `&amp` for an ampersand, use `%20` for a space, or use `%5B` and `%5D` for square brackets ([ ]). Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	URL / String (varchar(255))
`ProductReviewsUrl`	URL to the review page of a certain product. It is generated for active products with some reviews. It is formed using the general reviews host name, display code, and product ID: http://reviews.clientname.com/displayCode/productID/reviews.htm Note: If the URL contains a reserved (special) character, you must URL-encode 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))
`ProductQuestionsUrl`	URL to the question page of a certain product. It is generated for active products with some questions. It is formed using the general Questions & Answers host name, display code, and product ID: http://answers.<clientName>.com/answers/<displayCode>/product/<productID>/questions.htm Note: If the URL contains a reserved (special) character, you must URL-encode 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))
`ModelNumbers`	Contains multiple model numbers applicable to a current product.	Complex Object (sequence of `ModelNumber` elements)
`ModelNumber`	A model number of a given product. Provided by a client using the product catalog.	String (varchar(255))
`ManufacturerPartNumbers`	Contains multiple manufacturer part numbers applicable to a current product.	Complex Object (sequence of `ManufacturerPartNumber` elements)
`ManufacturerPartNumber`	The manufacturer part number of a given product. Provided by a client using the product catalog.	String (varchar(255))
`EANs`	A set of EAN barcodes that are applicable to a product. Provided by a client using the product catalog.	Complex Object (sequence of `EAN` elements)
`EAN`	International article number of a product (one of few supported barcode standards). Supports 8-digit and 13-digit values. Patterns: [0-9]{8} and [0-9]{13}	Long (8-byte integer)
`UPCs`	A set of UPC barcodes that are applicable to a product. Provided by a client using the product catalog.	Complex Object (sequence of `UPC` elements)
`UPC`	Universal Product Code of a given product (another barcode standard supported by Bazaarvoice). Supports 6-digit and 12-digit values. Pattern: [0-9]{6} and [0-9]{12}	Long (8-byte integer)
`ISBNs`	A set of ISBN barcodes that are applicable to a product, such as paper books or e-books. Provided by a client using the product catalog.	Complex Object (sequence of `ISBN` elements)
`ISBN`	International Standard Book Number of a product (numeric identifier standard used for books). Pattern: [0-9]{8,12}[0-9X]	Long (8-byte integer)
`NumNativeQuestions`	Number of native-approved questions for this product (non-syndication).	Int (4-byte integer)
`NumQuestions`	Number of approved questions for this product (including syndication).	Int (4-byte integer)
`NumNativeAnswers`	Number of native-approved answers for this product (non-syndication).	Int (4-byte integer)
`NumAnswers`	Number of approved answers for this product (including syndication).	Int (4-byte integer)
`NumReviews`	Number of approved reviews for this product (including syndication).	Int (4-byte integer)
`ReviewStatistics`	Contains detailed information about all ratings and reviews of the product (stats including syndication).	Complex Object (description of its fields is provided in ReviewStatistics, QAStatistics, and CommentStatistics)
`NativeReviewStatistics`	Contains detailed information about native ratings and reviews of the product (non-syndication stats).	Complex Object
`Brand`	Contains reference to the brand of a given product.	Complex Object
`CategoryItems`	Contains reference to a Categories element, under which a given product resides. Categories are represented as a chain sorted from the child to parent.	Complex Object (sequence of `CategoryItem` elements)
`Attributes`	Contains a list of custom and additional attributes of a product.	Complex Object (sequence of `Attribute` elements)
`Questions`	Parent element for all questions related to this product.	Complex Object (sequence of `Question` elements)
`Reviews`	Parent element for all reviews related to this product.	Complex Object (sequence of `Review` elements)

Example

Copy Code

XML

<Product id="Product154812" removed="false" disabled="false">
  <Source>LeCoolRetailer</Source>
  <ExternalId>Product154812</ExternalId>

  <!-- Product will have either a single Name or Names element -->
  <Name>Imaginary game console 4 500GB Console - Some game: Green Ops III Bundle</Name>
  <Names>
  <Name locale="en_US">Imaginary game console 4 500GB - Some game: Green Ops III Bundle</Name>
  <Name locale="de_DE">Imaginäre Spielkonsole 4 500GB - Einige Spiel: Grün Ops III Bundle</Name>
  ...
  </Names>

  <!-- Product will have a Description or Descriptions element -->
  <Description>This console system opens the door to an incredible journey through immersive new gaming worlds and a deeply connected gaming community. It puts gamers first with an astounding launch lineup and over 100500 games in development. Play amazing top-tier blockbusters and innovative indie hits on our system. </Description>
  <Descriptions>
  <Description locale="en_US">
  This console system opens the door to an incredible journey through immersive new gaming worlds and a deeply connected gaming community. 
  It puts gamers first with an astounding launch lineup and over 100500 games in development. 
  Play amazing top-tier blockbusters and innovative indie hits on our system.
  </Description>
  <Description locale="de_DE"> 
  Diese Konsole System öffnet die Tür zu einer unglaublichen Reise durch fesselnde neue Spielwelten und einer tief verbunden Gaming-Community.
  Es bringt die Spieler zuerst mit einer erstaunlichen Start-Formation und über 100500 Spiele in der Entwicklung.
  Spielen erstaunlich Top-Tier-Blockbustern und innovative Indie-Hits auf unserem System.  
  </Description>
  ...
  </Descriptions>

  <!-- Product will have a single ProductPageUrl or ProductPageUrls element -->
  <ProductPageUrl>http://www.lecoolretailer.com/store/product/imaginary-game-console-4-black-ops/154812</ProductPageUrl>
  <ProductPageUrls>
  <ProductPageUrl locale="en_US">http://www.lecoolretailer.com/store/product/imaginary-game-console-4-black-ops/154812</ProductPageUrl>
  <ProductPageUrl locale="de_DE">http://de.lecoolretailer.com/store/product/imaginare-spiel-konsole-4-black-ops/154812</ProductPageUrl>
  ...
  </ProductPageUrls>

  <!-- Product might have a ReviewsPageTitle or ReviewsPageTitles element -->
  <ReviewsPageTitle>Imaginary game console 4</ReviewsPageTitle>
  <ReviewsPageTitles>
  <ReviewsPageTitle locale="en_US">Imaginary game console 4</ReviewsPageTitle>
  <ReviewsPageTitle locale="de_DE">Imaginäre Spielkonsole 4</ReviewsPageTitle>
  ...
  </ReviewsPageTitles>

  <!-- Product might have a ReviewsPageMetaDescription or ReviewsPageMetaDescriptions element -->
  <ReviewsPageMetaDescription>Product reviews and customer ratings. Read and compare real experiences.</ReviewsPageMetaDescription>
  <ReviewsPageMetaDescriptions>
  <ReviewsPageMetaDescription locale="en_US">Product reviews and customer ratings for Console of new generation. Read and compare real experiences.</ReviewsPageMetaDescription>
  <ReviewsPageMetaDescription locale="de_DE"Produktbewertungen und Kundenbewertungen für Konsole der neuen Generation. Lesen und realen Erfahrungen zu vergleichen.</ReviewsPageMetaDescription>
  ...
  </ReviewsPageMetaDescriptions>

  <!-- Product might have one or multiple images in ImageUrl or ImageUrls elements -->
  <ImageUrl>http://s7d9.scene7.com/is/image/lecoolretailer_us/15875517838466p</ImageUrl>
  <ImageUrls>
  <ImageUrl locale="en_US">http://s7d9.scene7.com/is/image/lecoolretailer_us/15875517838466p</ImageUrl>
  <ImageUrl locale="de_DE">http://s7d9.scene7.com/is/image/lecoolretailer_de/12312341235572d</ImageUrl>
  ...
  </ImageUrls>

  <ProductReviewsUrl>http://reviews.lecoolretailer.com/1234/154812/imaginary-game-console-4-black-ops-reviews/reviews.htm</ProductReviewsUrl>
  <ProductQuestionsUrl>http://answers.lecoolretailer.com/answers/1234/product/154812/imaginary-game-console-4-black-ops-questions-answers/questions.htm</ProductQuestionsUrl>  

  <!-- Model, part numbers, EANs, UPCs, ISBNs are all included if client provided us with these product attributes using product catalog. 
  Each of these data types can have multiple values listed in appropriate block. -->
  <ModelNumbers>
  <ModelNumber>0051391</ModelNumber>
  ...
  </ModelNumbers> 
  <ManufacturerPartNumbers>
  <ManufacturerPartNumber>239324</ManufacturerPartNumber>
  ...
  </ManufacturerPartNumbers>
  <EANs>
  <EAN>0711719860037</EAN>
  ...
  </EANs>
  <UPCs>
  <UPC>711719500728</UPC>
  ...
  </UPCs>
  <ISBNs>
  <ISBN>047875846913</ISBN>
  ...
  </ISBNs>

  <NumNativeQuestions>4</NumNativeQuestions>
  <NumQuestions>120</NumQuestions>
  <NumNativeAnswers>1</NumNativeAnswers>
  <NumAnswers>24</NumAnswers>
  <NumReviews>42</NumReviews>

  <!-- Examples and descriptions of the following elements are present in separate sections of this doc. -->

  <ReviewStatistics>
  ...
  </ReviewStatistics>

  <NativeReviewStatistics>
  ...
  </NativeReviewStatistics>

  <Brand disabled="false">
  ...
  </Brand>

  <!-- Category chain -->
  <CategoryItems>
  ...
  </CategoryItems>

  <!-- Product attributes -->
  <Attributes>
  ...
  </Attributes>

  <Questions>
  ...
  </Questions>

  <Reviews>
  ...
  </Reviews>

</Product>

Categories and their elements

The following table describes categories and their elements. Refer to the example to view an example of categories and their elements in use.

Note: Category subjects are similar to products from a structure (model) point of view. Categories have different conception and catalog levels.

Element	Description	Type
`ExternalId`	An identifier, which is not case-sensitive. Identical to category ID attribute.	String (varchar(255))
`CategoryPath`	A category chain (reflects parent categories of a given category, ordered by hierarchy). Each category element (category link) is a reference to an existing category in the Bazaarvoice database, containing ExternalId and single Name elements.	Complex Object (sequence of `Category` objects)
`Name`	Name of a category taken from the client's product catalog. Products can have multiple names specified, each for a separate locale. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (text)
`Names`	Present if a product has multiple names in different languages. Otherwise, a single Name element is used. These names are found in the product catalog.	Complex Object (sequence of `Name` elements)
`CategoryPageUrl`	A URL to a category page on the client's website. Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use `&amp` for an ampersand, use `%20` for a space, or use `%5B` and `%5D` for square brackets ([ ]). Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	URL / String (varchar(255))
`CategoryPageUrls`	Present if category has multiple product page URLs specified for a set of locales. Otherwise, a single CategoryPageUrl element is used.	Complex Object (sequence of `CategoryPageUrl` elements)
`ImageUrl`	URL to an image of the category (provided by client using the product catalog). The value can be locale-specific. Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use `&amp` for an ampersand, use `%20` for a space, or use `%5B` and `%5D` for square brackets ([ ]). Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	URL / String (varchar(255))
`ImageUrls`	Contains multiple Image URLs (in case client provided more than one) for different locales.	Complex Object (sequence of `ImageUrl` elements)
`ReviewsPageTitles`	Present if client provided multiple review page titles for each locale.	Complex Object (sequence of `ReviewsPageTitle` elements)
`ReviewsPageTitle`	Can be used to store a title of review pages for all products under this category. The value can be locale-specific as well. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (varchar(255))
`ReviewsPageMetaDescriptions`	Present if client provided multiple review page descriptions for each locale.	Complex Object (sequence of `ReviewsPageMetaDescription` elements)
`ReviewsPageMetaDescription`	A description for review pages for products under the given category. The value can be locale-specific. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (varchar(255))
`NumNativeQuestions`	Number of native-approved questions for this category (non-syndication).	Int (4-byte integer)
`NumQuestions`	Number of approved questions for this category (including syndication).	Int (4-byte integer)
`NumNativeAnswers`	Number of native-approved answers for this category (non-syndication).	Int (4-byte integer)
`NumAnswers`	Number of approved answers for this category (including syndication).	Int (4-byte integer)
`Attributes`	Contains a list of custom and additional attributes of a given category. Refer to the Attributes, Brands, and CategoryItems section for more details.	Complex Object (sequence of `Attribute` elements)
`Questions`	Root for all questions related to this category. Refer to the Question type section for more details.	Complex Object (sequence of `Question` elements)

Example

Copy Code

XML

<Caps://www.THE_BEST_GUITAR_STORE_EVER.com/browse/acoustic</CategoryPageUrl>
  <CategoryPageUrls>
  <CategoryPageUrl locale="en_GB">https://www.THE_BEST_GUITAR_STORE_EVER.com/browse/acoustic</CategoryPageUrl>
  <CategoryPageUrl locale="de_DE">https://www.THE_BEST_GUITAR_STORE_EVER.de/browse/acoustic?language=deutsch</CategoryPageUrl>
  ...
  </CategoryPageUrls>

  <!-- Category will hold either a single ImageUrl or ImageUrls element -->
  <ImageUrl>http://www.THE_BEST_GUITAR_STORE_EVER.cimages/category/categoryimages/Acoustic.jpg</ImageUrl>
  <ImageUrls>
  <ImageUrl locale="en_GB">http://www.THE_BEST_GUITAR_STORE_EVER.cimages/category/categoryimages/Acoustic.jpg</ImageUrl>
  <ImageUrl locale="de_DE">http://www.THE_BEST_GUITAR_STORE_EVER.images/category/categoryimages/Acoustic.jpg</ImageUrl>
  ...
  </ImageUrls>

  <!-- Category might have a ReviewsPageTitle or ReviewsPageTitles element -->
  <ReviewsPageTitle>Share your acoustic guitar playing experience.</ReviewsPageTitle>
  <ReviewsPageTitles>
  <ReviewsPageTitle locale="en_US">Share your acoustic guitar playing experience.</ReviewsPageTitle>
  <ReviewsPageTitle locale="de_DE">Teilen Sie Ihre Akustikgitarre Spielerlebnis.</ReviewsPageTitle>
  ...
  </ReviewsPageTitles>

  <!-- Category might have a ReviewsPageMetaDescription or ReviewsPageMetaDescriptions element -->
  <ReviewsPageMetaDescription>Category reviews and customer ratings. Read and compare real experiences.</ReviewsPageMetaDescription>
  <ReviewsPageMetaDescriptions>
  <ReviewsPageMetaDescription locale="en_US">Category contains product with reviews and customer ratings for Acoustic guitars. Read and compare real experiences. </ReviewsPageMetaDescription>
  <ReviewsPageMetaDescription locale="de_DE">Kategorie hält Produkt Testberichte und Kundenbewertungen für Akustikgitarren. Lesen und realen Erfahrungen zu vergleichen.</ReviewsPageMetaDescription>
  ...
  </ReviewsPageMetaDescriptions>

  <NumNativeQuestions>1</NumNativeQuestions>
  <NumNativeAnswers>2</NumNativeAnswers>
  <NumQuestions>65</NumQuestions>
  <NumAnswers>73</NumAnswers>

  <!-- Examples and descriptions of the following elements are present in separate sections of this doc. -->

  <Attributes>
  ...
  </Attributes>

  <Questions>
  ...
  </Questions>

</Category>

Attributes, Brands, and CategoryItems

The following table describes attributes, brands, and category items. Refer to the example to view an example of attributes, brands, and category items in use.

Element	Description	Type
`Brand`	Contains reference to the brand of a given product. Attributes: `disabled`—Much like products and categories, brands can be disabled using the product catalog import (provided by client). This is a marker of such brands. Boolean	Complex Object
`Names`	Present if a product has multiple names in different languages. Otherwise, a single Name element is used. These names are found in the product catalog.	Complex Object (sequence of `Name` elements)
`Name`	Name of a product taken from the client's product catalog. Products can have multiple names specified, each for a separate locale. Attributes: `locale`—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))	String (text)
`ExternalId`	An identifier, which is not case-sensitive, usually identical to the `id` attribute.	String (varchar(255))
`CategoryItems`	This block contains reference to categories, under which a given product resides. Categories are represented as a chain sorted from the child to root.	Complex Object (sequence of `CategoryItem` elements)
`CategoryItem`	A specific category link of a full category chain (root, intermediate, or leaf element). Attributes: `id`—Unique identifier of a given piece of content in the Bazaarvoice Network. String (varchar(255))	Complex Object
`CategoryId`	One of a few identifiers of a category. This one is an actual ID of a record in the Bazaarvoice database. It is unique among all clients.	Long (8-byte integer)
`CategoryName`	Name of a given category item.	String (varchar(255))
`Attributes`	Contains a list of custom and additional attributes of a product.	Complex Object (sequence of `Attribute` elements)
`Attribute`	Attribute of a given subject (product, brand, category). Can hold any additional information a client stores in Bazaarvoice databases, such as department, color, or size. Attributes: `id`—Unique identifier of a given piece of content in the Bazaarvoice Network. String (varchar(255))	Complex Object (contains a single `Value` element)
`Value`	Contains a text that describes or explains an attribute.	String (text)

Example

Copy Code

XML

<Product id="Product-X-123890">
  ...

  <Brand disabled="false">
  <!-- Brand can have either a Name or Names element -->
  <Name>Fender</Name>
  <Names>
  <Name locale="en_GB">Fender Brand</Name>
  <Name locale="de_DE">Fender Marke</Name>
  ...
  </Names>

  <ExternalId>810</ExternalId>
  <Attributes>
  <Attribute id="Country">
  <Value>United States</Value>
  </Attribute>
  ...
  </Attributes>
  </Brand>

  <CategoryItems>
  <CategoryItem id="22906">
  <ExternalId>22906</ExternalId>
  <CategoryId>996222</CategoryId>
  <CategoryName>Acoustic</CategoryName>
  </CategoryItem>
  <CategoryItem id="22905">
  <ExternalId>22905</ExternalId>
  <CategoryId>996221</CategoryId>
  <CategoryName>Guitars</CategoryName>
  </CategoryItem>
  <CategoryItem id="22904">
  <ExternalId>22904</ExternalId>
  <CategoryId>996220</CategoryId>
  <CategoryName>Instruments</CategoryName>
  </CategoryItem>
  </CategoryItems>

  <Attributes>
  <Attribute id="Department">
  <Value>Austin Guitar House</Value>
  </Attribute>
  <Attribute id="ColorIdentifier">
  <Value>Sunburst</Value>
  </Attribute>
  </Attributes>

  ... 
</Product>

User profiles and their elements

The following table describes user profiles and their elements. Refer to the example to view an example of user profiles and their elements in use.

Note: To learn more about element descriptions, schemas, and structures listed in the table, refer to the following:

ReviewStatistics, QAStatistics, and CommentStatistics for details on statistics including NativeReviewStatistics.
Complex contextual objects for details on objects including Tags, Badges, Photos, and Videos.

Element	Description	Type
`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))
`DisplayName`	Name of the reviewer displayed with their content.	String (varchar(255))
`Anonymous`	A Boolean value that shows whether a given reviewer decided to stay anonymous. If true, most of the information and fields are not displayed.	Boolean
`HyperlinkingEnabled`	Indicates if a reviewer's answers will automatically be parsed for hyperlinks.	Boolean
`ContributorRank`	The contributor rank assigned to a reviewer. Possible values: TOP_1, TOP_10, TOP_25, TOP_50, TOP_100, TOP_250, TOP_500, TOP_1000, NONE.	Enum
`SubmissionTime`	The time that a review was submitted into the Bazaarvoice CMS.	Date (Timestamp)
`DisplayLocale`	Contains the locale from which a review was submitted.	String (varchar(25))
`ModerationStatus`	Contains information about the current status of a reviewer. This field can say whether a reviewer is waiting for some action from moderators, CMS, or is approved or rejected. Possible values: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED.	Enum
`Location`	Contains information about the location of a user.	String (varchar(255))
`LastPublishTime`	The time that a review was moderated and published using the CMS.	Date (Timestamp)
`Avatar`	Reference to a user's avatars in different sizes.	Complex Object (sequence of `Photo` elements)
`ReviewStatistics`	Contains stats information about all ratings and reviews of a user.	Complex Object
`QAStatistics`	Contains stats information about all questions and answers of a user.	Complex Object
`ReviewCommentStatistics`	Contains stats information about all review comments of a user.	Complex Object
`Badges`	Contains a list of badges applied to a reviewer.	Complex Object (sequence of `Badge` elements)
`AdditionalFields`	Contains a list of additional (non-default) fields a reviewer record might have.	Complex Object (sequence of `AdditionalField` elements)
`ContextDataValues`	Contains multiple context data values chosen by a reviewer (such as information about age, habits, or experience).	Complex Object (sequence of `ContextDataValue` elements)
`RatingValues`	Contains a list of secondary rating stats (ratings chosen by the author for different dimensions or qualities).	Complex Object (sequence of `RatingValue` elements)
`Photos`	A set of photo references with captions.	Complex Object (sequence of `Photo` elements)
`Videos`	A set of video references with captions.	Complex Object (sequence of `Video` elements)

Example

Copy Code

XML

<UserProfile id="5dd667303d40625232cb5d5aaa409247">
  <ExternalId>5dd667303d40625232cb5d5aaa409247</ExternalId>
  <DisplayName>Doc Brown</DisplayName>
  <Anonymous>false</Anonymous>
  <HyperlinkingEnabled>false</HyperlinkingEnabled>
  <ContributorRank>TOP_25</ContributorRank>
  <SubmissionTime>2016-01-25T16:55:31.000-06:00</SubmissionTime>
  <DisplayLocale>en_US</DisplayLocale>
  <ModerationStatus>APPROVED</ModerationStatus>
  <Location>East Coast</Location>
  <LastPublishTime>2016-01-25T19:30:38.000-06:00</LastPublishTime>

  <!-- Following elements are described in other sections of this doc. Refer to the Example standard client feed table. -->

  <Avatar id="466578" photo="true">
  ...
  </Avatar>

  <ReviewStatistics>
  ...
  </ReviewStatistics>

  <QAStatistics>
  ...
  </QAStatistics>  

  <ReviewCommentStatistics>
  ...
  </ReviewCommentStatistics>

  <Badges>
  ...
  </Badges>

  <RatingValues>
  ...
  </RatingValues>

  <ContextDataValues>
  ...
  </ContextDataValues>

  <AdditionalFields>
  ...
  </AdditionalFields>

  <Photos>
  ...
  </Photos>

  <Videos>
  ...
  </Videos>

</UserProfile>