Camphouse: Setup guide

On this page

This guide explains how to collect data from Camphouse.

Introduction

Camphouse is a media planning platform where advertisers and their agencies build media plans before any media is bought. Each plan lists line items for an outlet, media type, flight, and budget. Connecting Camphouse to Adverity lets you compare these planned figures against what platforms actually delivered.

Camphouse accounts are organized in two levels: a corporate group, and one or more markets beneath it. The group owns configuration that its markets share, such as media types, vehicles, tags, and tag categories. Each market owns its own operational data, such as media entries and campaigns. Keep this hierarchy in mind when you select Organizations in the datastream configuration, as described below.

Limitations

Collecting data from Camphouse comes with the following limitations:

The Media entries report type returns a wide, sparse table. Because each media type defines its own set of fields, only a core set of columns is populated for every row. The remaining columns only contain values for media entries of the matching media type.
Only the Media entries report type supports filtering by media type or campaign. The other report types return all available data for the selected organizations, optionally filtered by date.

Prerequisites

Before you start collecting data from Camphouse, perform all of the following actions:

Ensure you have access to the Camphouse organization, or organizations, you want to connect to Adverity.

Creating a datastream to collect data from Camphouse

The basics of creating a datastream to collect data from any data source are explained in our guide to Collecting data in Adverity. This guide contains information about the specific steps to create a datastream to fetch data from Camphouse.

Authorization: Allow Adverity to access Camphouse

Before creating an authorization to give Adverity access to Camphouse, perform the following actions:

Contact Camphouse support at api@camphouse.io to request a persistent token.

Important
Tokens generated through the Camphouse login flow expire and are not valid for this authorization. You must request a persistent token from Camphouse support.
(Optional) If Camphouse assigned your organization a dedicated API domain, obtain this domain from Camphouse support.

To set up a new authorization to fetch data from Camphouse, follow these steps:

In the Authorization step of the datastream wizard, click Access Camphouse using your credentials.
Click Next.
In Secret, enter your Camphouse persistent token.
(Optional) In Domain, enter the dedicated Camphouse domain assigned to your organization, for example unilever.camphouse.io. If you leave this field blank, Adverity connects to the standard Camphouse domain.
Click Authorize.
If you choose Access using your credentials or Access using someone else’s credentials, in Set up or edit Organizations, you or the person granting access must choose one of the following options:
- Choose Grant access to all items, including those created in the future to give Adverity permission to access all existing organizations and all organizations created in the future.
- Choose Select specific items to which you want to grant access to only give Adverity permission to access the selected organizations. Adverity will not automatically have access to organizations created in the future. You will need to grant Adverity access to any organizations created in the future.
Warning
If you use your credentials to grant Adverity access to Camphouse, all the organizations available to you using your credentials will be visible in the Authorizations page to all Adverity users with permission to edit this authorization.
If someone else uses their credentials to grant Adverity access to Camphouse, the same applies to the organizations available using their credentials.
This is important to consider if you do not want all Adverity users with permission to edit the authorization to be able to see the details of the authorization items. For more information about user permissions, see Managing user permissions.

As a result, Adverity has access to Camphouse using the organizations you granted.

Configuration: Choose the data you want to collect from Camphouse

To choose what data to collect and customize the Camphouse datastream configuration, follow these steps:

(Optional) Rename your datastream.
In Organizations, select the organizations for which to collect data. For each field, you can choose to include or exclude specific organizations, or select all organizations.
Important
Select the organization level that matches the report type you want to collect:
- For the Media entries and Campaigns report types, select a market.
- For the Media types, Vehicles, Tags, and Tag categories report types, select the corporate group. These report types do not return data for a market.
In Report type, select the type of data to collect from Camphouse. The selected report type determines the additional fields to populate. The default is Media entries.
For the Media entries report type, fill in the following fields:
1. (Optional) In Media types, select the media types for which to collect data. If you leave this field blank, Adverity collects data for all media types.
2. (Optional) In Campaigns, select the campaigns for which to collect data. Campaigns are listed with the most recently created first. If you leave this field blank, Adverity collects data for all campaigns.
For the Media types and Vehicles report types, in Date filter, select whether to filter data by Created at or Edited at. The default is Created at.

As a result, your Camphouse datastream is created.

What’s next?

Apply Data Mapping to your collected data to harmonize data collected from different sources in Adverity.
Transform your data to meet your needs by creating and applying transformations to your datastream.
Load your data into a warehouse to continue working with your data in Adverity.
Load your data into an external destination of your choice.

Advanced Camphouse tips

Date columns

Camphouse returns createdAt and editedAt timestamps in milliseconds. Adverity adds createdAtDate and editedAtDate columns that trim these timestamps to a YYYY-MM-DD date.

For the Media entries and Campaigns report types, Adverity uses startDate as the key date. For the Media types, Vehicles, Tags, and Tag categories report types, Adverity uses whichever field you selected in Date filter, createdAtDate or editedAtDate, as the key date.

Nested fields

For the Campaigns report type, Adverity unnests the entryApprovalFlows and tags fields into separate columns.