Structure Report
An Account Structure report lets you view attribute data from your
account. This report type provides a convenient way for you retrieve
all data unrelated to performance in one report.
Set
DefinedReportJob.selectedReportType
to Structure to generate
a Structure report. The valid aggregation
types for this type of report are listed below.
For general information on creating valid ReportJob
objects, read the Report Rules.
The tables on this page display the following information about each column:
-
Field Value - the value you specify in
selectedColumns to
include this column in your report.
-
* - Column requires MCC account
-
Name - the human-readable name of this column. This column's value in the generated report is either a measure or an attribute:
-
Measure - the value is calculated using historical data. For example, CTR is a measure.
-
Attribute - the value is immediately retrievable. For example, Customer Id is an attribute.
-
Response XML - the XML attribute in the generated report that represents this column.
Note: Account Structure reports are currently only supported
for individual advertisers and not MCCs.
Valid aggregationTypes Values
Choose an aggregationTypes value--a set of one or more aggregation types--to see the corresponding
list of required and optional columns.
Ad Group
Setting DefinedReportJob.aggregationTypes to
["AdGroup"] causes the ReportJob object to have the following required and optional columns:
Required Columns
You must specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| AdGroup |
Ad Group (attribute)
|
adgroup |
Optional Columns
You can also specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| AdGroupId |
Ad Group Id (attribute)
|
adgroupid |
| AdGroupStatus |
Ad Group Status (attribute)
|
agStatus |
| Campaign |
Campaign (attribute)
|
campaign |
| CampaignId |
Campaign Id (attribute)
|
campaignid |
| CampaignStatus |
Campaign Status (attribute)
|
campStatus |
| DailyBudget |
Daily Budget (attribute)
|
budget |
Campaign
Setting DefinedReportJob.aggregationTypes to
["Campaign"] causes the ReportJob object to have the following required and optional columns:
Required Columns
You must specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| Campaign |
Campaign (attribute)
|
campaign |
Optional Columns
You can also specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| CampaignId |
Campaign Id (attribute)
|
campaignid |
| CampaignStatus |
Campaign Status (attribute)
|
campStatus |
| DailyBudget |
Daily Budget (attribute)
|
budget |
Ad
Setting DefinedReportJob.aggregationTypes to
["Creative"] causes the ReportJob object to have the following required and optional columns:
Required Columns
You must specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| CreativeId |
Ad Id (attribute)
|
creativeid |
Optional Columns
You can also specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| AdGroup |
Ad Group (attribute)
|
adgroup |
| AdGroupId |
Ad Group Id (attribute)
|
adgroupid |
| AdGroupStatus |
Ad Group Status (attribute)
|
agStatus |
| AdStatus |
Ad Status (attribute)
|
creativeStatus |
| Campaign |
Campaign (attribute)
|
campaign |
| CampaignId |
Campaign Id (attribute)
|
campaignid |
| CampaignStatus |
Campaign Status (attribute)
|
campStatus |
| CreativeDestUrl |
Destination URL (attribute)
|
creativeDestUrl |
| CreativeType |
Ad Variation (attribute)
|
creativeType |
| DailyBudget |
Daily Budget (attribute)
|
budget |
| DescriptionLine1 |
Headline (attribute)
|
headline |
| DescriptionLine2 |
Description Line 1 (attribute)
|
desc1 |
| DescriptionLine3 |
Description Line 2 (attribute)
|
desc2 |
| VisibleUrl |
Display URL (attribute)
|
creativeVisUrl |
Keyword
Setting DefinedReportJob.aggregationTypes to
["Keyword"] causes the ReportJob object to have the following required and optional columns:
Required Columns
You must specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| Keyword |
Keyword (attribute)
|
keyword |
Optional Columns
You can also specify these values in DefinedReportJob.selectedColumns:
| Field Value |
Name |
Response XML |
| AdGroup |
Ad Group (attribute)
|
adgroup |
| AdGroupId |
Ad Group Id (attribute)
|
adgroupid |
| AdGroupStatus |
Ad Group Status (attribute)
|
agStatus |
| BottomPosition |
Lowest Position Preference (attribute)
|
bottomPosition |
| Campaign |
Campaign (attribute)
|
campaign |
| CampaignId |
Campaign Id (attribute)
|
campaignid |
| CampaignStatus |
Campaign Status (attribute)
|
campStatus |
| DailyBudget |
Daily Budget (attribute)
|
budget |
| KeywordDestUrlDisplay |
Keyword Destination URL (attribute)
|
kwDestUrl |
| KeywordId |
Keyword Id (attribute)
|
keywordid |
| KeywordMinCPC |
Keyword Min CPC (attribute)
|
keywordMinCpc |
| KeywordStatus |
Keyword Status (attribute)
|
kwStatus |
| KeywordTypeDisplay |
Keyword Type (attribute)
|
kwType |
| MaxContentCPC |
Content Bid (attribute)
|
maxContentCpc |
| MaximumCPC |
Current Maximum CPC (attribute)
|
maxCpc |
| MaximumCPM |
Current Maximum CPM (attribute)
|
maxCpm |
| TopPosition |
Highest Position Preference (attribute)
|
topPosition |
API Reference
