This product is no longer being developed or maintained.

Configuring Open Bidder

Previous step

Before you can configure Open Bidder, you must have completed the previous step: Deploying the Open Bidder UI. This article also assumes that you have uploaded a bidder server as described in Creating your Bidder Server.

Open Bidder is configured using the online user interface which is broken down into the sections below.

Step 1: Create Project

Click Create a New Project in the Open Bidder home screen or click on Select a Project and then click Create New Project. The user interface will guide you through the steps necessary to create a new project.

You will need to enter the following information:

Project Name
Enter a name for the new project.
Project ID and Project Number
Found in the Overview section of the Google API Console.
Client ID and Client Secret
OAuth 2.0 client ID for web applications and Client secret, registered for Open Bidder can be found or created under the APIs & Services section of the Google API Console.
  1. Open the Google API Console Credentials page.
  2. From the project drop-down, select your project.
  3. Select Create credentials and choose OAuth client ID.
  4. Under Application type, select Web application, enter a Name and set the Restrictions (optional), then click Create.
  5. The OAuth client ID and secret appear.

Step 2: Authorize Open Bidder

The next step is to authorize your project. Your Open Bidder project will need OAuth 2.0 credentials in order to:

  • Retrieve reports from Authorized Buyers.
  • Start, stop, and query bidders on Google Compute Engine.

To authorize your project, click Authorize. Once authorization has been completed, you can revoke the authorization by clicking the Revoke Tokens button.

Step 3: Configure Authorized Buyers integration

To configure bidding for your project, you will need the following information:

Encryption Key and Decryption Key
These keys are necessary to decode winning prices from impressions, as well as hyperlocal and device ID information from bid requests.
Buyer Account
This is the Authorized Buyers account for registering running bidders to configure quota. Please ask your Authorized Buyers Technical Manager or see the Buyer API for more details.
Cookie Match URL
The cookie matching URL prefix. This value is tied to the buyer account selected above.

Once you have filled in the information, click Update Project and proceed to Step 4.

Step 4: Configuring bidders

VM Parameters
JDK VM parameters passed to the Open Bidder server. Typically used for JVM tuning, such as garbage collection parameters.
Main Parameters
Custom main parameters that are provided to your bidder server at start-up. These can be used to set properties of your bidder server or interceptors.
Additional Bidder OAuth 2.0 Scopes
A list of additional OAuth 2.0 scopes that will be used by your bidders to access other Google services.

Step 5: Configure interceptors

Cloud Storage URI
The URI where your custom distribution files are stored. You can use the command-line tool, gsutil, to upload your bidder server. See how to upload your bidder server to Google Cloud Storage.
Bidder Interceptors
This is a list of the fully-qualified path names of your bid interceptors. Enter each value on a separate line. These interceptors will be loaded by your bidder server and will respond to incoming BidRequests. To receive valid responses from your bidder server, you must set at least one interceptor for each type of request.
Impression Interceptors
A list of the fully-qualified path names of the impression tracking interceptors. Enter each value on a separate line. These interceptors will be loaded by your bidder server and will respond to incoming ImpressionRequests.
Click Interceptors
A list of the fully-qualified path names of the click tracking interceptors. Enter each value on a separate line. These interceptors will be loaded by your bidder server and will respond to incoming ClickRequests.
Pixel Matching Interceptors
A list of fully-qualified path names of the pixel-matching interceptors. Enter each value on a separate line. These interceptors will be loaded by your bidder server and will respond to incoming MatchRequests.

When you have finished filling in these values, click Update Project.

Network and Firewalls

Open Bidder leverages the Google Compute Engine network and firewall features for its basic security. The bidder's default configuration binds the following ports: 80 (http), 443 (https), and 9090 (http for status requests). You must create firewall rules to open these ports, see the Google Compute Engine documentation.

Bidder Management

Click on Bidding to add bidders. You will be presented with a list of Google Compute Engine zones. Start bidders by clicking on the zone for which you want to make allocations. When you click on the link, you will see information about the bidders for the zone, as well as information about the zone itself.

For more information about zones and available image types, see Regions & Zones and Images.

Zone Host Name
There should be an A record for each bidder's external IP address (or their load balancer), bound to the zone's host name. This host name will be the one registered with Authorized Buyers and will be used in the impression and click callbacks handled by the Open Bidder. Once the zone is registered, updating zone host is not allowed. Please unregister the zone before the update.
You need to register your bidding zone with Authorized Buyers to receive bid requests. Please set your Authorized Buyers account ID in the Edit Project page before you proceed.
Bid Protocol
You need to choose which RTB protocol will be used; Authorized Buyers supports both its native protocol and multiple versions of OpenRTB.
Maximum QPS
You need to set the maximum number of queries per second that Ad Exchange should send to each bidder URL for this account.
Once you have set the Maximum QPS, you can click the Register button to register your bidding zone with Authorized Buyers.
Shows a summary of existing bidders for the selected zone including the name, internal IP, external IP, machine type, and status of the bidder. Click on the name of the bidder to view more details.

To create a bidder:

  1. Select an instance type.
  2. Click Add Bidder. If you are deploying more complex interceptors, then you will want to select an instance type that has more CPUs allocated for it. The Status of the bidder will change to Provisioning, Staging, and finally, Running.

Managing users

Once you have selected or created a project, you can click Manage Users on the project menu to define who will have access to your project.

See Managing project access in the UI for more information about managing users for your Open Bidder project.

Next steps

You have just installed Open Bidder, configured both an interceptor and bidder server project, packaged and uploaded your bidder server, and deployed it to Google Compute Engine. From here on, you should now be able to create your own projects, although if you would like to learn more, we have additional topics covered in our guides.