Skip to content

Commit

Permalink
Merge branch 'master' into bigoad-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
BIGOAds committed Jul 5, 2024
2 parents e618dee + 4183fc2 commit 58073af
Show file tree
Hide file tree
Showing 166 changed files with 4,526 additions and 1,940 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ jobs:
name: run markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v41
- uses: tj-actions/changed-files@v44
id: changed-files
with:
files: '**/*.md'
separator: ","
- uses: DavidAnson/markdownlint-cli2-action@v15
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-files.outputs.any_changed == 'true'
with:
globs: "${{ steps.changed-files.outputs.all_changed_files }},!_includes"
Expand Down
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
source 'https://rubygems.org'
gem 'github-pages', '>= 228'

gem 'ffi', '1.16.3'
gem "webrick", "~> 1.7"
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
75 changes: 25 additions & 50 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 Expand Up @@ -1503,14 +1486,6 @@
sectionTitle:
subgroup: 3

- sbSecId: 5
title: Programmatic Guaranteed
link: /prebid-server/features/pg/pbs-pg-idx.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 3

- sbSecId: 5
title: Modules
link: /prebid-server/pbs-modules/
Expand Down Expand Up @@ -1818,7 +1793,7 @@
subgroup: 1

- sbSecId: 7
title: Prebid and MSPA
title: Prebid US Compliance
link: /features/mspa-usnat.html
isHeader: 0
isSectionHeader: 0
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)
21 changes: 19 additions & 2 deletions assets/js/download.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
// show all adapters
$(".adapters .col-md-4").show();
setPrepickedModules();

document.getElementById('download-button').addEventListener('click', function (event) {
event.preventDefault();
submit_download();
Expand Down Expand Up @@ -112,6 +112,23 @@
});
}

const renameModules = (function() {
const RENAMES = [
[
/^8\./,
{
tcfControl: 'gdprEnforcement',
consentManagementTcf: 'consentManagement',
paapiForGpt: 'fledgeForGpt'
}
]
];
return function(version, modules) {
const renames = RENAMES.find(([pat]) => pat.test(version))?.[1] || {};
return modules.map(mod => renames.hasOwnProperty(mod) ? renames[mod] : mod)
}
})();

function get_form_data() {
var modules = [];
var version = $(".selectpicker").val();
Expand All @@ -138,7 +155,7 @@
});

return {
modules,
modules: renameModules(version, modules),
version,
removedModules,
};
Expand Down
4 changes: 2 additions & 2 deletions dev-docs/activity-controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ For example, this rule would allow bidderX to perform the activity if no higher
Activity control rules in Prebid.js can be created by two main sources:

* Publisher `setConfig({allowActivities})` as in the examples shown here. When set this way, rules are considered the highest priority value of 1.
* Modules can set activity control rules, e.g. [usersync](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing), [bidderSettings](/dev-docs/publisher-api-reference/bidderSettings.html), the [GPP](/dev-docs/modules/consentManagementGpp.html) or [GDPR](/dev-docs/modules/gdprEnforcement.html) modules. Rules set by modules have a less urgent priority of 10.
* Modules can set activity control rules, e.g. [usersync](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing), [bidderSettings](/dev-docs/publisher-api-reference/bidderSettings.html), the [GPP](/dev-docs/modules/consentManagementGpp.html) or [GDPR](/dev-docs/modules/tcfControl.html) modules. Rules set by modules have a less urgent priority of 10.

When rules are processed, they are sorted by priority, and all rules of the same priority are considered to happen at the same time. The details:

Expand Down Expand Up @@ -234,7 +234,7 @@ If `allow` is not defined, the rule is assumed to assert **true** (i.e. allow th

#### Always include a particular bidder in auctions

This is similiar to the 'vendor exception' feature of the [GDPR Enforcement Module](/dev-docs/modules/gdprEnforcement.html). This would always allow bidderA to participate in the auction, even without explicit consent in GDPR scenarios. It might indicate, for instance, that this is a 'first party bidder'.
This is similiar to the 'vendor exception' feature of the [TCF Control Module](/dev-docs/modules/tcfControl.html). This would always allow bidderA to participate in the auction, even without explicit consent in GDPR scenarios. It might indicate, for instance, that this is a 'first party bidder'.

```javascript
pbjs.setConfig({
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/add-rtd-submodule.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ submodule('realTimeData', subModuleObject);

Several of the interfaces get a `userConsent` object. It's an object that carries these attributes:

* [gdpr](/dev-docs/modules/consentManagement.html#bidder-adapter-gdpr-integration) - GDPR
* [gdpr](/dev-docs/modules/consentManagementTcf.html#bidder-adapter-gdpr-integration) - GDPR
* [usp](/dev-docs/modules/consentManagementUsp.html#bidder-adapter-us-privacy-integration) - US Privacy (aka CCPA)
* [coppa](/dev-docs/publisher-api-reference/setConfig.html#setConfig-coppa) - the Child Online Privacy Protection Act

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: analytics
title: PrebidManager
description: PrebidManager Analytics Adapter
modulecode: prebidmanager
title: Asteriobid PBM
description: Asteriobid PBM Analytics Adapter
modulecode: asteriobidpbm
---

#### Registration
Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/eplanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: analytics
title: ePlanning
description: ePlanning Analytics Adapter
modulecode: eplanning
pbjs_version_notes: removed in 9.0
---

#### Registration
Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/growthcode.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Please visit [growthcode.io](https://growthcode.io/) for more information.

#### Analytics Options

{: .table .table-bordered .table-striped }
| Param enableAnalytics | Scope | Type | Description | Example |
|-----------------------|----------|--------|---------------------------------------------------------|--------------------------|
| provider | Required | String | The name of this Adapter. | `"growthCodeAnalytics"` |
Expand Down
10 changes: 0 additions & 10 deletions dev-docs/analytics/marsmedia.md

This file was deleted.

2 changes: 1 addition & 1 deletion dev-docs/analytics/sharethrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ gulp bundle --modules=gptPreAuction,sharethroughBidAdapter,sharethroughAnalytics
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
gulp bundle --modules=gptPreAuction,consentManagementTcf,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,tcfControl,sharethroughBidAdapter,sharethroughAnalyticsAdapter
```

Enable the Sharethrough Analytics Adapter in Prebid.js using the analytics provider `sharethrough` as seen in the **Example Configuration** section.
1 change: 1 addition & 0 deletions dev-docs/analytics/sigmoid.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: analytics
title: Sigmoid
description: Sigmoid Analytics Adapter
pbjs_version_notes: removed in 9.0
modulecode: sigmoid
---

Expand Down
16 changes: 16 additions & 0 deletions dev-docs/analytics/smartyads.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
layout: analytics
title: Smartyads
description: Smartyads Analytics Adapter
modulecode: smartyads
---

#### Example Configuration

```javascript
pbjs.que.push(function () {
pbjs.enableAnalytics({
provider: 'smartyads'
});
});
```
1 change: 1 addition & 0 deletions dev-docs/analytics/sonobi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: analytics
title: Sonobi
description: Sonobi Analytics Adapter
modulecode: sonobi
pbjs_version_notes: removed in 9.0
enable_download: false
---

Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/sovrn.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Sovrn
description: Sovrn Analytics Adapter
modulecode: sovrn
prebid_member: true
pbjs_version_notes: removed in 9.0
enable_download: false
---

Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/staq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: analytics
title: STAQ
description: STAQ Analytics Adapter
pbjs_version_notes: removed in 9.0
modulecode: staq
---

Expand Down
Loading

0 comments on commit 58073af

Please sign in to comment.