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

PBJS api page restructuring #2966

Merged
merged 24 commits into from
May 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
37a73dd
Adds icon to search box and back link to bidder pages. (#2746)
bookwyrm Mar 8, 2021
b4b23fa
DRAFT - User section (#2773)
bretg Mar 12, 2021
dc20053
Merge remote-tracking branch 'upstream/dev' into dev
bookwyrm Mar 19, 2021
a5bb0f9
Initial work to break API Methods out to individual pages
bookwyrm Mar 19, 2021
d80be8e
Add back links to match bidders
bookwyrm Mar 19, 2021
eb991af
Merge branch 'master' into dev
SSuranie Mar 29, 2021
11deb64
Merge remote-tracking branch 'origin/dev' into dev
SSuranie Mar 29, 2021
12e2010
Merge remote-tracking branch 'upstream/dev' into dev
bookwyrm Apr 5, 2021
4c19ae3
Merge branch 'dev' into api-reference-restructuring
bookwyrm Apr 5, 2021
99a009d
API reference restructuring (#2825)
bookwyrm Apr 8, 2021
a35d10d
Merge remote-tracking branch 'upstream/dev' into dev
bookwyrm Apr 26, 2021
935fbe1
Merge branch 'dev' into api-reference-restructuring
bookwyrm Apr 26, 2021
a2063d2
Update autocomplete styling and behavior name
bookwyrm Apr 26, 2021
b022e68
Incorporate latest updates for API Reference
bookwyrm May 5, 2021
269efa8
Fixed conflicts.
May 7, 2021
fe07c9a
sync with master
bretg May 10, 2021
c5adfd4
sync with master
bretg May 10, 2021
280c9f4
sync with master
bretg May 10, 2021
5db267c
Fixed broken links due to API doc refactor
May 10, 2021
dfbc789
minor update to setconfig
bretg May 11, 2021
606002c
link updates
jeanstemp May 14, 2021
500c019
Auto stash before merge of "pb-api-link-edits" and "origin/pb-api-lin…
May 17, 2021
dbf2c05
fixing dead links
bretg May 17, 2021
0d12a95
Merge branch 'master' into pb-api-link-edits
bretg May 17, 2021
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
12 changes: 12 additions & 0 deletions _assets/sass/components/_autocomplete-filter.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.pb-content {
.autocomplete-filter {
padding: 10px 15px;
border: 1px solid #b3c1cc;
background-color: rgba(236, 243, 245, 0.35);

&:focus {
outline: none;
}
}
}

10 changes: 0 additions & 10 deletions _assets/sass/components/_bidder-list.scss
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
.pb-content {
.bidder-filter {
padding: 10px 15px;
border: 1px solid #b3c1cc;
background-color: rgba(236, 243, 245, 0.35);

&:focus {
outline: none;
}
}

.c-bidder-list-group {
h4 {
color: #797f90;
Expand Down
1 change: 1 addition & 0 deletions _assets/sass/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
@import 'components/social-media';
@import 'components/table';
@import 'components/download-form';
@import 'components/autocomplete-filter';
@import 'components/bidder-list';
@import 'components/search';

Expand Down
6 changes: 3 additions & 3 deletions _includes/adops/adops-gam-video-setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h2 id="line-item-setup">Line Item Setup</h2>
<li>In the <b>New line item</b> dialog, choose "Video".</li>
<li>Select the appropriate Line Item Type, etc.</li>
<li>In the <b>Expected creatives</b> section, choose your video size, e.g., 640x480v.</li>
<li>Set the dates, rate, limit, and targeting as desired. For example, for <a href="/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids">SendAllBids</a> include targeting for "hb_bidder_rubicon=rubicon" as well as the hb_pb_rubicon targeting. This isn't needed if only creating one set of orders for all bidders.</li>
<li>Set the dates, rate, limit, and targeting as desired. For example, for <a href="/dev-docs/publisher-api-reference/setConfig.html#setConfig-Send-All-Bids">SendAllBids</a> include targeting for "hb_bidder_rubicon=rubicon" as well as the hb_pb_rubicon targeting. This isn't needed if only creating one set of orders for all bidders.</li>
<li>Remember to set the hb_pb=BUCKET targeting for each line item, or hb_pb_BIDDER=BUCKET if using separate line items for each bidder.</li>
<li>Save the line item.</li>
</ol>
Expand All @@ -43,7 +43,7 @@ <h2 id="creative-setup">Creative Setup</h2>
<ul>
<li>Create a separate line item for each bidder.</li>
<li>Include a creative for each cache service utilized by your implementation.</li>
<li>Use the <a href="/dev-docs/publisher-api-reference.html#setConfig-vast-cache">ignoreBidderCacheKey</a> option on setConfig({cache}).</li>
<li>Use the <a href="/dev-docs/publisher-api-reference/setConfig.html#setConfig-vast-cache">ignoreBidderCacheKey</a> option on setConfig({cache}).</li>
</ul>

<h3 id="creative-single-cache">Single Cache Location</h3>
Expand Down Expand Up @@ -86,7 +86,7 @@ <h3 id="creative-multiple-cache">Multiple Cache Locations</h3>
If you're utilizing any bidders that cache their own VAST, you have two options:

<ul>
<li>If you're using Prebid.js 4.28 or later, you can specify the <a href="/dev-docs/publisher-api-reference.html#setConfig-vast-cache">ignoreBidderCacheKey</a> option on setConfig({cache}). This will cause the browser to generate a VAST wrapper and cache it in your standard location. Then you can use the instructions
<li>If you're using Prebid.js 4.28 or later, you can specify the <a href="/dev-docs/publisher-api-reference/setConfig.html#setConfig-vast-cache">ignoreBidderCacheKey</a> option on setConfig({cache}). This will cause the browser to generate a VAST wrapper and cache it in your standard location. Then you can use the instructions
above for "Single Cache Location". The tradeoff is that this approach requires
the video player to unwrap one extra level of VAST.</li>
<li>Utilize creative-level targeting in the ad server. Keep reading for more details.</li>
Expand Down
19 changes: 0 additions & 19 deletions _includes/sandbox/pb-api-test.html

This file was deleted.

67 changes: 67 additions & 0 deletions _layouts/api_prebidjs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
{% include head.html %}

{% include nav.html %}


<div class="container pb-docs-container">

<div class="row ">

<div class="col-lg-3 sidebar" id="sidebar">

<div>
<button class="navbar-toggler d-lg-none" type="button" data-toggle="collapse" data-target="#sidebarContent" aria-controls="sidebarContent" aria-expanded="false" aria-label="Toggle Sidebar navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse d-lg-block" id="sidebarContent">
{% include left_nav.html %}
</div>
</div>

</div>

<div class="col-lg-9">
<div class="pb-content" markdown="1">

{% if page.is_full_screen %}
{{content}}
{% else %}

<div class="row">

<div class="col-md-12" role="main">
<div class="bs-docs-section">
<p><a href="/dev-docs/publisher-api-reference.html">Back to Publisher API Reference</a></p>

<h2>{{ page.title }}</h2>

{{content}}

<p><a href="/dev-docs/publisher-api-reference.html">Back to Publisher API Reference</a></p>
</div>

{% if page.show_disqus %}
{% include disqus_addon.html %}
{% endif %}
</div>

</div>

{% endif %}


</div>


</div>
</div>
<!--end row-->
</div>
{% if page.title != "Credits" %}
{% if page.layout != "home" %}
{% include footer.html %}
{% endif %}
{% endif %}

</body>
</html>
10 changes: 5 additions & 5 deletions _posts/2017-09-25-announcing-prebid-1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ As a **publisher**, you can look forward to the following when adopting Prebid.j

- Universal adunit type support for Native, Video and banner.
- Faster performance due to cutting out of additional JS libraries and simplified adapter code.
- Module integration support for things like [*multiple currency support*](/dev-docs/modules/currency.html), [*user syncing*](/dev-docs/publisher-api-reference.html#module_pbjs.userSync), [*simplified config APIs*](/dev-docs/publisher-api-reference.html#module_pbjs.setConfig).
- Module integration support for things like [*multiple currency support*](/dev-docs/modules/currency.html), [*user syncing*](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing), [*simplified config APIs*](/dev-docs/publisher-api-reference/setConfig.html).
- Better support for single page applications/sites (concurrency).
- Better size mapping and responsive site support.

**If you have a Demand Adapter that works with Prebid.js - we need your help to work with Prebid 1.0!**

- Once you update your adapter to work with the base adapter in 1.0 - you will be able to integrate with more ad formats easier such as Native and Video.
- Once you update your adapter to work with the base adapter in 1.0 - you will be able to integrate with more ad formats easier such as Native and Video.
- We have broken down the parts of what an adapter does into separate functions - this will make it easier to integrate and test your adapter.
- We have some additional requirements on what needs to be returned and what kind of endpoints are supporteed (only XHR). Please see the full [adapter guide](/dev-docs/bidder-adapter-1.html) for details.

Expand All @@ -37,7 +37,7 @@ We've released [Prebid 1.0!](https://github.com/prebid/Prebid.js/releases/tag/1.

## How to get involved

We **need** the community's help to successfully launch Prebid.js 1.0. We have been working hard to make sure that it will be as painless as possible to transition, while still being able to make some needed breaking changes.
We **need** the community's help to successfully launch Prebid.js 1.0. We have been working hard to make sure that it will be as painless as possible to transition, while still being able to make some needed breaking changes.

Please let us know your feedback and how we can make Prebid.js and the Prebid community even better!

Expand All @@ -46,6 +46,6 @@ Prebid 1.0 Documentation:
- [Prebid publisher guide](/dev-docs/publisher-api-reference.html)
- [Prebid adapter guide](/dev-docs/bidder-adaptor.html)

As always, we love PRs. Thanks for contributing.
As always, we love PRs. Thanks for contributing.

By [Matt Kendall](https://github.com/mkendall07), PMC Chair:Prebid.js & Engineering Manager, AppNexus.
By [Matt Kendall](https://github.com/mkendall07), PMC Chair:Prebid.js & Engineering Manager, AppNexus.
2 changes: 1 addition & 1 deletion adops/before-you-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Our recommendation is to start with $1 or 10 cent granularity until you're more

{% capture dfpNote %}

[Google Ad Manager has a limit](https://support.google.com/admanager/answer/1628457?hl=en#Trafficking) of 450 line items per order, which includes archived line items. If you are designing your own granularity setup, make sure you do not exceed that amount. Refer to our recommended pre-configured granularities in Prebid's API reference under the [Set Config Price Granularity instructions](/dev-docs/publisher-api-reference.html#setConfig-Price-Granularity).
[Google Ad Manager has a limit](https://support.google.com/admanager/answer/1628457?hl=en#Trafficking) of 450 line items per order, which includes archived line items. If you are designing your own granularity setup, make sure you do not exceed that amount. Refer to our recommended pre-configured granularities in Prebid's API reference under the [Set Config Price Granularity instructions](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Price-Granularity).
{% endcapture %}

{% include alerts/alert_note.html content= dfpNote %}
Expand Down
4 changes: 2 additions & 2 deletions adops/deals.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ hb_deal_appnexus = APN_456
We recommend confirming with your development team that the page is set up to send all deal targeting to the ad server. There are two ways to do this:
- Set the `enableSendAllBids` to **true**.
- Set `enableSendAllBids` to **false** and `alwaysIncludeDeals` to **true**. This option will minimize the number of targeting variables sent to the ad server.
See the [enableSendAllBids](/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids) documentation for details.
See the [enableSendAllBids](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Send-All-Bids) documentation for details.
{% endcapture %}

{% include alerts/alert_note.html content=noteAlert %}
Expand All @@ -57,7 +57,7 @@ See the [enableSendAllBids](/dev-docs/publisher-api-reference.html#setConfig-Sen

### Step 2: Create Key-values

For each header bidding partner you work with, create a keyword in the format of `hb_deal_BIDDERCODE`, e.g., `hb_deal_pubmatic`. For more examples of the keyword format, see the [API Reference for `pbjs.getAdserverTargeting`]({{site.github.url}}/dev-docs/publisher-api-reference.html#module_pbjs.getAdserverTargeting).
For each header bidding partner you work with, create a keyword in the format of `hb_deal_BIDDERCODE`, e.g., `hb_deal_pubmatic`. For more examples of the keyword format, see the [API Reference for `pbjs.getAdserverTargeting`](/dev-docs/publisher-api-reference/getAdserverTargeting.html).

<br>

Expand Down
4 changes: 2 additions & 2 deletions adops/send-all-bids-adops.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ As a publisher, you may want to have your ad server see **all** header bidding b
+ You have a contractual agreement with your header bidding partner.

{: .alert.alert-success :}
See the [Publisher API Reference]({{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids) for more details.
See the [Publisher API Reference](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Send-All-Bids) for more details.


If you decide to send all bids to the ad sever, your developers have the option of explicity adding `enableSendAllBids: true` to `pbjs.setConfig()`. However, since the default value is `true` this addition is not strictly necessary. For details, see the [Publisher API Reference]({{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids).
If you decide to send all bids to the ad sever, your developers have the option of explicity adding `enableSendAllBids: true` to `pbjs.setConfig()`. However, since the default value is `true` this addition is not strictly necessary. For details, see the [Publisher API Reference](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Send-All-Bids).

From the ad ops side, you can choose to set up one order per bidder, which allows for each order to have a set of line items using targeting keywords that include the bidder's name. For example, if you are working with [Rubicon](/dev-docs/bidders.html#rubicon), you would use `hb_pb_rubicon` in your line item's key-value targeting, and `hb_adid_rubicon` in the creative.

Expand Down
2 changes: 1 addition & 1 deletion adops/setting-up-prebid-ott-video-in-gam.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ The `Line Item` is now prepared for bidding on publisher’s inventory.


## Further Reading
[Video Solutions advertising overview:](
https://support.google.com/admanager/answer/1711021?hl=en)
[GAM Video Solutions advertising overview](https://support.google.com/admanager/answer/1711021?hl=en)
[Traffic in-stream video redirects](
https://support.google.com/dcm/answer/6286181?hl=en)
[Media Planner for in-stream video creatives. A best practice guide:](https://support.google.com/dcm/answer/4348108)
Expand Down
4 changes: 2 additions & 2 deletions adops/setting-up-prebid-video-in-freewheel.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sidebarType: 3

This page describes how to set up Campaigns for long form video using FreeWheel's ad server.

As with Google Ad Manager for digital ads, ad ops will need to configure their FreeWheel server account so that the server can provide the correct creatives for the video player. If you do not have an account visit [FreeWheel](https://www.FreeWheel.tv) to create one.
As with Google Ad Manager for digital ads, ad ops will need to configure their FreeWheel server account so that the server can provide the correct creatives for the video player. If you do not have an account visit [FreeWheel](https://www.freewheel.com/) to create one.

Once your account is set up log in to the FreeWheel site. You will be presented with a dashboard area. Click on either the Advertising button in the top navigation bar or the Campaign link in the main body.

Expand Down Expand Up @@ -54,7 +54,7 @@ The value is a concatenation of the CPM (12.00), the FreeWheel industry code (39

Once you have created a Placement it will appear in the first row of the Placement table.

In the last column of each row is a magnifying glass icon. Clicking on that will present detailed information about the Placement. In this detailed section information such as Delivery and Forecast, Schedule and Budget, Custom Targets, Exclusivity and Industry can be set for the Placement. The topics relevant to Prebid are covered in this section, for detailed information about all settings, visit FreeWheel.tv.
In the last column of each row is a magnifying glass icon. Clicking on that will present detailed information about the Placement. In this detailed section information such as Delivery and Forecast, Schedule and Budget, Custom Targets, Exclusivity and Industry can be set for the Placement. The topics relevant to Prebid are covered in this section, for detailed information about all settings, visit FreeWheel.com.

### Schedule and Budget

Expand Down
Loading