---
updatedAt: 2025-11-13T23:48:49.000Z
agentTools:
  projectIndex: https://docs.aps.appier.com/llms.txt
---

# Header Bidding (Prebid.js)

If you wish to understand what Header Bidding is please refer to this [link ](https://publishers-appier.readme.io/docs/getting-started)

## Appier Header Bidding Bidder for Prebid.org

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Version
      </th>

      <th style={{ textAlign: "left" }}>

      </th>

      <th style={{ textAlign: "left" }}>

      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        1.0
      </td>

      <td style={{ textAlign: "left" }}>
        Initial Version
      </td>

      <td style={{ textAlign: "left" }}>
        2019/7/18
      </td>
    </tr>
  </tbody>
</Table>

## About this Document

This guide illustrates the steps of integrating Appier Bidder through the Prebid.org framework.

Limitation:

* Currently we only support Banner.
* Currently we only support 1 size per ad unit.
* Currently we only support client-side Header Bidding.
* Currently we only support integration with DFP.

Note:

* This is **NOT** the business contract of Advertising with Appier.

## Contents

1. Appier Ad unit ID Information
2. Including Appier Bidder
3. Setting up Appier Bidder

## 1. Appier Ad unit ID Information

For each Ad unit there will be a name and an ID Number provided to you by Appier, example below:

* Ad unit Name: Name that corresponds to an ad unit in Appier's system.
* Ad unit ID: ID that corresponds to an ad unit in Appier's system.
* HZID: hashed value of **Ad unit ID**, hashed for security purposes.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Ad unit Name
      </th>

      <th>
        Ad unit ID
      </th>

      <th>
        HZID
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Example\_Ad\_unit
      </td>

      <td>
        ExampleAdUnitID
      </td>

      <td>
        ExampleHZID
      </td>
    </tr>
  </tbody>
</Table>

## 2. Including Appier Bidder

### **Methods (CHOOSE 1)**

1. Download from Prebid.org
2. Download from Github

### **1. Download from Prebid.org**

If you choose to download from Prebid.org, go to the [Prebid official website](http://prebid.org/download.html), choose your prebid version and the bidders that you want to include (remember to include your existing bidders!) along with **Appier bidder**, and click download

\~ Screenshot here \~

### **2. Download from Github**

Alternatively, you can also download the source code from Github and compile it yourself.\
Head over to the official Prebid [Github website](https://github.com/prebid/Prebid.js/releases), download the latest version, extract **Appier bidder (./modules/appierBidAdapter.js)** and recompile your js.

## 3. Setting up Appier Bidder

### **Steps**

1. Adding Appier Ad units to your Prebid config
2. Specifying Server location

### **1. Adding Appier Ad units to your Prebid config**

You will need 4 pieces of information:

* Your DFP Ad unit ID
* Your ad unit size
* Appier's bidder ID: 'appier'
* Appier's HZID: see Section I

```javascript prebidConfig.js
var adUnits = [{
	code: '${DFP ad unit ID}', // DFP ad unit id, e.g. '/5044416/300x250_appier_prebid'
	mediaTypes: {
	  banner: {
		sizes: [[300, 250]]  // currently we only support 1 size 
	  }
	},
	bids: [{
	  bidder: 'appier', // Appier's bidder ID
	  params: {
		hzid: '${HZID}' // appier hzid, must be string
	  }
	}]
  },
  ... // other ad units
  ];
```

### **2. Specifying Server location**

You will need to add the following code to the end of your **prebidConfig.js** file.\
Depending on your website location, please choose between the following server locations:

* tw: Taiwan, suitable for Taiwan, Hong Kong, Thailand, Malaysia, Indonesia
* jp: Japan, suitable for Japan, Korea

```javascript prebidConfig.js
pbjs.setConfig({appier: {'farm': 'tw'}});
```

### **DONE!!**

That's it! Happy Header Bidding!!