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

Updated MASS documentation #3157

Merged
merged 7 commits into from
Sep 2, 2021
Merged
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
38 changes: 34 additions & 4 deletions dev-docs/modules/mass.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,16 +139,46 @@ pbjs.que.push(function() {

## Integration Example

There are two options to view the integration example:

### Option 1 - Your own development environment
To view the integration example:

1) in your cli run:
1) Build Prebid using the following required options

```
gulp build --modules=ixBidAdapter,mass
```

2) Use a http server with a valid hostname to access its content. It is not advised to run the bid simulation using localhost or 127.0.0.1

```
gulp serve --modules=ixBidAdapter,mass
http://hostname/integrationExamples/mass/index.html
```

2) in your browser, navigate to:
### Option 2 - Hosted online
Mass Platform Limited hosts an official integration and demo page that can be accessed using the following link: http://demo.massplatform.com/ix/prebid/

## Testing MASS
Testing requires valid bids to be returned to Prebid. To assist with this process, we recommend you use the MASS Bid Simulation tool found at https://github.com/massplatform/bidsim. Your Exchange partner might be able to assist you with other specialist tools and browser plugins to achieve similar resuls.

The instructions below assume that you have followed the installation instructions for the MASS Bidsim tool found at https://github.com/massplatform/bidsim/blob/master/README.md.

### Testing using MASS compliant tags
The bidsim tool ships with working DSP example tags that can be found under the bidsim/tags folder.
cciocov marked this conversation as resolved.
Show resolved Hide resolved

A quick way to test the Integration test page in combination with the official bootloader is to use the following command:
```
node bidsim --inject --bid 2000 --width 300 --height 250 --dealid 'MASS' --tag "tags/inskin-housead-desktop.js" -o https://demo.massplatform.net/ix/prebid
```
http://localhost:9999/integrationExamples/mass/index.html
### For third-party technology companies
Third-parties that wish to integrate with the official MASS bootloader can get started by running the following command:
```
node bidsim --inject --bid 2000 --width 300 --height 250 --dealid 'MASS' --tag "tags/test.js" -o https://demo.massplatform.net/ix/prebid
```

Explanation: The tags/test.js tag calls a reference endpoint for developers that can be accessed here: https://demo.massplatform.net/reference/endpoint.js.
When running the above command to invoke this reference endpoint, you will see all the params that MASS collected and passed onto your endpoint. This includes inputs, parsed inputs, tag parameters and MASS/Provider specific configurations.

### Testing on live sites
Any sites that have been MASS configured will work with the Bidsim tool. This is a convenient way to test whether your publisher ad server and slot is correctly configured.