Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
Skitelman authored Jun 3, 2024
2 parents 66907ff + 042953d commit 9fab077
Show file tree
Hide file tree
Showing 54 changed files with 2,244 additions and 1,284 deletions.
25 changes: 17 additions & 8 deletions _data/dropdown_v2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@
- subsectionId: 0
sectionId: 1
sectionName: Product
title: Analytics
link: /overview/analytics.html
title: Modules
link: /dev-docs/modules/index.html
needsDivider: 0
isHeader: 0
isSubHeader: 0
Expand All @@ -71,8 +71,8 @@
- subsectionId: 0
sectionId: 1
sectionName: Product
title: Modules
link: /dev-docs/modules/index.html
title: Publisher API
link: /dev-docs/publisher-api-reference.html
needsDivider: 0
isHeader: 0
isSubHeader: 0
Expand All @@ -81,8 +81,8 @@
- subsectionId: 0
sectionId: 1
sectionName: Product
title: Publisher API
link: /dev-docs/publisher-api-reference.html
title: Bidder Params
link: /dev-docs/bidders.html
needsDivider: 0
isHeader: 0
isSubHeader: 0
Expand All @@ -91,8 +91,8 @@
- subsectionId: 0
sectionId: 1
sectionName: Product
title: Bidder Params
link: /dev-docs/bidders.html
title: Analytics
link: /overview/analytics.html
needsDivider: 0
isHeader: 0
isSubHeader: 0
Expand Down Expand Up @@ -276,6 +276,15 @@
sectionName: Support
title: Prebid Server
link: /faq/prebid-server-faq.html
needsDivider: 0
isHeader: 0
isSubSectionStart: 0

- subsectionId: 3
sectionId: 2
sectionName: Support
title: Prebid Mobile
link: /faq/prebid-mobile-faq.html
needsDivider: 1
isHeader: 0
isSubSectionStart: 0
Expand Down
65 changes: 24 additions & 41 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,14 @@
sectionTitle:
subgroup: 0

- sbSecId: 1
title: Analytics For Prebid
link: /overview/analytics.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 0

- sbSecId: 1
title: Consent Management Best Practices
link: /dev-docs/cmp-best-practices.html
Expand Down Expand Up @@ -507,31 +515,6 @@
sectionTitle:
subgroup: 6

- sbSecId: 1
title: Analytics
link:
isHeader: 1
headerId: analytics
isSectionHeader: 0
sectionTitle:
subgroup: 7

- sbSecId: 1
title: Analytics For Prebid
link: /overview/analytics.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 7

- sbSecId: 1
title: Prebid Analytics for GA
link: /overview/ga-analytics.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 7

- sbSecId: 1
title: Features
link:
Expand Down Expand Up @@ -743,6 +726,14 @@
sectionTitle:
subgroup: 2

- sbSecId: 2
title: Global Parameters
link: /prebid-mobile/pbm-api/ios/pbm-targeting-ios.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 2

- sbSecId: 2
title: GAM Original Integration
link: /prebid-mobile/pbm-api/ios/ios-sdk-integration-gam-original-api.html
Expand Down Expand Up @@ -783,14 +774,6 @@
sectionTitle:
subgroup: 2

- sbSecId: 2
title: Targeting Parameters
link: /prebid-mobile/pbm-api/ios/pbm-targeting-ios.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 2

- sbSecId: 2
title: Ad Experience Controls
link: /prebid-mobile/modules/rendering/combined-ad-experience-controls.html
Expand Down Expand Up @@ -824,6 +807,14 @@
sectionTitle:
subgroup: 3

- sbSecId: 2
title: Global Parameters
link: /prebid-mobile/pbm-api/android/pbm-targeting-params-android.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 3

- sbSecId: 2
title: GAM Original Integration
link: /prebid-mobile/pbm-api/android/android-sdk-integration-gam-original-api.html
Expand Down Expand Up @@ -864,14 +855,6 @@
sectionTitle:
subgroup: 3

- sbSecId: 2
title: Targeting Parameters
link: /prebid-mobile/pbm-api/android/pbm-targeting-params-android.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 3

- sbSecId: 2
title: Ad Experience Controls
link: /prebid-mobile/modules/rendering/combined-ad-experience-controls.html
Expand Down
1 change: 0 additions & 1 deletion adops/before-you-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sbUUID: 3.2
---

# Ad Ops and Prebid

{: .no_toc }

Ad Operations (Ad Ops) are the people who work directly with the ad server software to create, analyze, and update ad campaigns. In companies that use automated processes rather than working directly in the ad server UI, people in Ad Ops define the inputs to the automation that ensure campaigns run as expected. Whatever your actual job title or exact job description, when we refer to “Ad Ops” we’re talking about the non-engineering tasks involved in running and managing ad campaigns.
Expand Down
2 changes: 1 addition & 1 deletion adops/js-dynamic-creative.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ To render native ads, you also need to include the [nativeRendering](/dev-docs/m

## Further reading

- [Creative Considerations](/adops/creative-considerations.md)
- [Creative Considerations](/adops/creative-considerations.html)
- [Prebid Universal Creative](/overview/prebid-universal-creative.html)
- [Native rendering module](/dev-docs/modules/nativeRendering.html)
34 changes: 33 additions & 1 deletion dev-docs/analytics/sharethrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,36 @@ modulecode: sharethrough

#### Registration

Please visit [www.sharethrough.com](https://www.sharethrough.com/) for more information.
This module is free to use.

#### About

This analytics adapter collects data about win/loss events (beacon firings) from each auction run on your site. This data is communicated to Sharethrough via API calls the analytics adapter makes to an endpoint dedicated to the collection of beacon information. Sharethrough uses this information to improve its services as a SSP.

#### Example Configuration

```js
pbjs.enableAnalytics({
provider: 'sharethrough',
})
```

#### Compiling from Source (Optional)

In order to guarantee consistent reporting events, we recommend
including the GPT Pre-Auction Module, `gptPreAuction`. This module is included
by default when Prebid is downloaded.

If you are compiling from source, this might look something like:

```sh
gulp bundle --modules=gptPreAuction,sharethroughBidAdapter,sharethroughAnalyticsAdapter
```

Please note that the above snippet is a "bare bones" example - you will likely want to include other modules as well. A more realistic example might look something like the example below (with other bid adapters also included in the list as needed):

```sh
gulp bundle --modules=gptPreAuction,consentManagement,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,gdprEnforcement,sharethroughBidAdapter,sharethroughAnalyticsAdapter
```

Enable the Sharethrough Analytics Adapter in Prebid.js using the analytics provider `sharethrough` as seen in the **Example Configuration** section.
21 changes: 19 additions & 2 deletions dev-docs/analytics/tercept.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,25 @@ layout: analytics
title: Tercept
description: Tercept Analytics Adapter
modulecode: tercept
enable_download: true
---

#### Registration
To start using Prebid Analytics, please, email us at <gourav.chindlur@tercept.com> to provide us with your billing info and get your personal publisher ID & Key along with other details which are used in the prebid config on your site/s.
Add the following code to your prebid.js config to activate Prebid Analytics:
#### Example Configuration

```text
pbjs.que.push(function() {
pbjs.enableAnalytics({
provider: 'tercept',
options: {
pubId: <PUB_ID>,
pubKey: <NETWORK_CODE>,
host: <HOST_NAME>
pathName: <PATH_NAME>
}
});
});
```

Please visit [www.tercept.com](https://www.tercept.com/) for more information.
Please visit <https://www.tercept.com/> for more information.
44 changes: 29 additions & 15 deletions dev-docs/bidders/adliveplus.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Adlive Plus
description: Adlive Plus adapter
biddercode: adliveplus
aliasCode: lucead
tcfeu_supported: false
gvl_id: none
tcfeu_supported: true
gvl_id: 1309
usp_supported: false
coppa_supported: false
schain_supported: false
schain_supported: true
dchain_supported: false
media_types: banner
safeframes_ok: true
Expand All @@ -17,37 +17,51 @@ floors_supported: true
fpd_supported: true
pbjs: true
pbs: false
prebid_member: true/false
prebid_member: false
ortb_blocking_supported: false
privacy_sandbox: paapi
sidebarType: 1
---
### Note

The Adlive Plus adapter requires setup before beginning. Please contact us at [support@adlive.io](mailto:support@adlive.io).
This adapter requires setup before beginning. Please contact us at [support@adlive.io](mailto:support@adlive.io).

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|-----------------------|-----------|-----------|
| `placementId` | required | Placement id | `'11111'` | `string` |
| Name | Scope | Description | Example | Type |
|---------------|----------|---------------------------------|--------------------|-----------|
| `placementId` | required | Placement ID | `'1'` | `string` |
| `loader` | required | Site specific async loader code | `new Promise(...)` | `Promise` |
| `region` | optional | Endpoint region | `'ap'` | `string` |

### Test Parameters
### Params type definition

```typescript
type Params = {
placementId: string;
loader: Promise<any>;
region?: 'eu' | 'us' | 'ap';
};
```

### Test Params

```javascript
const adUnits = [
{
code: 'test-div',
sizes: [[300, 250]],
bids: [
{
code: 'test-div',
sizes: [[300, 250]],
bids: [
{
bidder: 'adliveplus',
params: {
placementId: '1',
placementId: '1', // required
loader: new Promise(/* ... */), // required
region: 'ap', // optional 'eu', 'us', 'ap'
}
}
]
}
];
];
```
7 changes: 5 additions & 2 deletions dev-docs/adzymic.md → dev-docs/bidders/adzymic.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ biddercode: adzymic
pbjs: true
pbs: false
aliasCode: appnexus
gdpr_supported: true
tcfeu_supported: true
usp_supported: false
coppa_supported: false
gpp_supported: false
media_types: banner, video, native
safeframes_ok: false
multiformat_supported: will-bid-on-any
gvl_id: 723
schain_supported: true
userId: all
userIds: all
sidebarType: 1
---
### Bid Params
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/algorix.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
layout: bidder
title: AlgoriX
description: Prebid AlgoriX Bidder Adapter
gvl_id: 1176
biddercode: algorix
tcfeu_supported: true
gvl_id:
usp_supported: true
coppa_supported: true
schain_supported: true
Expand All @@ -14,6 +14,7 @@ pbs: true
pbs_app_supported: true
prebid_member: true
sidebarType: 1
userIds: all
---

### Note
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/beachfront.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ For further information, please contact <adops@beachfront.com>.
| `playbackmethod` | optional | Playback method supported by the publisher.<br/>`1`: Auto-play sound on<br/>`2`: Auto-play sound off<br/>`3`: Click-to-play<br/>`4`: Mouse-over | `1` | `integer` |
| `maxduration` | optional | Maximum video ad duration in seconds. | `30` | `integer` |
| `placement` | optional | Placement type for the impression.<br/>`1`: In-Stream<br/>`2`: In-Banner<br/>`3`: In-Article<br/>`4`: In-Feed<br/>`5`: Interstitial/Slider/Floating | `1` | `integer` |
| `plcmt` | optional | Placement type for the impression. See [AdCOM v1 spec](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/develop/AdCOM%20v1.0%20FINAL.md#list_plcmtsubtypesvideo) | `1` | `integer` |
| `skip` | optional | Indicates if the player will allow the video to be skipped. | `1` | `integer` |
| `skipmin` | optional | Videos of total duration greater than this number of seconds can be skippable. | `15` | `integer` |
| `skipafter` | optional | Number of seconds a video must play before skipping is enabled. | `5` | `integer` |
Expand Down
Loading

0 comments on commit 9fab077

Please sign in to comment.