Cmdlets for Google Ads

Build 24.0.9060

FeedItem

A feed item.

Columns

Name Type Behavior Description
AdGroupId Long SEGMENT Output only. The ID of the ad group.
CampaignId Long SEGMENT Output only. The ID of the campaign.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
FeedItemAttributeValues String ATTRIBUTE The feed item's attribute values.
FeedItemEndDateTime Datetime ATTRIBUTE End time in which this feed item is no longer effective and will stop serving. The time is in the customer's time zone. The format is 'YYYY-MM-DD HH:MM:SS'. Examples: '2018-03-05 09:15:00' or '2018-02-01 14:34:30'
FeedItemFeed String ATTRIBUTE Immutable. The feed to which this feed item belongs.
FeedItemGeoTargetingRestriction String ATTRIBUTE Geo targeting restriction specifies the type of location that can be used for targeting.

The allowed values are LOCATION_OF_PRESENCE, UNKNOWN, UNSPECIFIED.

FeedItemId Long ATTRIBUTE Output only. The ID of this feed item.
FeedItemPolicyInfos String ATTRIBUTE Output only. List of info about a feed item's validation and approval state for active feed mappings. There will be an entry in the list for each type of feed mapping associated with the feed, for example, a feed with a sitelink and a call feed mapping would cause every feed item associated with that feed to have an entry in this list for both sitelink and call. This field is read-only.
FeedItemResourceName String ATTRIBUTE Immutable. The resource name of the feed item. Feed item resource names have the form: customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}
FeedItemStartDateTime Datetime ATTRIBUTE Start time in which this feed item is effective and can begin serving. The time is in the customer's time zone. The format is 'YYYY-MM-DD HH:MM:SS'. Examples: '2018-03-05 09:15:00' or '2018-02-01 14:34:30'
FeedItemStatus String ATTRIBUTE Output only. Status of the feed item. This field is read-only.

The allowed values are ENABLED, REMOVED, UNKNOWN, UNSPECIFIED.

FeedItemUrlCustomParameters String ATTRIBUTE The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.
AbsoluteTopImpressionPercentage Double METRIC Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
AllConversions Double METRIC The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsValue Double METRIC The value of all conversions.
AverageCost Double METRIC The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
AverageCpe Double METRIC The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
AverageCpm Double METRIC Average cost-per-thousand impressions (CPM).
AverageCpv Double METRIC The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
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.
ConversionsFromInteractionsRate Double METRIC Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). 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.
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.
CrossDeviceConversions Double METRIC Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
Ctr Double METRIC The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
EngagementRate Double METRIC How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
Engagements Long METRIC The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes String METRIC The types of payable and free interactions.

The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.

InteractionRate Double METRIC How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions Long METRIC The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
TopImpressionPercentage Double METRIC The percent of your ad impressions that are shown adjacent to the top organic search results.
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.
VideoViewRate Double METRIC The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
VideoViews Long METRIC The number of times your video ads were viewed.
AdNetworkType String SEGMENT Ad network type.

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

ClickType String SEGMENT Click type.

The allowed values are AD_IMAGE, APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, UNKNOWN, UNSPECIFIED, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.

ConversionAction String SEGMENT Resource name of the conversion action.
ConversionActionCategory String SEGMENT Conversion action category.

The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED.

ConversionActionName String SEGMENT Conversion action name.
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.

Device String SEGMENT Device to which metrics apply.

The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED.

ExternalConversionSource String SEGMENT External conversion source.

The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS.

InteractionOnThisExtension Bool SEGMENT Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
Month Date SEGMENT Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear String SEGMENT Month of the year, for example, January.

The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED.

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.

PlaceholderType String SEGMENT Placeholder type. This is only used with feed item metrics.

The allowed values are AD_CUSTOMIZER, AFFILIATE_LOCATION, APP, CALL, CALLOUT, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHT, DYNAMIC_HOTEL, DYNAMIC_JOB, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, IMAGE, LOCATION, MESSAGE, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED.

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