Cmdlets for Google Ads

Build 24.0.9060

ExtensionFeedItem

An extension feed item.

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
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.
ExtensionFeedItemAdSchedules String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the feed item may serve. There can be a maximum of 6 schedules per day.
ExtensionFeedItemAffiliateLocationFeedItemAddressLine1 String ATTRIBUTE Line 1 of the business address.
ExtensionFeedItemAffiliateLocationFeedItemAddressLine2 String ATTRIBUTE Line 2 of the business address.
ExtensionFeedItemAffiliateLocationFeedItemBusinessName String ATTRIBUTE The name of the business.
ExtensionFeedItemAffiliateLocationFeedItemChainId Long ATTRIBUTE Id of the retail chain that is advertised as a seller of your product.
ExtensionFeedItemAffiliateLocationFeedItemChainName String ATTRIBUTE Name of chain.
ExtensionFeedItemAffiliateLocationFeedItemCity String ATTRIBUTE City of the business address.
ExtensionFeedItemAffiliateLocationFeedItemCountryCode String ATTRIBUTE Country code of the business address.
ExtensionFeedItemAffiliateLocationFeedItemPhoneNumber String ATTRIBUTE Phone number of the business.
ExtensionFeedItemAffiliateLocationFeedItemPostalCode String ATTRIBUTE Postal code of the business address.
ExtensionFeedItemAffiliateLocationFeedItemProvince String ATTRIBUTE Province of the business address.
ExtensionFeedItemAppFeedItemAppId String ATTRIBUTE The store-specific ID for the target application. This string must not be empty.
ExtensionFeedItemAppFeedItemAppStore String ATTRIBUTE The application store that the target application belongs to. This field is required.

The allowed values are APPLE_ITUNES, GOOGLE_PLAY, UNKNOWN, UNSPECIFIED.

ExtensionFeedItemAppFeedItemFinalMobileUrls String ATTRIBUTE A list of possible final mobile URLs after all cross domain redirects.
ExtensionFeedItemAppFeedItemFinalUrlSuffix String ATTRIBUTE URL template for appending params to landing page URLs served with parallel tracking.
ExtensionFeedItemAppFeedItemFinalUrls String ATTRIBUTE A list of possible final URLs after all cross domain redirects. This list must not be empty.
ExtensionFeedItemAppFeedItemLinkText String ATTRIBUTE The visible text displayed when the link is rendered in an ad. This string must not be empty, and the length of this string should be between 1 and 25, inclusive.
ExtensionFeedItemAppFeedItemTrackingUrlTemplate String ATTRIBUTE URL template for constructing a tracking URL. Default value is '{lpurl}'.
ExtensionFeedItemCallFeedItemCallConversionAction String ATTRIBUTE The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracking_enabled is set to true. Otherwise this field is ignored.
ExtensionFeedItemCallFeedItemCallConversionReportingState String ATTRIBUTE Enum value that indicates whether this call extension uses its own call conversion setting (or just have call conversion disabled), or following the account level setting.

The allowed values are DISABLED, UNKNOWN, UNSPECIFIED, USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION, USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.

ExtensionFeedItemCallFeedItemCallConversionTrackingDisabled Bool ATTRIBUTE If true, disable call conversion tracking. call_conversion_action should not be set if this is true. Optional.
ExtensionFeedItemCallFeedItemCallTrackingEnabled Bool ATTRIBUTE Indicates whether call tracking is enabled. By default, call tracking is not enabled.
ExtensionFeedItemCallFeedItemCountryCode String ATTRIBUTE Uppercase two-letter country code of the advertiser's phone number. This string must not be empty.
ExtensionFeedItemCallFeedItemPhoneNumber String ATTRIBUTE The advertiser's phone number to append to the ad. This string must not be empty.
ExtensionFeedItemCalloutFeedItemCalloutText String ATTRIBUTE The callout text. The length of this string should be between 1 and 25, inclusive.
ExtensionFeedItemDevice String ATTRIBUTE The targeted device.

The allowed values are MOBILE, UNKNOWN, UNSPECIFIED.

ExtensionFeedItemEndDateTime 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'
ExtensionFeedItemExtensionType String ATTRIBUTE Output only. The extension type of the extension feed item. This field is read-only.

The allowed values are AFFILIATE_LOCATION, APP, CALL, CALLOUT, HOTEL_CALLOUT, IMAGE, LOCATION, MESSAGE, NONE, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, UNKNOWN, UNSPECIFIED.

ExtensionFeedItemHotelCalloutFeedItemLanguageCode String ATTRIBUTE The language of the hotel callout text. IETF BCP 47 compliant language code.
ExtensionFeedItemHotelCalloutFeedItemText String ATTRIBUTE The callout text. The length of this string should be between 1 and 25, inclusive.
ExtensionFeedItemId Long ATTRIBUTE Output only. The ID of this feed item. Read-only.
ExtensionFeedItemImageFeedItemImageAsset String ATTRIBUTE Required. Resource name of the image asset.
ExtensionFeedItemLocationFeedItemAddressLine1 String ATTRIBUTE Line 1 of the business address.
ExtensionFeedItemLocationFeedItemAddressLine2 String ATTRIBUTE Line 2 of the business address.
ExtensionFeedItemLocationFeedItemBusinessName String ATTRIBUTE The name of the business.
ExtensionFeedItemLocationFeedItemCity String ATTRIBUTE City of the business address.
ExtensionFeedItemLocationFeedItemCountryCode String ATTRIBUTE Country code of the business address.
ExtensionFeedItemLocationFeedItemPhoneNumber String ATTRIBUTE Phone number of the business.
ExtensionFeedItemLocationFeedItemPostalCode String ATTRIBUTE Postal code of the business address.
ExtensionFeedItemLocationFeedItemProvince String ATTRIBUTE Province of the business address.
ExtensionFeedItemPriceFeedItemFinalUrlSuffix String ATTRIBUTE Tracking URL template for all offers of this price extension.
ExtensionFeedItemPriceFeedItemLanguageCode String ATTRIBUTE The code of the language used for this price extension.
ExtensionFeedItemPriceFeedItemPriceOfferings String ATTRIBUTE The price offerings in this price extension.
ExtensionFeedItemPriceFeedItemPriceQualifier String ATTRIBUTE Price qualifier for all offers of this price extension.

The allowed values are AVERAGE, FROM, UNKNOWN, UNSPECIFIED, UP_TO.

ExtensionFeedItemPriceFeedItemTrackingUrlTemplate String ATTRIBUTE Tracking URL template for all offers of this price extension.
ExtensionFeedItemPriceFeedItemType String ATTRIBUTE Price extension type of this extension.

The allowed values are BRANDS, EVENTS, LOCATIONS, NEIGHBORHOODS, PRODUCT_CATEGORIES, PRODUCT_TIERS, SERVICES, SERVICE_CATEGORIES, SERVICE_TIERS, UNKNOWN, UNSPECIFIED.

ExtensionFeedItemPromotionFeedItemDiscountModifier String ATTRIBUTE Enum that modifies the qualification of the discount.

The allowed values are UNKNOWN, UNSPECIFIED, UP_TO.

ExtensionFeedItemPromotionFeedItemFinalMobileUrls String ATTRIBUTE A list of possible final mobile URLs after all cross domain redirects.
ExtensionFeedItemPromotionFeedItemFinalUrlSuffix String ATTRIBUTE URL template for appending params to landing page URLs served with parallel tracking.
ExtensionFeedItemPromotionFeedItemFinalUrls String ATTRIBUTE A list of possible final URLs after all cross domain redirects. This field is required.
ExtensionFeedItemPromotionFeedItemLanguageCode String ATTRIBUTE The language of the promotion. Represented as BCP 47 language tag.
ExtensionFeedItemPromotionFeedItemMoneyAmountOffAmountMicros Long ATTRIBUTE Amount in micros. One million is equivalent to one unit.
ExtensionFeedItemPromotionFeedItemMoneyAmountOffCurrencyCode String ATTRIBUTE Three-character ISO 4217 currency code.
ExtensionFeedItemPromotionFeedItemOccasion String ATTRIBUTE The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion.

The allowed values are BACK_TO_SCHOOL, BLACK_FRIDAY, BOXING_DAY, CARNIVAL, CHINESE_NEW_YEAR, CHRISTMAS, CYBER_MONDAY, DIWALI, EASTER, EID_AL_ADHA, EID_AL_FITR, END_OF_SEASON, EPIPHANY, FALL_SALE, FATHERS_DAY, HALLOWEEN, HANUKKAH, HOLI, INDEPENDENCE_DAY, LABOR_DAY, MOTHERS_DAY, NATIONAL_DAY, NAVRATRI, NEW_YEARS, PARENTS_DAY, PASSOVER, RAMADAN, ROSH_HASHANAH, SINGLES_DAY, SONGKRAN, SPRING_SALE, ST_NICHOLAS_DAY, SUMMER_SALE, UNKNOWN, UNSPECIFIED, VALENTINES_DAY, WINTER_SALE, WOMENS_DAY, YEAR_END_GIFT.

ExtensionFeedItemPromotionFeedItemOrdersOverAmountAmountMicros Long ATTRIBUTE Amount in micros. One million is equivalent to one unit.
ExtensionFeedItemPromotionFeedItemOrdersOverAmountCurrencyCode String ATTRIBUTE Three-character ISO 4217 currency code.
ExtensionFeedItemPromotionFeedItemPercentOff Long ATTRIBUTE Percentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required.
ExtensionFeedItemPromotionFeedItemPromotionCode String ATTRIBUTE A code the user should use in order to be eligible for the promotion.
ExtensionFeedItemPromotionFeedItemPromotionEndDate Date ATTRIBUTE Last date when the promotion is eligible to be redeemed.
ExtensionFeedItemPromotionFeedItemPromotionStartDate Date ATTRIBUTE Start date of when the promotion is eligible to be redeemed.
ExtensionFeedItemPromotionFeedItemPromotionTarget String ATTRIBUTE A freeform description of what the promotion is targeting. This field is required.
ExtensionFeedItemPromotionFeedItemTrackingUrlTemplate String ATTRIBUTE URL template for constructing a tracking URL.
ExtensionFeedItemResourceName String ATTRIBUTE Immutable. The resource name of the extension feed item. Extension feed item resource names have the form: customers/{customer_id}/extensionFeedItems/{feed_item_id}
ExtensionFeedItemSitelinkFeedItemFinalMobileUrls String ATTRIBUTE A list of possible final mobile URLs after all cross domain redirects.
ExtensionFeedItemSitelinkFeedItemFinalUrlSuffix String ATTRIBUTE Final URL suffix to be appended to landing page URLs served with parallel tracking.
ExtensionFeedItemSitelinkFeedItemFinalUrls String ATTRIBUTE A list of possible final URLs after all cross domain redirects.
ExtensionFeedItemSitelinkFeedItemLine1 String ATTRIBUTE First line of the description for the sitelink. If this value is set, line2 must also be set. The length of this string should be between 0 and 35, inclusive.
ExtensionFeedItemSitelinkFeedItemLine2 String ATTRIBUTE Second line of the description for the sitelink. If this value is set, line1 must also be set. The length of this string should be between 0 and 35, inclusive.
ExtensionFeedItemSitelinkFeedItemLinkText String ATTRIBUTE URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
ExtensionFeedItemSitelinkFeedItemTrackingUrlTemplate String ATTRIBUTE URL template for constructing a tracking URL.
ExtensionFeedItemStartDateTime 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'
ExtensionFeedItemStatus String ATTRIBUTE Output only. Status of the feed item. This field is read-only.

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

ExtensionFeedItemStructuredSnippetFeedItemHeader String ATTRIBUTE The header of the snippet. This string must not be empty.
ExtensionFeedItemStructuredSnippetFeedItemValues String ATTRIBUTE The values in the snippet. The maximum size of this collection is 10.
ExtensionFeedItemTargetedAdGroup String ATTRIBUTE The targeted ad group.
ExtensionFeedItemTargetedCampaign String ATTRIBUTE The targeted campaign.
ExtensionFeedItemTargetedGeoTargetConstant String ATTRIBUTE The targeted geo target constant.
ExtensionFeedItemTargetedKeywordMatchType String ATTRIBUTE The match type of the keyword.

The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED.

ExtensionFeedItemTargetedKeywordText String ATTRIBUTE The text of the keyword (at most 80 characters and 10 words).
ExtensionFeedItemTextMessageFeedItemBusinessName String ATTRIBUTE The business name to prepend to the message text. This field is required.
ExtensionFeedItemTextMessageFeedItemCountryCode String ATTRIBUTE Uppercase two-letter country code of the advertiser's phone number. This field is required.
ExtensionFeedItemTextMessageFeedItemExtensionText String ATTRIBUTE The message extension_text populated in the messaging app.
ExtensionFeedItemTextMessageFeedItemPhoneNumber String ATTRIBUTE The advertiser's phone number the message will be sent to. Required.
ExtensionFeedItemTextMessageFeedItemText String ATTRIBUTE The text to show in the ad. This field is required.
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.
AllConversionsFromClickToCall Double METRIC The number of times people clicked the 'Call' button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
AllConversionsFromDirections Double METRIC The number of times people clicked a 'Get directions' button to navigate to a store after clicking an ad. This metric applies to feed items only.
AllConversionsFromInteractionsRate Double METRIC All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
AllConversionsFromMenu Double METRIC The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
AllConversionsFromOrder Double METRIC The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
AllConversionsFromOtherEngagement Double METRIC The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
AllConversionsFromStoreVisit Double METRIC Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
AllConversionsFromStoreWebsite Double METRIC The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
AllConversionsValue Double METRIC The value of all conversions.
AverageCpc Double METRIC The total cost of all clicks divided by the total number of clicks received.
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).
Impressions Long METRIC Count of how often your ad has appeared on a search results page or website on the Google Network.
MessageChatRate Double METRIC Number of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression.
MessageChats Long METRIC Number of message chats initiated for Click To Message impressions that were message tracking eligible.
MessageImpressions Long METRIC Number of Click To Message impressions that were message tracking eligible.
PhoneCalls Long METRIC Number of offline phone calls.
PhoneImpressions Long METRIC Number of offline phone impressions.
PhoneThroughRate Double METRIC Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
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.

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