EndPoint Get Report: Campaign Performance (By Year and Month)

Name

get_report_campaign_performance_by_month

Description

Get campaign performance data by year and month. If you like to customize this report then use get_query_result endpoint.

Parameters

Parameter

Label

Required

Options

Description

ReportStartDate

Report Start Date (yyyy-MM-dd)

YES

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31

Server side filter for date

ReportEndDate

Report End Date (yyyy-MM-dd)

YES

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31

Server side filter for date

CampaignId

Campaign Id (Default: All)

Server side filter for campaign

CampaignStatus

Campaign Status (Default: All)

Option	Value
ENABLED	ENABLED
PAUSED	PAUSED
REMOVED	REMOVED
DRAFT	DRAFT
PENDING	PENDING
ARCHIVED	ARCHIVED

CustomerId

CustomerId (without dash e.g. 2125557752)

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Year	`DT_I4`	`int`		`False`
Month	`DT_I4`	`int`		`False`
Quarter	`DT_WSTR`	`nvarchar(10)`	10	`False`
CampaignId	`DT_WSTR`	`nvarchar(30)`	30	`False`
CampaignName	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
Clicks	`DT_R8`	`float`		`False`
Conversions	`DT_R8`	`float`		`False`
Cost	`DT_R8`	`float`		`False`
CostMicros	`DT_I8`	`bigint`		`False`
CostPerConversion	`DT_R8`	`float`		`False`
CostPerConversionMicros	`DT_I8`	`bigint`		`False`
Impressions	`DT_I8`	`bigint`		`False`
InteractionRate	`DT_R8`	`float`		`False`
Interactions	`DT_I8`	`bigint`		`False`
AveragePageViews	`DT_R8`	`float`		`False`
BounceRate	`DT_R8`	`float`		`False`
SearchAbsoluteTopImpressionShare	`DT_R8`	`float`		`False`
SearchBudgetLostAbsoluteTopImpressionShare	`DT_R8`	`float`		`False`
SearchBudgetLostImpressionShare	`DT_R8`	`float`		`False`
SearchBudgetLostTopImpressionShare	`DT_R8`	`float`		`False`
SearchClickShare	`DT_R8`	`float`		`False`
SearchExactMatchImpressionShare	`DT_R8`	`float`		`False`
SearchImpressionShare	`DT_R8`	`float`		`False`
SearchRankLostAbsoluteTopImpressionShare	`DT_R8`	`float`		`False`
SearchRankLostImpressionShare	`DT_R8`	`float`		`False`
SearchRankLostTopImpressionShare	`DT_R8`	`float`		`False`
SearchTopImpressionShare	`DT_R8`	`float`		`False`
TopImpressionPercentage	`DT_R8`	`float`		`False`
VideoViews	`DT_I8`	`bigint`		`False`
ViewThroughConversions	`DT_I8`	`bigint`		`False`
Ctr	`DT_R8`	`float`		`False`
Engagements	`DT_I8`	`bigint`		`False`
AbsoluteTopImpressionPercentage	`DT_R8`	`float`		`False`
ActiveViewImpressions	`DT_I8`	`bigint`		`False`
AllConversions	`DT_R8`	`float`		`False`
AverageCost	`DT_R8`	`float`		`False`
AverageCostMicro	`DT_R8`	`float`		`False`
AverageCpc	`DT_R8`	`float`		`False`
AverageCpcMicro	`DT_R8`	`float`		`False`
AverageCpm	`DT_R8`	`float`		`False`
AverageCpmMicro	`DT_R8`	`float`		`False`
AverageCpv	`DT_R8`	`float`		`False`
AverageCpvMicro	`DT_R8`	`float`		`False`
AverageCpe	`DT_R8`	`float`		`False`
AverageCpeMicro	`DT_R8`	`float`		`False`
InvalidClicks	`DT_I8`	`bigint`		`False`
CostPerAllConversions	`DT_R8`	`float`		`False`
CostPerAllConversionsMicro	`DT_I8`	`bigint`		`False`
ContentImpressionShare	`DT_R8`	`float`		`False`
ContentBudgetLostImpressionShare	`DT_R8`	`float`		`False`
EngagementRate	`DT_R8`	`float`		`False`
VideoviewRate	`DT_R8`	`float`		`False`
VideoQuartileP75Rate	`DT_R8`	`float`		`False`
VideoQuartileP50Rate	`DT_R8`	`float`		`False`
VideoQuartileP25Rate	`DT_R8`	`float`		`False`
VideoQuartileP100rate	`DT_R8`	`float`		`False`
ActiveViewCpm	`DT_R8`	`float`		`False`
ActiveViewCpmMicro	`DT_R8`	`float`		`False`
ActiveViewCtr	`DT_R8`	`float`		`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Google Ads Connector in API Source component to read data or in API Destination component to read/write data:

Get Report: Campaign Performance (By Year and Month) using API Source

Google Ads

Get Report: Campaign Performance (By Year and Month)

SSIS API Source - Read from table or endpoint

Get Report: Campaign Performance (By Year and Month) using API Destination

Google Ads

Get Report: Campaign Performance (By Year and Month)

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get campaign performance report by month

Get campaign performance data, group by year, month and campaign

SELECT * FROM get_report_campaign_performance_by_month WITH(ReportStartDate='monthstart', ReportEndDate='today-1d')

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get campaign performance report by month

Get campaign performance data, group by year, month and campaign

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_report_campaign_performance_by_month WITH(ReportStartDate=''monthstart'', ReportEndDate=''today-1d'')';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY];