Pubmatic

The Switchboard Pubmatic Connector provides automatic advertiser metrics from Pubmatic.

Prerequisites

To configure access to the Pubmatic Connector, you need:

  • Refresh token
  • Access token
  • Email address associated with tokens
  • Publisher ID

To obtain the above tokens and ID, contact your Pubmatic Account Manager. 

Scheduling

The Pubmatic Connector can be scheduled to ingest data once per day at a user-defined hour and timezone. By default, the connector will run once at 6am PT. See Daily Scheduling for more information.

Report Type

The following report type is available:

Publisher Report

Switchboard Script Syntax

import pubmatic from {
    type:"pubmatic:sync";
    key: "pubmatic_token";
    report_type: "publisher";
    publisher_id: "12345";
    timezone: "UTC";
    report_timezone: "America/New_York";
    dimensions: [
        "date",
        "tldId"
    ];
    metrics: [
        "revenue",
        "paidImpressions"
    ];
    filters: [
        "paidImpressions gt 0"
    ];
page_size: 512000;
} using {
    timestamp: datetime;
    startDate: datetime;
    tldId: string;
    revenue: float;
    paidImpressions: float;
    endDate: datetime;
    tldName: string;
};

Parameters

Parameter

Description

Required/Optional?

publisher_id

Access bulk data details for a specific publisher.

For Example: publisher_id: "12345";

For Parameter descriptions, see the PubMatic documentation.

Required

report_type

publisher

Required

page_size

Maximum number of rows to include in the response.

For Example: page_size: 512000;

For Parameter descriptions, see the PubMatic documentation.

Optional

filters

The filters query string parameter restricts the data returned from your request.

For Example: 

             filters: [
                 "paidImpressions gt 0"
                      ];

For Parameter descriptions, see the PubMatic documentation.

Optional

timezone

Set the timezone as part of the scheduling parameters as to when the report runs

For available Time Zone values, see the TimeZone Database List.

Optional

report_timezone

Generate reports within a specified timezone (the default timezone Pubmatic provides reporting in is UTC)

For available Time Zone values, see the TimeZone Database List.

Optional

dimensions

A list of requested dimensions.

For dimensions descriptions, see the PubMatic documentation.

At least one value is required.

metrics

A list of requested metrics.

For metrics descriptions, see the PubMatic documentation.

At least one value is required.