ex-rtb-house-v5

RTB House extractor for Keboola Connection.

Description

This is the documentation for a Keboola Connection extractor of reporting data from RTB House. The extractor was created using RTB House SDK. The extractor supports RTB House API version 5.

Configuration

• Start Date, End Date: Fixed dates in the format YYYY-MM-DD, dynamic number of days in the format -N where N is a non-negative integer, or the word today. For example, a configuration with "Start date": -7 and "End date": today will extract data one week to the past.
• Username, Password: Login credentials to RTB House web client.

  Table Configurations

• Name: Name of the table, without .CSV suffix. This will be the name of the table in Keboola Storage.
• Type: Should be one of the following: rtb_stats, summary_stats, billing.
• Dimensions: Name of dimensions separated by a comma. These columns, along with advertiserHash, will be set as primary key in Keboola. Available dimensions are the following: day, month, year, advertiser, subcampaign, userSegment, deviceType, creative, category, country.
• Metrics: Name of Metrics separated by a comma. Available metrics are the following: campaignCost, impsCount, ecpm, clicksCount, ecpc, ctr, conversionsCount, ecpa, cr, conversionsValue, roas, ecps, videoCompleteViews, ecpv, vcr, viewability, userFrequency, userReach.
• Count Convention: Should be one of the following or empty: ATTRIBUTED, ALL_POST_CLICK, POST_VIEW. Count convention is completely irrelevant for billing table type.
• Incremental: Set as ‘True’ if the data should be loaded to Keboola Storage incrementally.

Please note that not all combinations of metrics / dimensions / count conventions are possible. If the combination is not possible, the extractor fails with an error. The information about conflicts between specific columns is, regrettably, not available and needs to be discovered by trial-and-error or deeper understanding of the data.

See also: RTB House API documentation

Prepared by