Cmdlets for Google Ads

Build 24.0.9060

AdGroupAdAssetView

A link between an AdGroupAd and an Asset. Currently we only support AdGroupAdAssetView for AppAds and Responsive Search Ads.

Table Specific Information

Select

Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.

To use the nondefault fields, explicitly select them in your query.

Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.

Columns

Name Type Behavior Description
AdGroupAdAssetViewAdGroupAd String ATTRIBUTE Output only. The ad group ad to which the asset is linked.
AdGroupAdAssetViewAsset String ATTRIBUTE Output only. The asset which is linked to the ad group ad.
AdGroupAdAssetViewEnabled Bool ATTRIBUTE Output only. The status between the asset and the latest version of the ad. If true, the asset is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
AdGroupAdAssetViewFieldType String ATTRIBUTE Output only. Role that the asset takes in the ad.

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.

AdGroupAdAssetViewPerformanceLabel String ATTRIBUTE Output only. Performance of an asset linkage.

The allowed values are BEST, GOOD, LEARNING, LOW, PENDING, UNKNOWN, UNSPECIFIED.

AdGroupAdAssetViewPinnedField String ATTRIBUTE Output only. Pinned field.

The allowed values are AD_IMAGE, BUSINESS_LOGO, BUSINESS_NAME, BUSINESS_NAME_IN_PORTRAIT, CALL, CALLOUT, CALL_TO_ACTION, DESCRIPTION, DESCRIPTION_1, DESCRIPTION_2, DESCRIPTION_IN_PORTRAIT, HEADLINE, HEADLINE_1, HEADLINE_2, HEADLINE_3, HEADLINE_IN_PORTRAIT, LANDSCAPE_LOGO, LEAD_FORM, LOGO, LONG_HEADLINE, MARKETING_IMAGE, MARKETING_IMAGE_IN_PORTRAIT, MOBILE_APP, PORTRAIT_MARKETING_IMAGE, PRICE, PROMOTION, SITELINK, SQUARE_MARKETING_IMAGE, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED, YOU_TUBE_VIDEO.

AdGroupAdAssetViewPolicySummary String ATTRIBUTE Output only. Policy information for the ad group ad asset.
AdGroupAdAssetViewResourceName String ATTRIBUTE Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4): customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type} Ad group ad asset view resource names have the form (Beginning from V4): customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}
AdGroupAdAssetViewSource String ATTRIBUTE Output only. Source of the ad group ad asset.

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

CustomerId Long ATTRIBUTE Output only. The ID of the customer.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsValue Double METRIC The value of all conversions.
AllConversionsValuePerCost Double METRIC The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
BiddableAppInstallConversions Double METRIC Number of app installs.
BiddableAppPostInstallConversions Double METRIC Number of in-app actions.
Clicks Long METRIC The number of clicks.
Conversions Double METRIC The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue Double METRIC The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValuePerCost Double METRIC The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros Long METRIC The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerAllConversions Double METRIC The cost of ad interactions divided by all conversions.
CostPerConversion Double METRIC The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
ValuePerAllConversions Double METRIC The value of all conversions divided by the number of all conversions.
ValuePerConversion Double METRIC The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ViewThroughConversions Long METRIC The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
AdFormatType String SEGMENT Ad Format type.

The allowed values are AUDIO, BUMPER, INFEED, INSTREAM_NON_SKIPPABLE, INSTREAM_SKIPPABLE, MASTHEAD, OTHER, OUTSTREAM, SHORTS, UNKNOWN, UNSEGMENTED, UNSPECIFIED.

AdNetworkType String SEGMENT Ad network type.

The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE.

ConversionAction String SEGMENT Resource name of the conversion action.
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.
Slot String SEGMENT Position of the ad.

The allowed values are CONTENT, MIXED, SEARCH_OTHER, SEARCH_PARTNER_OTHER, SEARCH_PARTNER_TOP, SEARCH_SIDE, SEARCH_TOP, UNKNOWN, UNSPECIFIED.

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