Plugin that adds detailed page-related methods to ddl-tools.
Kind: global constant
Example
import DDLTools from 'ddl-tools';
import DDLValidator from 'ddl-validator';
import pageDeepPlugin from 'ddl-tools-plugin-page-deep';
import schema from './path/to/mySchema';
const ddlValidator = new DDLValidator(schema);
const ddlTools = new DDLTools(window.digitalData, ddlValidator);
ddlTools.use(pageDeepPlugin);- pageDeepPlugin
- .setPageId(value) ⇒
object - .setPageName(value) ⇒
object - .setDestinationURL(value) ⇒
object - .setReferringURL(value) ⇒
object - .setSysEnv(value) ⇒
object - .setVariant(value) ⇒
object - .setVersion(value) ⇒
object - .setBreadCrumbs(breadCrumbs) ⇒
object - .setAuthor(value) ⇒
object - .setIssueDate(value) ⇒
object - .setEffectiveDate(value) ⇒
object - .setExpiryDate(value) ⇒
object - .setLanguage(value) ⇒
object - .setGeoRegion(value) ⇒
object - .setIndustryCodes(value) ⇒
object - .setPublisher(value) ⇒
object - .setPagePrimaryCategory(value) ⇒
object - .setPageSubCategory(value) ⇒
object - .setPageCategoryProductType(value) ⇒
object
- .setPageId(value) ⇒
Records the page's identifier.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's name.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's destination URL (ie. document.location).
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's referring URL (ie. document.referrer).
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's system environment (ie. production vs development).
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page variant (A/B testing).
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's version.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's bread crumbs (semantic path).
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| breadCrumbs | Array.<string> |
path list within site hierarchy |
Records the name of the page's author.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's issue date. (JS Date or ISO 8601)
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's effective date. (JS Date or ISO 8601)
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's expiration date. (JS Date or ISO 8601)
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the human language the page is written in. (ISO 639)
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the geographic region the page applies to (ie. country). (ISO 3166)
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the industry codes the page applies to. (Standard Industrial Classification / SIC code)
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the page's publisher name.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the primary category of the page.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the sub-level category of the page.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |
Records the type of product in the page.
Kind: static method of pageDeepPlugin
Returns: object - - Self reference for chaining
| Param | Type | Description |
|---|---|---|
| value | string |
value to set |