My favorites | English | Sign in

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.

The tables on this page display the following information about each column:

  • selectedColumns Value: The value you specify in selectedColumns to include this column in your report.
  • Name: The human-readable name of this column. (measure) indicates the value in the generated report is calculated using historical data (for example, CTR). (attribute) indicates the value in the generated report is not calculated (for example, Customer ID).
  • Response XML: The XML attribute in the generated report that represents this column.

Additional Notes

Account Structure reports are available only for non-MCC accounts.

Column Notes

  • 1 Column requires MCC account
  • dep Column is deprecated and may not be supported in the future

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 report job to have the following required and optional columns:

Required Columns

You must include these values in DefinedReportJob.selectedColumns:

selectedColumns Value Name Response XML
AdGroup Ad Group (attribute) adgroup

Optional Columns

You can also include these columns in selectedColumns:

selectedColumns Value Name Response XML
AdGroupId Ad Group Id (attribute) adgroupid
AdGroupMaxContentCpc Max Content CPC (attribute) adGroupMaxContentCpc
AdGroupMaxCpc Max CPC (attribute) adGroupMaxCpc
AdGroupMaxCpm Max CPM (attribute) adGroupMaxCpm
AdGroupSiteMaxCpc Site Max CPC (attribute) adGroupSiteMaxCpc
AdGroupStatus Ad Group Status (attribute) agStatus
AdGroupTargetCpa Max CPA (attribute) adGroupTargetCpa
Campaign Campaign (attribute) campaign
CampaignId Campaign Id (attribute) campaignid
CampaignStatus Campaign Status (attribute) campStatus
DailyBudget Daily Budget (attribute) budget

Back to Top

Campaign

Setting DefinedReportJob.aggregationTypes to Campaign causes the report job to have the following required and optional columns:

Required Columns

You must include these values in DefinedReportJob.selectedColumns:

selectedColumns Value Name Response XML
Campaign Campaign (attribute) campaign

Optional Columns

You can also include these columns in selectedColumns:

selectedColumns Value Name Response XML
CampaignId Campaign Id (attribute) campaignid
CampaignStatus Campaign Status (attribute) campStatus
DailyBudget Daily Budget (attribute) budget

Back to Top

Ad

Setting DefinedReportJob.aggregationTypes to Creative causes the report job to have the following required and optional columns:

Required Columns

You must include these values in DefinedReportJob.selectedColumns:

selectedColumns Value Name Response XML
CreativeId Ad Id (attribute) creativeid

Optional Columns

You can also include these columns in selectedColumns:

selectedColumns Value Name Response XML
AdGroup Ad Group (attribute) adgroup
AdGroupId Ad Group Id (attribute) adgroupid
AdGroupMaxContentCpc Max Content CPC (attribute) adGroupMaxContentCpc
AdGroupMaxCpc Max CPC (attribute) adGroupMaxCpc
AdGroupMaxCpm Max CPM (attribute) adGroupMaxCpm
AdGroupSiteMaxCpc Site Max CPC (attribute) adGroupSiteMaxCpc
AdGroupStatus Ad Group Status (attribute) agStatus
AdGroupTargetCpa Max CPA (attribute) adGroupTargetCpa
AdStatus Ad Status (attribute) creativeStatus
BusinessAddress Address (attribute) address
BusinessName Business Name (attribute) businessName
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
ImageAdName Ad Name (attribute) imgCreativeName
ImageHostingKey Image URL (attribute) hostingKey
PhoneNo Phone Number (attribute) phone
VisibleUrl Display URL (attribute) creativeVisUrl

Back to Top

Placement / Keyword

Setting DefinedReportJob.aggregationTypes to Keyword causes the report job to have the following required and optional columns:

Required Columns

You must include these values in DefinedReportJob.selectedColumns:

selectedColumns Value Name Response XML
Keyword Keyword (attribute) keyword

Optional Columns

You can also include these columns in selectedColumns:

selectedColumns Value Name Response XML
AdGroup Ad Group (attribute) adgroup
AdGroupId Ad Group Id (attribute) adgroupid
AdGroupMaxContentCpc Max Content CPC (attribute) adGroupMaxContentCpc
AdGroupMaxCpc Max CPC (attribute) adGroupMaxCpc
AdGroupMaxCpm Max CPM (attribute) adGroupMaxCpm
AdGroupSiteMaxCpc Site Max CPC (attribute) adGroupSiteMaxCpc
AdGroupStatus Ad Group Status (attribute) agStatus
AdGroupTargetCpa Max CPA (attribute) adGroupTargetCpa
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
KeywordIsNegative Keyword Is Negative (attribute) kwisnegative
KeywordMinCPCdep 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

Back to Top