Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move new function to API.utils #34

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## Added

- Moved `getPixallVisitorId()` to API.utils

## [v2024-07-12T18.29.35] - 2024-07-12

## [v2024-07-11T19.56.25] - 2024-07-11

## Added
Expand Down Expand Up @@ -172,7 +178,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Tagging and uploading the releases.
- Updating the changelog after a release

[Unreleased]: https://github.com/DealerDotCom/web-integration-api-docs/compare/v2024-07-11T19.56.25...HEAD
[Unreleased]: https://github.com/DealerDotCom/web-integration-api-docs/compare/v2024-07-12T18.29.35...HEAD

[v2024-07-12T18.29.35]: https://github.com/DealerDotCom/web-integration-api-docs/compare/v2024-07-11T19.56.25...v2024-07-12T18.29.35

[v2024-07-11T19.56.25]: https://github.com/DealerDotCom/web-integration-api-docs/compare/v2023-11-15T00.44.26...v2024-07-11T19.56.25

Expand Down
13 changes: 0 additions & 13 deletions source/includes/_methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -575,16 +575,3 @@ The loadJS method is a simple way to include additional JavaScript files require
```

> Note that the `attributeMap` parameter is optional and may be ommitted in most cases.

## API.getPixallVisitorId()

The getPixallVisitorId method returns the Pixall Id for the current website visitor. Pixall provides a unique identifier for each visitor to aggregate analytics events initiated by that shopper across marketplaces.

> Usage

```javascript
(async APILoader => {
const API = await APILoader.create();
const pxa_id = await API.getPixallVisitorId();
})(window.DDC.APILoader);
```
16 changes: 16 additions & 0 deletions source/includes/_utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,3 +235,19 @@ The method must be called on each page where you want the vehicles to be unlocke
});
})(window.DDC.APILoader);
```

## API.utils.getPixallVisitorId()

The getPixallVisitorId method returns the Pixall Id for the current website visitor. Pixall provides a unique identifier for each visitor to aggregate analytics events initiated by that shopper across marketplaces.

> **Usage:**

```javascript
(async APILoader => {
const API = await APILoader.create();
API.utils.getPixallVisitorId().then(pixallId => {
// Outputs PixallVisitorId value
API.log(pixallId);
});
})(window.DDC.APILoader);
```