Google Ad Manager Reports

The Switchboard Google Ad Manager Report connector allows for ingestion of Google Ad Manager and AdExchange (AdX) Historical reporting.

Prerequisites

To configure access to the Google Ad Manager Report connector, you need:

  • Google Service Account credential or a Google User credential
  • Google Ad Manager Network ID

To retrieve the Google Ad Manager Network ID:

  • Navigate to the top left-hand corner of the Google Ad Manager UI. 
  • View the Google Ad Manager Network ID.

NOTES

  • The Google Service Account credential or Google User credential role must have the Create and view reports permission activated. 
  • Activate the Create and view Ad Exchange reports permissions to access AdX historical reports. 

Scheduling

The Google Ad Manager Report connector can be scheduled to run at regular intervals, or at specific hours of the day.

By default, the connector will run once a day at 6am PT.

See Hourly Scheduling for more information.

Parameters

Parameter

Description

Required/Optional?

network

The Google Ad Manager network id.

For Example: network: "12345";

Required

dimensions

A list of requested dimensions.

For dimension descriptions, see ReportQuery Reference Documentation.

Required

columns

A list of requested columns.

For column descriptions, see ReportQuery Reference Documentation.

Required

custom_field_ids

A list of requested custom_field_ids.

For custom_field_ids descriptions, see ReportQuery Reference Documentation.

Optional

filter

A list of fields to filter on.

For Example: filter: "PROGRAMMATIC_CHANNEL_NAME = 'Preferred Deals'";

Optional

adx_report_currency

The currency for Ad Exchange revenue metrics.

For more information on adxReportCurrency, see the ReportQuery Reference Documentation

Optional

timezone_type

Determines the time zone used for the report's date range.

For timezone_type descriptions, see ReportQuery Reference Documentation

At least one value is required

date_range_type

The period for which the reporting data is being generated.

A list of requested date_range_type:

  • TODAY
  • YESTERDAY
  • NEXT_90_DAYS
  • NEXT_12_MONTHS
Note that the report is changed to immediate/snapshot when "TODAY" is used.

At least one value is required

api_version

The version of the API. 

For API version options see the Release Notes.

At least one value is required

attributes

The list of break-down attributes being requested in the report.

For DimensionAttributes descriptions, see ReportQuery Reference Documentation.

At least one value is required

Switchboard Script Syntax

import gam_report from {
   type: "gam:report";
   key: "google_credential";
   network: "12345";
   api_version: "v202008";
   timezone_type: "PUBLISHER";
   dimensions: [
       "DATE",
       "ORDER_ID",
       "ORDER_NAME",
       "AD_UNIT_ID",
       "AD_UNIT_NAME",
       "COUNTRY_CRITERIA_ID",
       "COUNTRY_NAME",
       "CREATIVE_SIZE_DELIVERED",
       "DEVICE_CATEGORY_ID",
       "DEVICE_CATEGORY_NAME"
   ];
   attributes: [];
   columns: [
       "AD_SERVER_CLICKS",
       "AD_SERVER_IMPRESSIONS"
   ];
   } using {
       date: datetime;
       order_id: integer;
       order_name: string;
       ad_unit_id: integer;
       ad_units: string;
       country_criteria_id: integer;
       country: string;
       creative_size_delivered: string;
       device_category_id: integer;
       device_category_name: string;
       total_ad_server_clicks: integer;
       total_ad_server_impressions: integer;
   };