Cmdlets for Google Ads

Build 24.0.9060

Asset

Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.

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
AssetBookOnGoogleAsset String ATTRIBUTE A book on google asset.
AssetCallAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetCallAssetCallConversionAction String ATTRIBUTE The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
AssetCallAssetCallConversionReportingState String ATTRIBUTE Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.

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

AssetCallAssetCountryCode String ATTRIBUTE Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
AssetCallAssetPhoneNumber String ATTRIBUTE Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
AssetCallToActionAssetCallToAction String ATTRIBUTE Call to action.

The allowed values are APPLY_NOW, BOOK_NOW, BUY_NOW, CONTACT_US, DONATE_NOW, DOWNLOAD, GET_QUOTE, LEARN_MORE, ORDER_NOW, PLAY_NOW, SEE_MORE, SHOP_NOW, SIGN_UP, START_NOW, SUBSCRIBE, UNKNOWN, UNSPECIFIED, VISIT_SITE, WATCH_NOW.

AssetCalloutAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetCalloutAssetCalloutText String ATTRIBUTE Required. The callout text. The length of this string should be between 1 and 25, inclusive.
AssetCalloutAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetCalloutAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetDemandGenCarouselCardAssetCallToActionText String ATTRIBUTE Call to action text.
AssetDemandGenCarouselCardAssetHeadline String ATTRIBUTE Required. Headline of the carousel card.
AssetDemandGenCarouselCardAssetMarketingImageAsset String ATTRIBUTE Asset resource name of the associated 1.91:1 marketing image. This and/or square marketing image asset is required.
AssetDemandGenCarouselCardAssetPortraitMarketingImageAsset String ATTRIBUTE Asset resource name of the associated 4:5 portrait marketing image.
AssetDemandGenCarouselCardAssetSquareMarketingImageAsset String ATTRIBUTE Asset resource name of the associated square marketing image. This and/or a marketing image asset is required.
AssetDynamicCustomAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicCustomAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Sedans, 4 door sedans.
AssetDynamicCustomAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $20,000.00.
AssetDynamicCustomAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $15,000.00.
AssetDynamicCustomAssetId String ATTRIBUTE Required. ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag, for example, sedan. Required.
AssetDynamicCustomAssetId2 String ATTRIBUTE ID2 which can be any sequence of letters and digits, for example, red. ID sequence (ID + ID2) must be unique.
AssetDynamicCustomAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicCustomAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicCustomAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicCustomAssetItemAddress String ATTRIBUTE Item address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicCustomAssetItemCategory String ATTRIBUTE Item category, for example, Sedans.
AssetDynamicCustomAssetItemDescription String ATTRIBUTE Item description, for example, Best selling mid-size car.
AssetDynamicCustomAssetItemSubtitle String ATTRIBUTE Item subtitle, for example, At your Mountain View dealership.
AssetDynamicCustomAssetItemTitle String ATTRIBUTE Required. Item title, for example, Mid-size sedan. Required.
AssetDynamicCustomAssetPrice String ATTRIBUTE Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 20,000.00 USD.
AssetDynamicCustomAssetSalePrice String ATTRIBUTE Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 15,000.00 USD. Must be less than the 'price' field.
AssetDynamicCustomAssetSimilarIds String ATTRIBUTE Similar IDs.
AssetDynamicEducationAssetAddress String ATTRIBUTE School address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicEducationAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicEducationAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Nursing certification, Health, Mountain View.
AssetDynamicEducationAssetImageUrl String ATTRIBUTE Image url, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicEducationAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicEducationAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicEducationAssetLocationId String ATTRIBUTE Location ID which can be any sequence of letters and digits and must be unique.
AssetDynamicEducationAssetProgramDescription String ATTRIBUTE Program description, for example, Nursing Certification.
AssetDynamicEducationAssetProgramId String ATTRIBUTE Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicEducationAssetProgramName String ATTRIBUTE Required. Program name, for example, Nursing. Required.
AssetDynamicEducationAssetSchoolName String ATTRIBUTE School name, for example, Mountain View School of Nursing.
AssetDynamicEducationAssetSimilarProgramIds String ATTRIBUTE Similar program IDs.
AssetDynamicEducationAssetSubject String ATTRIBUTE Subject of study, for example, Health.
AssetDynamicEducationAssetThumbnailImageUrl String ATTRIBUTE Thumbnail image url, for example, http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset.
AssetDynamicFlightsAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicFlightsAssetCustomMapping String ATTRIBUTE A custom field which can be multiple key to values mapping separated by delimiters (',', '|' and ':'), in the forms of ': , , ... , | : , ... , | ... | : , ... ,' for example, wifi: most | aircraft: 320, 77W | flights: 42 | legroom: 32'.
AssetDynamicFlightsAssetDestinationId String ATTRIBUTE Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicFlightsAssetDestinationName String ATTRIBUTE Destination name, for example, Paris.
AssetDynamicFlightsAssetFlightDescription String ATTRIBUTE Required. Flight description, for example, Book your ticket. Required.
AssetDynamicFlightsAssetFlightPrice String ATTRIBUTE Flight price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicFlightsAssetFlightSalePrice String ATTRIBUTE Flight sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'flight_price' field.
AssetDynamicFlightsAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicFlightsAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicFlightsAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicFlightsAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicFlightsAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicFlightsAssetOriginId String ATTRIBUTE Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
AssetDynamicFlightsAssetOriginName String ATTRIBUTE Origin name, for example, London.
AssetDynamicFlightsAssetSimilarDestinationIds String ATTRIBUTE Similar destination IDs, for example, PAR,LON.
AssetDynamicHotelsAndRentalsAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicHotelsAndRentalsAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicHotelsAndRentalsAssetCategory String ATTRIBUTE Category, for example, Hotel suite.
AssetDynamicHotelsAndRentalsAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Mountain View 'Hotels', South Bay hotels.
AssetDynamicHotelsAndRentalsAssetDescription String ATTRIBUTE Description, for example, Close to SJC Airport.
AssetDynamicHotelsAndRentalsAssetDestinationName String ATTRIBUTE Destination name, for example, Downtown Mountain View.
AssetDynamicHotelsAndRentalsAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicHotelsAndRentalsAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicHotelsAndRentalsAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicHotelsAndRentalsAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicHotelsAndRentalsAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicHotelsAndRentalsAssetPrice String ATTRIBUTE Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicHotelsAndRentalsAssetPropertyId String ATTRIBUTE Required. Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicHotelsAndRentalsAssetPropertyName String ATTRIBUTE Required. Property name, for example, Mountain View Hotel. Required.
AssetDynamicHotelsAndRentalsAssetSalePrice String ATTRIBUTE ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
AssetDynamicHotelsAndRentalsAssetSimilarPropertyIds String ATTRIBUTE Similar property IDs.
AssetDynamicHotelsAndRentalsAssetStarRating Long ATTRIBUTE Star rating. Must be a number between 1 to 5, inclusive.
AssetDynamicJobsAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
AssetDynamicJobsAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicJobsAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Software engineering job.
AssetDynamicJobsAssetDescription String ATTRIBUTE Description, for example, Apply your technical skills.
AssetDynamicJobsAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicJobsAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicJobsAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicJobsAssetJobCategory String ATTRIBUTE Job category, for example, Technical.
AssetDynamicJobsAssetJobId String ATTRIBUTE Required. Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicJobsAssetJobSubtitle String ATTRIBUTE Job subtitle, for example, Level II.
AssetDynamicJobsAssetJobTitle String ATTRIBUTE Required. Job title, for example, Software engineer. Required.
AssetDynamicJobsAssetLocationId String ATTRIBUTE Location ID which can be any sequence of letters and digits. The ID sequence (job ID + location ID) must be unique.
AssetDynamicJobsAssetSalary String ATTRIBUTE Salary, for example, $100,000.
AssetDynamicJobsAssetSimilarJobIds String ATTRIBUTE Similar job IDs, for example, 1275.
AssetDynamicLocalAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
AssetDynamicLocalAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicLocalAssetCategory String ATTRIBUTE Category, for example, Food.
AssetDynamicLocalAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Save groceries coupons.
AssetDynamicLocalAssetDealId String ATTRIBUTE Required. Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicLocalAssetDealName String ATTRIBUTE Required. Deal name, for example, 50% off at Mountain View Grocers. Required.
AssetDynamicLocalAssetDescription String ATTRIBUTE Description, for example, Save on your weekly bill.
AssetDynamicLocalAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicLocalAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicLocalAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicLocalAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicLocalAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicLocalAssetPrice String ATTRIBUTE Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicLocalAssetSalePrice String ATTRIBUTE Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
AssetDynamicLocalAssetSimilarDealIds String ATTRIBUTE Similar deal IDs, for example, 1275.
AssetDynamicLocalAssetSubtitle String ATTRIBUTE Subtitle, for example, Groceries.
AssetDynamicRealEstateAssetAddress String ATTRIBUTE Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
AssetDynamicRealEstateAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicRealEstateAssetCityName String ATTRIBUTE City name, for example, Mountain View, California.
AssetDynamicRealEstateAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, For sale; Houses for sale.
AssetDynamicRealEstateAssetDescription String ATTRIBUTE Description, for example, 3 beds, 2 baths, 1568 sq. ft.
AssetDynamicRealEstateAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $200,000.00.
AssetDynamicRealEstateAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicRealEstateAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicRealEstateAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicRealEstateAssetListingId String ATTRIBUTE Required. Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicRealEstateAssetListingName String ATTRIBUTE Required. Listing name, for example, Boulevard Bungalow. Required.
AssetDynamicRealEstateAssetListingType String ATTRIBUTE Listing type, for example, For sale.
AssetDynamicRealEstateAssetPrice String ATTRIBUTE Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 200,000.00 USD.
AssetDynamicRealEstateAssetPropertyType String ATTRIBUTE Property type, for example, House.
AssetDynamicRealEstateAssetSimilarListingIds String ATTRIBUTE Similar listing IDs.
AssetDynamicTravelAssetAndroidAppLink String ATTRIBUTE Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
AssetDynamicTravelAssetCategory String ATTRIBUTE Category, for example, Express.
AssetDynamicTravelAssetContextualKeywords String ATTRIBUTE Contextual keywords, for example, Paris trains.
AssetDynamicTravelAssetDestinationAddress String ATTRIBUTE Destination address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
AssetDynamicTravelAssetDestinationId String ATTRIBUTE Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
AssetDynamicTravelAssetDestinationName String ATTRIBUTE Destination name, for example, Paris.
AssetDynamicTravelAssetFormattedPrice String ATTRIBUTE Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
AssetDynamicTravelAssetFormattedSalePrice String ATTRIBUTE Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
AssetDynamicTravelAssetImageUrl String ATTRIBUTE Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
AssetDynamicTravelAssetIosAppLink String ATTRIBUTE iOS deep link, for example, exampleApp://content/page.
AssetDynamicTravelAssetIosAppStoreId Long ATTRIBUTE iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
AssetDynamicTravelAssetOriginId String ATTRIBUTE Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
AssetDynamicTravelAssetOriginName String ATTRIBUTE Origin name, for example, London.
AssetDynamicTravelAssetPrice String ATTRIBUTE Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
AssetDynamicTravelAssetSalePrice String ATTRIBUTE Sale price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
AssetDynamicTravelAssetSimilarDestinationIds String ATTRIBUTE Similar destination IDs, for example, NYC.
AssetDynamicTravelAssetTitle String ATTRIBUTE Required. Title, for example, Book your train ticket. Required.
AssetFieldTypePolicySummaries String ATTRIBUTE Output only. Policy information for the asset for each FieldType.
AssetFinalMobileUrls String ATTRIBUTE A list of possible final mobile URLs after all cross domain redirects.
AssetFinalUrlSuffix String ATTRIBUTE URL template for appending params to landing page URLs served with parallel tracking.
AssetFinalUrls String ATTRIBUTE A list of possible final URLs after all cross domain redirects.
AssetHotelCalloutAssetLanguageCode String ATTRIBUTE Required. The language of the hotel callout. Represented as BCP 47 language tag.
AssetHotelCalloutAssetText String ATTRIBUTE Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive.
AssetHotelPropertyAssetHotelAddress String ATTRIBUTE Address of the hotel. Read-only.
AssetHotelPropertyAssetHotelName String ATTRIBUTE Name of the hotel. Read-only.
AssetHotelPropertyAssetPlaceId String ATTRIBUTE Place IDs uniquely identify a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id to learn more.
AssetId Long ATTRIBUTE Output only. The ID of the asset.
AssetImageAssetFileSize Long ATTRIBUTE File size of the image asset in bytes.
AssetImageAssetFullSizeHeightPixels Long ATTRIBUTE Height of the image.
AssetImageAssetFullSizeUrl String ATTRIBUTE A URL that returns the image with this height and width.
AssetImageAssetFullSizeWidthPixels Long ATTRIBUTE Width of the image.
AssetImageAssetMimeType String ATTRIBUTE MIME type of the image asset.

The allowed values are AUDIO_MP3, AUDIO_WAV, FLASH, HTML5_AD_ZIP, IMAGE_GIF, IMAGE_JPEG, IMAGE_PNG, MSEXCEL, MSWORD, PDF, RTF, TEXT_HTML, UNKNOWN, UNSPECIFIED.

AssetLeadFormAssetBackgroundImageAsset String ATTRIBUTE Asset resource name of the background image. The image dimensions must be exactly 1200x628.
AssetLeadFormAssetBusinessName String ATTRIBUTE Required. The name of the business being advertised.
AssetLeadFormAssetCallToActionDescription String ATTRIBUTE Required. Text giving a clear value proposition of what users expect once they expand the form.
AssetLeadFormAssetCallToActionType String ATTRIBUTE Required. Pre-defined display text that encourages user to expand the form.

The allowed values are APPLY_NOW, BOOK_NOW, CONTACT_US, DOWNLOAD, GET_INFO, GET_OFFER, GET_QUOTE, GET_STARTED, JOIN_NOW, LEARN_MORE, REGISTER, REQUEST_DEMO, SIGN_UP, SUBSCRIBE, UNKNOWN, UNSPECIFIED.

AssetLeadFormAssetCustomDisclosure String ATTRIBUTE Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only.
AssetLeadFormAssetCustomQuestionFields String ATTRIBUTE Ordered list of custom question fields. This field is subject to a limit of 5 qualifying questions per form.
AssetLeadFormAssetDeliveryMethods String ATTRIBUTE Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured.
AssetLeadFormAssetDescription String ATTRIBUTE Required. Detailed description of the expanded form to describe what the form is asking for or facilitating.
AssetLeadFormAssetDesiredIntent String ATTRIBUTE Chosen intent for the lead form, for example, more volume or more qualified.

The allowed values are HIGH_INTENT, LOW_INTENT, UNKNOWN, UNSPECIFIED.

AssetLeadFormAssetFields String ATTRIBUTE Ordered list of input fields. This field can be updated by reordering questions, but not by adding or removing questions.
AssetLeadFormAssetHeadline String ATTRIBUTE Required. Headline of the expanded form to describe what the form is asking for or facilitating.
AssetLeadFormAssetPostSubmitCallToActionType String ATTRIBUTE Pre-defined display text that encourages user action after the form is submitted.

The allowed values are DOWNLOAD, LEARN_MORE, SHOP_NOW, UNKNOWN, UNSPECIFIED, VISIT_SITE.

AssetLeadFormAssetPostSubmitDescription String ATTRIBUTE Detailed description shown after form submission that describes how the advertiser will follow up with the user.
AssetLeadFormAssetPostSubmitHeadline String ATTRIBUTE Headline of text shown after form submission that describes how the advertiser will follow up with the user.
AssetLeadFormAssetPrivacyPolicyUrl String ATTRIBUTE Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business.
AssetLocationAssetBusinessProfileLocations String ATTRIBUTE The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
AssetLocationAssetLocationOwnershipType String ATTRIBUTE The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.

The allowed values are AFFILIATE, BUSINESS_OWNER, UNKNOWN, UNSPECIFIED.

AssetLocationAssetPlaceId String ATTRIBUTE Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
AssetMobileAppAssetAppId String ATTRIBUTE Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like 'com.android.ebay' for Android or '12345689' for iOS.
AssetMobileAppAssetAppStore String ATTRIBUTE Required. The application store that distributes this specific app.

The allowed values are APPLE_APP_STORE, GOOGLE_APP_STORE, UNKNOWN, UNSPECIFIED.

AssetMobileAppAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetMobileAppAssetLinkText String ATTRIBUTE Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive.
AssetMobileAppAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetName String ATTRIBUTE Optional name of the asset.
AssetPageFeedAssetLabels String ATTRIBUTE Labels used to group the page urls.
AssetPageFeedAssetPageUrl String ATTRIBUTE Required. The webpage that advertisers want to target.
AssetPolicySummaryApprovalStatus String ATTRIBUTE Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries.

The allowed values are APPROVED, APPROVED_LIMITED, AREA_OF_INTEREST_ONLY, DISAPPROVED, UNKNOWN, UNSPECIFIED.

AssetPolicySummaryPolicyTopicEntries String ATTRIBUTE Output only. The list of policy findings for this asset.
AssetPolicySummaryReviewStatus String ATTRIBUTE Output only. Where in the review process this asset is.

The allowed values are ELIGIBLE_MAY_SERVE, REVIEWED, REVIEW_IN_PROGRESS, UNDER_APPEAL, UNKNOWN, UNSPECIFIED.

AssetPriceAssetLanguageCode String ATTRIBUTE Required. The language of the price asset. Represented as BCP 47 language tag.
AssetPriceAssetPriceOfferings String ATTRIBUTE The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive.
AssetPriceAssetPriceQualifier String ATTRIBUTE The price qualifier of the price asset.

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

AssetPriceAssetType String ATTRIBUTE Required. The type of the price asset.

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

AssetPromotionAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetPromotionAssetDiscountModifier String ATTRIBUTE A modifier for qualification of the discount.

The allowed values are UNKNOWN, UNSPECIFIED, UP_TO.

AssetPromotionAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetPromotionAssetLanguageCode String ATTRIBUTE The language of the promotion. Represented as BCP 47 language tag.
AssetPromotionAssetMoneyAmountOffAmountMicros Long ATTRIBUTE Amount in micros. One million is equivalent to one unit.
AssetPromotionAssetMoneyAmountOffCurrencyCode String ATTRIBUTE Three-character ISO 4217 currency code.
AssetPromotionAssetOccasion 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.

AssetPromotionAssetOrdersOverAmountAmountMicros Long ATTRIBUTE Amount in micros. One million is equivalent to one unit.
AssetPromotionAssetOrdersOverAmountCurrencyCode String ATTRIBUTE Three-character ISO 4217 currency code.
AssetPromotionAssetPercentOff Long ATTRIBUTE Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required.
AssetPromotionAssetPromotionCode String ATTRIBUTE A code the user should use in order to be eligible for the promotion.
AssetPromotionAssetPromotionTarget String ATTRIBUTE Required. A freeform description of what the promotion is targeting.
AssetPromotionAssetRedemptionEndDate Date ATTRIBUTE Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
AssetPromotionAssetRedemptionStartDate Date ATTRIBUTE Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
AssetPromotionAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetResourceName String ATTRIBUTE Immutable. The resource name of the asset. Asset resource names have the form: customers/{customer_id}/assets/{asset_id}
AssetSitelinkAssetAdScheduleTargets String ATTRIBUTE List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
AssetSitelinkAssetDescription1 String ATTRIBUTE First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
AssetSitelinkAssetDescription2 String ATTRIBUTE Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
AssetSitelinkAssetEndDate Date ATTRIBUTE Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
AssetSitelinkAssetLinkText String ATTRIBUTE Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
AssetSitelinkAssetStartDate Date ATTRIBUTE Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
AssetSource String ATTRIBUTE Output only. Source of the asset.

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

AssetStructuredSnippetAssetHeader String ATTRIBUTE Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
AssetStructuredSnippetAssetValues String ATTRIBUTE Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive.
AssetTextAssetText String ATTRIBUTE Text content of the text asset.
AssetTrackingUrlTemplate String ATTRIBUTE URL template for constructing a tracking URL.
AssetType String ATTRIBUTE Output only. Type of the asset.

The allowed values are BOOK_ON_GOOGLE, CALL, CALLOUT, CALL_TO_ACTION, DISCOVERY_CAROUSEL_CARD, DYNAMIC_CUSTOM, DYNAMIC_EDUCATION, DYNAMIC_FLIGHTS, DYNAMIC_HOTELS_AND_RENTALS, DYNAMIC_JOBS, DYNAMIC_LOCAL, DYNAMIC_REAL_ESTATE, DYNAMIC_TRAVEL, HOTEL_CALLOUT, HOTEL_PROPERTY, IMAGE, LEAD_FORM, LOCATION, MEDIA_BUNDLE, MOBILE_APP, PAGE_FEED, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET, TEXT, UNKNOWN, UNSPECIFIED, YOUTUBE_VIDEO.

AssetUrlCustomParameters String ATTRIBUTE A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.
AssetYoutubeVideoAssetYoutubeVideoId String ATTRIBUTE YouTube video id. This is the 11 character string value used in the YouTube video URL.
AssetYoutubeVideoAssetYoutubeVideoTitle String ATTRIBUTE YouTube video title.
CustomerId Long ATTRIBUTE Output only. The ID of the customer.
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.
ConversionAdjustment Bool SEGMENT This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
ConversionLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion.

The allowed values are EIGHT_TO_NINE_DAYS, ELEVEN_TO_TWELVE_DAYS, FIVE_TO_SIX_DAYS, FORTY_FIVE_TO_SIXTY_DAYS, FOURTEEN_TO_TWENTY_ONE_DAYS, FOUR_TO_FIVE_DAYS, LESS_THAN_ONE_DAY, NINE_TO_TEN_DAYS, ONE_TO_TWO_DAYS, SEVEN_TO_EIGHT_DAYS, SIXTY_TO_NINETY_DAYS, SIX_TO_SEVEN_DAYS, TEN_TO_ELEVEN_DAYS, THIRTEEN_TO_FOURTEEN_DAYS, THIRTY_TO_FORTY_FIVE_DAYS, THREE_TO_FOUR_DAYS, TWELVE_TO_THIRTEEN_DAYS, TWENTY_ONE_TO_THIRTY_DAYS, TWO_TO_THREE_DAYS, UNKNOWN, UNSPECIFIED.

ConversionOrAdjustmentLagBucket String SEGMENT An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.

The allowed values are ADJUSTMENT_EIGHT_TO_NINE_DAYS, ADJUSTMENT_ELEVEN_TO_TWELVE_DAYS, ADJUSTMENT_FIVE_TO_SIX_DAYS, ADJUSTMENT_FORTY_FIVE_TO_SIXTY_DAYS, ADJUSTMENT_FOURTEEN_TO_TWENTY_ONE_DAYS, ADJUSTMENT_FOUR_TO_FIVE_DAYS, ADJUSTMENT_LESS_THAN_ONE_DAY, ADJUSTMENT_NINETY_TO_ONE_HUNDRED_AND_FORTY_FIVE_DAYS, ADJUSTMENT_NINE_TO_TEN_DAYS, ADJUSTMENT_ONE_TO_TWO_DAYS, ADJUSTMENT_SEVEN_TO_EIGHT_DAYS, ADJUSTMENT_SIXTY_TO_NINETY_DAYS, ADJUSTMENT_SIX_TO_SEVEN_DAYS, ADJUSTMENT_TEN_TO_ELEVEN_DAYS, ADJUSTMENT_THIRTEEN_TO_FOURTEEN_DAYS, ADJUSTMENT_THIRTY_TO_FORTY_FIVE_DAYS, ADJUSTMENT_THREE_TO_FOUR_DAYS, ADJUSTMENT_TWELVE_TO_THIRTEEN_DAYS, ADJUSTMENT_TWENTY_ONE_TO_THIRTY_DAYS, ADJUSTMENT_TWO_TO_THREE_DAYS, ADJUSTMENT_UNKNOWN, CONVERSION_EIGHT_TO_NINE_DAYS, CONVERSION_ELEVEN_TO_TWELVE_DAYS, CONVERSION_FIVE_TO_SIX_DAYS, CONVERSION_FORTY_FIVE_TO_SIXTY_DAYS, CONVERSION_FOURTEEN_TO_TWENTY_ONE_DAYS, CONVERSION_FOUR_TO_FIVE_DAYS, CONVERSION_LESS_THAN_ONE_DAY, CONVERSION_NINE_TO_TEN_DAYS, CONVERSION_ONE_TO_TWO_DAYS, CONVERSION_SEVEN_TO_EIGHT_DAYS, CONVERSION_SIXTY_TO_NINETY_DAYS, CONVERSION_SIX_TO_SEVEN_DAYS, CONVERSION_TEN_TO_ELEVEN_DAYS, CONVERSION_THIRTEEN_TO_FOURTEEN_DAYS, CONVERSION_THIRTY_TO_FORTY_FIVE_DAYS, CONVERSION_THREE_TO_FOUR_DAYS, CONVERSION_TWELVE_TO_THIRTEEN_DAYS, CONVERSION_TWENTY_ONE_TO_THIRTY_DAYS, CONVERSION_TWO_TO_THREE_DAYS, CONVERSION_UNKNOWN, 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.

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