Implement PAX Config Support for contentConfig.partnerAdsExperienceConfig.reportingStyle
Property
#8637
Closed
1 task done
Labels
javascript
Pull requests that update Javascript code
Module: Ads
Google Ads module related issues
P0
High priority
Squad 1 (Team S)
Issues for Squad 1
Type: Enhancement
Improvement of an existing feature
Feature Description
As an extension to the PAX main component and scaffolding work done in #8556 and #8557, there is a need to implement the newly added PAX config property
contentConfig.partnerAdsExperienceConfig.reportingStyle
, which will be abstracted by the PAX componentdisplayMode
prop.Applicable values of this config property are:
REPORTING_STYLE_FULL
- Will render the full PAX experience, and should be the default modeREPORTING_STYLE_MINI
- Will render the reporting widget onlyAs indicated in #8556 and #8557, support for this display mode was made available via a
displayMode
prop on the main PAX component, but it was not clear at the time what config value(s) these properties would interface with.Component and config work implemented thus far should be extended so that values passed to
displayMode
prop are forwarded and abstracted as PAX config properties applicable tocontentConfig.partnerAdsExperienceConfig.reportingStyle
. The following values were earmaked for use as values passed to thedisplayMode
prop:'setup'
- Indicates the full PAX experience is desired, and should result in thecontentConfig.partnerAdsExperienceConfig.reportingStyle
config prop having a value ofREPORTING_STYLE_FULL
'reporting'
- Indicates the widget reporting view for PAX, and should result in thecontentConfig.partnerAdsExperienceConfig.reportingStyle
config prop having a value ofREPORTING_STYLE_MINI
'default' (or null/omitted)
- Indicates the full PAX experience is desired, and should result in thecontentConfig.partnerAdsExperienceConfig.reportingStyle
config prop having a value ofREPORTING_STYLE_FULL
Implementation of the existing PAX config logic should be extended to cater for the above scenario.
Do not alter or remove anything below. The following sections will be managed by moderators only.
Acceptance criteria
PAX
component #8557 should be extended/enhanced to support the PAX config propertycontentConfig.partnerAdsExperienceConfig.reportingStyle
displayMode
prop should be abstracted to result in the applicablecontentConfig.partnerAdsExperienceConfig.reportingStyle
values ofREPORTING_STYLE_FULL
when the value of thedisplayMode
prop is'setup'
or'default'
, orREPORTING_STYLE_MINI
when the value of thedisplayMode
prop is'reporting'
Implementation Brief
assets/js/modules/ads/components/PAXEmbeddedApp.js
paxConfig
constant value, by including new property in the object:contentConfig.partnerAdsExperienceConfig.reportingStyle
(dots annotate nesting)displayMode
has value ofreporting
to useREPORTING_STYLE_MINI
REPORTING_STYLE_FULL
by defaultTest Coverage
QA Brief
displayMode
.Changelog entry
reportingStyle
config.The text was updated successfully, but these errors were encountered: