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.

Sign up for GitHub

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

Docs for AppNexus Debug auction #1044

Merged
merged 1 commit into from
Dec 20, 2018
Merged

Docs for AppNexus Debug auction #1044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions dev-docs/bidders/appnexus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ gdpr_supported: true
- [App Object](#appnexus-app-object)
- [Custom Targeting keys](#custom-targeting-keys)
- [Passing Keys Without Values](#appnexus-no-value)
- [Debug Auction](#appnexus-debug-auction)

<a name="appnexus-bid-params" />

Expand Down Expand Up @@ -148,3 +149,26 @@ keywords: {
otherKeyword: ['']
}
```

<a name="appnexus-debug-auction" />

#### Debug Auction

{: .alert.alert-danger :}
Enabling the AppNexus Debug Auction feature should only be done for diagnosing the AppNexus auction. Do not enable this feature in a production setting where it may impact users.

To understand what is happening behind the scenes during an auction, you can enable a debug auction by adding an `apn_prebid_debug` cookie with a JSON string. For example:

{% highlight js %}
{ "enabled": true, "dongle": "QWERTY", "debug_timeout": 1000, "member_id": 958 }
{% endhighlight %}

To view the results of the debug auction, add the `pbjs_debug=true` query string parameter and open your browser's developer console.

{: .table .table-bordered .table-striped }
| Name | Description | Example | Type |
|-------------------|-----------------------------------------------------------------|-----------------------|------------------|
| `enabled` | Toggle the debug auction to occur | `true` | `boolean` |
| `dongle` | Your account's unique debug password. | `QWERTY` | `string` |
| `member_id` | The ID of the member running the debug auction | `958` | `integer` |
| `debug_timeout` | The timeout for the debug auction results to be returned | `3000` | `integer` |