Cmdlets for Google Ads

Build 24.0.9060

CampaignAggregateAssetView

A campaign-level aggregate asset view that shows where the asset is linked, performamce of the asset and stats.

Columns

Name Type Behavior Description
CampaignAggregateAssetViewAsset String ATTRIBUTE Output only. The ID of the asset.
CampaignAggregateAssetViewAssetSource String ATTRIBUTE Output only. Source of the asset link.

The allowed values are ADVERTISER, AUTOMATICALLY_CREATED, UNKNOWN, UNSPECIFIED.

CampaignAggregateAssetViewCampaign String ATTRIBUTE Output only. Campaign in which the asset served.
CampaignAggregateAssetViewFieldType String ATTRIBUTE Output only. FieldType of the asset.

The allowed values are AD_IMAGE, BOOK_ON_GOOGLE, BUSINESS_LOGO, BUSINESS_NAME, CALL, CALLOUT, CALL_TO_ACTION_SELECTION, DEMAND_GEN_CAROUSEL_CARD, DESCRIPTION, HEADLINE, HOTEL_CALLOUT, HOTEL_PROPERTY, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MANDATORY_AD_TEXT, MARKETING_IMAGE, MEDIA_BUNDLE, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, VIDEO, YOUTUBE_VIDEO.

CampaignAggregateAssetViewResourceName String ATTRIBUTE Output only. The resource name of the campaign aggregate asset view. Campaign aggregate asset view resource names have the form: customers/{customer_id}/campaignAggregateAssetViews/{Campaign.campaign_id}~{Asset.asset_id}~{AssetLinkSource.asset_link_source}~{AssetFieldType.field_type}
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AssetBestPerformanceCostPercentage Double METRIC Percentage of cost the asset received in ads with AssetPerformanceLabel.BEST. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
AssetBestPerformanceImpressionPercentage Double METRIC Percentage of impressions the asset received in ads with AssetPerformanceLabel.BEST. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetGoodPerformanceCostPercentage Double METRIC Percentage of cost the asset received in ads with AssetPerformanceLabel.GOOD. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
AssetGoodPerformanceImpressionPercentage Double METRIC Percentage of impressions the asset received in ads with AssetPerformanceLabel.GOOD. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetLearningPerformanceCostPercentage Double METRIC Percentage of cost the asset received in ads with AssetPerformanceLabel.LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
AssetLearningPerformanceImpressionPercentage Double METRIC Percentage of impressions the asset received in ads with AssetPerformanceLabel.LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetLowPerformanceCostPercentage Double METRIC Percentage of cost the asset received in ads with AssetPerformanceLabel.LOW. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
AssetLowPerformanceImpressionPercentage Double METRIC Percentage of impressions the asset received in ads with AssetPerformanceLabel.LOW. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetPinnedAsDescriptionPositionOneCount Long METRIC Number of entities in which the asset is pinned to description 1. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetPinnedAsDescriptionPositionTwoCount Long METRIC Number of entities in which the asset is pinned to description 2. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetPinnedAsHeadlinePositionOneCount Long METRIC Number of entities in which the asset is pinned to headline 1. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetPinnedAsHeadlinePositionThreeCount Long METRIC Number of entities in which the asset is pinned to headline 3. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetPinnedAsHeadlinePositionTwoCount Long METRIC Number of entities in which the asset is pinned to headline 2. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetPinnedTotalCount Long METRIC Number of total usages in which the asset is pinned. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
AssetUnratedPerformanceCostPercentage Double METRIC Percentage of cost the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
AssetUnratedPerformanceImpressionPercentage Double METRIC Percentage of impressions the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
LinkedEntitiesCount Long METRIC Number of linked resources in which the asset is used. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
LinkedSampleEntities String METRIC A list of up to 20 sample linked resources in which the asset is used. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
SampleBestPerformanceEntities String METRIC A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
SampleGoodPerformanceEntities String METRIC A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
SampleLearningPerformanceEntities String METRIC A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
SampleLowPerformanceEntities String METRIC A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
SampleUnratedPerformanceEntities String METRIC A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
Date Date SEGMENT Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
DayOfWeek String SEGMENT Day of the week, for example, MONDAY.

The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY.

Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Period String SEGMENT Predefined date range.

The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN.

Quarter Date SEGMENT Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
Week Date SEGMENT Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year Int SEGMENT Year, formatted as yyyy.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ManagerId Long Id of the manager account on behalf of which you are requesting customer data.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060