Configuration
This page provides information about the configuration data set in the Displayable Content Export (DCE).
Example
The following is a generalized example. Your configurations will vary. Continue to the Fields section for information on each field.
{
"configs": {
"1234": {
"PRR": {
"additionalFields": {
"usage": {
"label": "How I use this product",
"valueOptions": {
"submission": "How I use this product",
"workbench": "How I use this product"
}
}
},
"contextDataDimensions": {
"Age": {
"label": "Age",
"valueOptions": {
"17orUnder": "17 or under",
"18to24": "18 to 24",
"25to34": "25 to 34",
"35to44": "35 to 44",
"45to54": "45 to 54",
"55to64": "55 to 64",
"65orOver": "65 or over",
"RatherNotSay": "I'd rather not say",
"submission": "How old are you?"
}
}
},
"ratingDimensions": {
"Quality": {
"label": null,
"valueOptions": {
"dimensionLabel1": "Quality of Product"
}
},
"ClothingFit": {
"label": null,
"valueOptions": {
"description": "Fit",
"dimensionLabel1": "runs small",
"dimensionLabel2": "runs large",
"valueLabel1": "too small",
"valueLabel2": "a little small",
"valueLabel3": "true to size",
"valueLabel4": "a little big",
"valueLabel5": "too big"
}
}
},
"tagDimensions": {
"BestUsesApparel": {
"label": "Best Uses - Apparel",
"valueOptions": {
"CasualWear": "Casual Wear",
"DateNightNightOut": "Date Night/Night Out",
"SpecialOccasions": "Special Occasions",
"WearToSchool": "Wear to School",
"WearToWork": "Wear To Work"
}
}
}
},
"QA": {...},
"CP": {...},
"SY": {...}
},
"1234-fr_ca": {...}
}
}
Fields
Display code
{
"configs": {
"1234": {...}
"1234-fr_ca": {...}
}
}
Display codes are used to group related configurations. All clients have a four or five digit default display code. For example, 1234 or 12345.
Display codes are used for localization. Localized display codes will have a locale appended to the default display code. A locale is a combination of a language code and a country code. In the following example, "fr" refers to the French language, and "ca" refers to Canada, 1234-fr_ca. The default display code is always used for en_us
Display codes are also used for special scenarios where the default configurations are not appropriate. For example, a client may need a set of configurations for a promotion or to accommodate a portion of their ecommerce site that is styled differently from the rest of their site. In these cases the display code will typically be the default code with additional characters appended to it. For example, 12345promo or 1234redes.
Content type
{
"configs": {
"1234": {
"PRR": {},
"CP": {},
"QA": {}
}
}
}
The type of Bazaarvoice content. Configurations can vary between Bazaarvoice content type. See the table below for the meaning of each acronym.
| Configuration | DCE Content type | Acronym source |
|---|---|---|
| PRR | Review | Product Rating and Reviews |
| CP | Author | Consumer Profiles |
| QA | Question | Questions & Answers |
Additional fields
"additionalFields": {
"usage": {
"label": "How I use this product",
"valueOptions": {
"submission": "How I use this product",
"workbench": "How I use this product"
}
}
}
Additional fields accept free text. In your user interface you should display the label value along with the users response.
Example UI
This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.
Context data values
"Age": {
"label": "Age",
"valueOptions": {
"17orUnder": "17 or under",
"18to24": "18 to 24",
"25to34": "25 to 34",
"35to44": "35 to 44",
"45to54": "45 to 54",
"55to64": "55 to 64",
"65orOver": "65 or over",
"RatherNotSay": "I'd rather not say",
"submission": "How old are you?"
}
}
Context data values (CDV) are the answers to multi-select questions about the author. In your user interface you should display the label value along with the users response.
Example UI
Rating dimensions
Content authors can rate different aspects or dimensions of a product.
Normal
"ratingDimensions": {
"Quality": {
"label": null,
"valueOptions": {
"dimensionLabel1": "Quality of Product"
}
},
"Normal" rating dimensions operate on a traditional lowest to highest rating scale. In your user interface you should display the dimensionLabel1 value along with the users response.
Example UI
Slider
"ClothingFit": {
"label": null,
"valueOptions": {
"description": "Fit",
"dimensionLabel1": "runs small",
"dimensionLabel2": "runs large",
"valueLabel1": "too small",
"valueLabel2": "a little small",
"valueLabel3": "true to size",
"valueLabel4": "a little big",
"valueLabel5": "too big"
}
}
},
"Slider" rating dimensions represent a continuum of value in which lower or higher do no represent worse or better. In your user interface you should include the description value along with the user's response, surrounded by dimensionLabel1 and dimensionLabel2.
Example UI
Tag dimensions
"tagDimensions": {
"BestUsesApparel": {
"label": "Best Uses - Apparel",
"valueOptions": {
"CasualWear": "Casual Wear",
"DateNightNightOut": "Date Night/Night Out",
"SpecialOccasions": "Special Occasions",
"WearToSchool": "Wear to School",
"WearToWork": "Wear To Work"
}
}
}
Tag dimensions identify the different attributes of a product. They may be multi-select and/or free text input.
Example UI
This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.
Updated 11 months ago