- JSON representation
- AttributeFieldMapping
- SitelinkPlaceholderField
- CallPlaceholderField
- AppPlaceholderField
- LocationPlaceholderField
- AffiliateLocationPlaceholderField
- CalloutPlaceholderField
- StructuredSnippetPlaceholderField
- MessagePlaceholderField
- PricePlaceholderField
- PromotionPlaceholderField
- AdCustomizerPlaceholderField
- DsaPageFeedCriterionField
- LocationExtensionTargetingCriterionField
- EducationPlaceholderField
- FlightPlaceholderField
- CustomPlaceholderField
- HotelPlaceholderField
- RealEstatePlaceholderField
- TravelPlaceholderField
- LocalPlaceholderField
- JobPlaceholderField
- ImagePlaceholderField
- FeedMappingStatus
- FeedMappingCriterionType
A feed mapping.
JSON representation |
---|
{ "resourceName": string, "attributeFieldMappings": [ { object ( |
Fields | |
---|---|
resourceName |
Immutable. The resource name of the feed mapping. Feed mapping resource names have the form:
|
attributeFieldMappings[] |
Immutable. Feed attributes to field mappings. These mappings are a one-to-many relationship meaning that 1 feed attribute can be used to populate multiple placeholder fields, but 1 placeholder field can only draw data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder field can be mapped to multiple feed attributes. Required. |
status |
Output only. Status of the feed mapping. This field is read-only. |
feed |
Immutable. The feed of this feed mapping. |
Union field target . Feed mapping target. Can be either a placeholder or a criterion. For a given feed, the active FeedMappings must have unique targets. Required. target can be only one of the following: |
|
placeholderType |
Immutable. The placeholder type of this mapping (for example, if the mapping maps feed attributes to placeholder fields). |
criterionType |
Immutable. The criterion type of this mapping (for example, if the mapping maps feed attributes to criterion fields). |
AttributeFieldMapping
Maps from feed attribute id to a placeholder or criterion field id.
JSON representation |
---|
{ "feedAttributeId": string, "fieldId": string, // Union field |
Fields | |
---|---|
feedAttributeId |
Immutable. Feed attribute from which to map. |
fieldId |
Output only. The placeholder field ID. If a placeholder field enum is not published in the current API version, then this field will be populated and the field oneof will be empty. This field is read-only. |
Union field field . Placeholder or criterion field to be populated using data from the above feed attribute. Required. field can be only one of the following: |
|
sitelinkField |
Immutable. Sitelink Placeholder Fields. |
callField |
Immutable. Call Placeholder Fields. |
appField |
Immutable. App Placeholder Fields. |
locationField |
Output only. Location Placeholder Fields. This field is read-only. |
affiliateLocationField |
Output only. Affiliate Location Placeholder Fields. This field is read-only. |
calloutField |
Immutable. Callout Placeholder Fields. |
structuredSnippetField |
Immutable. Structured Snippet Placeholder Fields. |
messageField |
Immutable. Message Placeholder Fields. |
priceField |
Immutable. Price Placeholder Fields. |
promotionField |
Immutable. Promotion Placeholder Fields. |
adCustomizerField |
Immutable. Ad Customizer Placeholder Fields |
dsaPageFeedField |
Immutable. Dynamic Search Ad Page Feed Fields. |
locationExtensionTargetingField |
Immutable. Location Target Fields. |
educationField |
Immutable. Education Placeholder Fields |
flightField |
Immutable. Flight Placeholder Fields |
customField |
Immutable. Custom Placeholder Fields |
hotelField |
Immutable. Hotel Placeholder Fields |
realEstateField |
Immutable. Real Estate Placeholder Fields |
travelField |
Immutable. Travel Placeholder Fields |
localField |
Immutable. Local Placeholder Fields |
jobField |
Immutable. Job Placeholder Fields |
imageField |
Immutable. Image Placeholder Fields |
SitelinkPlaceholderField
Possible values for Sitelink placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
TEXT |
Data Type: STRING. The link text for your sitelink. |
LINE_1 |
Data Type: STRING. First line of the sitelink description. |
LINE_2 |
Data Type: STRING. Second line of the sitelink description. |
FINAL_URLS |
Data Type: URL_LIST. Final URLs for the sitelink when using Upgraded URLs. |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final Mobile URLs for the sitelink when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the sitelink when using Upgraded URLs. |
FINAL_URL_SUFFIX |
Data Type: STRING. Final URL suffix for sitelink when using parallel tracking. |
CallPlaceholderField
Possible values for Call placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PHONE_NUMBER |
Data Type: STRING. The advertiser's phone number to append to the ad. |
COUNTRY_CODE |
Data Type: STRING. Uppercase two-letter country code of the advertiser's phone number. |
TRACKED |
Data Type: BOOLEAN. Indicates whether call tracking is enabled. Default: true. |
CONVERSION_TYPE_ID |
Data Type: INT64. The ID of an AdCallMetricsConversion object. This object contains the phoneCallDurationfield which is the minimum duration (in seconds) of a call to be considered a conversion. |
CONVERSION_REPORTING_STATE |
Data Type: STRING. Indicates whether this call extension uses its own call conversion setting or follows the account level setting. Valid values are: USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION and USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION. |
AppPlaceholderField
Possible values for App placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
STORE |
Data Type: INT64. The application store that the target application belongs to. Valid values are: 1 = Apple iTunes Store; 2 = Google Play Store. |
ID |
Data Type: STRING. The store-specific ID for the target application. |
LINK_TEXT |
Data Type: STRING. The visible text displayed when the link is rendered in an ad. |
URL |
Data Type: STRING. The destination URL of the in-app link. |
FINAL_URLS |
Data Type: URL_LIST. Final URLs for the in-app link when using Upgraded URLs. |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final Mobile URLs for the in-app link when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the in-app link when using Upgraded URLs. |
FINAL_URL_SUFFIX |
Data Type: STRING. Final URL suffix for the in-app link when using parallel tracking. |
LocationPlaceholderField
Possible values for Location placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_NAME |
Data Type: STRING. The name of the business. |
ADDRESS_LINE_1 |
Data Type: STRING. Line 1 of the business address. |
ADDRESS_LINE_2 |
Data Type: STRING. Line 2 of the business address. |
CITY |
Data Type: STRING. City of the business address. |
PROVINCE |
Data Type: STRING. Province of the business address. |
POSTAL_CODE |
Data Type: STRING. Postal code of the business address. |
COUNTRY_CODE |
Data Type: STRING. Country code of the business address. |
PHONE_NUMBER |
Data Type: STRING. Phone number of the business. |
AffiliateLocationPlaceholderField
Possible values for Affiliate Location placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_NAME |
Data Type: STRING. The name of the business. |
ADDRESS_LINE_1 |
Data Type: STRING. Line 1 of the business address. |
ADDRESS_LINE_2 |
Data Type: STRING. Line 2 of the business address. |
CITY |
Data Type: STRING. City of the business address. |
PROVINCE |
Data Type: STRING. Province of the business address. |
POSTAL_CODE |
Data Type: STRING. Postal code of the business address. |
COUNTRY_CODE |
Data Type: STRING. Country code of the business address. |
PHONE_NUMBER |
Data Type: STRING. Phone number of the business. |
LANGUAGE_CODE |
Data Type: STRING. Language code of the business. |
CHAIN_ID |
Data Type: INT64. ID of the chain. |
CHAIN_NAME |
Data Type: STRING. Name of the chain. |
CalloutPlaceholderField
Possible values for Callout placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
CALLOUT_TEXT |
Data Type: STRING. Callout text. |
StructuredSnippetPlaceholderField
Possible values for Structured Snippet placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
HEADER |
Data Type: STRING. The category of snippet of your products/services. Must match exactly one of the predefined structured snippets headers. For a list, visit https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers |
SNIPPETS |
Data Type: STRING_LIST. Text values that describe your products/services. All text must be family safe. Special or non-ASCII characters are not permitted. A snippet can be at most 25 characters. |
MessagePlaceholderField
Possible values for Message placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BUSINESS_NAME |
Data Type: STRING. The name of your business. |
COUNTRY_CODE |
Data Type: STRING. Country code of phone number. |
PHONE_NUMBER |
Data Type: STRING. A phone number that's capable of sending and receiving text messages. |
MESSAGE_EXTENSION_TEXT |
Data Type: STRING. The text that will go in your click-to-message ad. |
MESSAGE_TEXT |
Data Type: STRING. The message text automatically shows in people's messaging apps when they tap to send you a message. |
PricePlaceholderField
Possible values for Price placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
TYPE |
Data Type: STRING. The type of your price feed. Must match one of the predefined price feed type exactly. |
PRICE_QUALIFIER |
Data Type: STRING. The qualifier of each price. Must match one of the predefined price qualifiers exactly. |
TRACKING_TEMPLATE |
Data Type: URL. Tracking template for the price feed when using Upgraded URLs. |
LANGUAGE |
Data Type: STRING. Language of the price feed. Must match one of the available available locale codes exactly. |
FINAL_URL_SUFFIX |
Data Type: STRING. Final URL suffix for the price feed when using parallel tracking. |
ITEM_1_HEADER |
Data Type: STRING. The header of item 1 of the table. |
ITEM_1_DESCRIPTION |
Data Type: STRING. The description of item 1 of the table. |
ITEM_1_PRICE |
Data Type: MONEY. The price (money with currency) of item 1 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_1_UNIT |
Data Type: STRING. The price unit of item 1 of the table. Must match one of the predefined price units. |
ITEM_1_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 1 of the table when using Upgraded URLs. |
ITEM_1_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 1 of the table when using Upgraded URLs. |
ITEM_2_HEADER |
Data Type: STRING. The header of item 2 of the table. |
ITEM_2_DESCRIPTION |
Data Type: STRING. The description of item 2 of the table. |
ITEM_2_PRICE |
Data Type: MONEY. The price (money with currency) of item 2 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_2_UNIT |
Data Type: STRING. The price unit of item 2 of the table. Must match one of the predefined price units. |
ITEM_2_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 2 of the table when using Upgraded URLs. |
ITEM_2_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 2 of the table when using Upgraded URLs. |
ITEM_3_HEADER |
Data Type: STRING. The header of item 3 of the table. |
ITEM_3_DESCRIPTION |
Data Type: STRING. The description of item 3 of the table. |
ITEM_3_PRICE |
Data Type: MONEY. The price (money with currency) of item 3 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_3_UNIT |
Data Type: STRING. The price unit of item 3 of the table. Must match one of the predefined price units. |
ITEM_3_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 3 of the table when using Upgraded URLs. |
ITEM_3_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 3 of the table when using Upgraded URLs. |
ITEM_4_HEADER |
Data Type: STRING. The header of item 4 of the table. |
ITEM_4_DESCRIPTION |
Data Type: STRING. The description of item 4 of the table. |
ITEM_4_PRICE |
Data Type: MONEY. The price (money with currency) of item 4 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_4_UNIT |
Data Type: STRING. The price unit of item 4 of the table. Must match one of the predefined price units. |
ITEM_4_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 4 of the table when using Upgraded URLs. |
ITEM_4_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 4 of the table when using Upgraded URLs. |
ITEM_5_HEADER |
Data Type: STRING. The header of item 5 of the table. |
ITEM_5_DESCRIPTION |
Data Type: STRING. The description of item 5 of the table. |
ITEM_5_PRICE |
Data Type: MONEY. The price (money with currency) of item 5 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_5_UNIT |
Data Type: STRING. The price unit of item 5 of the table. Must match one of the predefined price units. |
ITEM_5_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 5 of the table when using Upgraded URLs. |
ITEM_5_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 5 of the table when using Upgraded URLs. |
ITEM_6_HEADER |
Data Type: STRING. The header of item 6 of the table. |
ITEM_6_DESCRIPTION |
Data Type: STRING. The description of item 6 of the table. |
ITEM_6_PRICE |
Data Type: MONEY. The price (money with currency) of item 6 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_6_UNIT |
Data Type: STRING. The price unit of item 6 of the table. Must match one of the predefined price units. |
ITEM_6_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 6 of the table when using Upgraded URLs. |
ITEM_6_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 6 of the table when using Upgraded URLs. |
ITEM_7_HEADER |
Data Type: STRING. The header of item 7 of the table. |
ITEM_7_DESCRIPTION |
Data Type: STRING. The description of item 7 of the table. |
ITEM_7_PRICE |
Data Type: MONEY. The price (money with currency) of item 7 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_7_UNIT |
Data Type: STRING. The price unit of item 7 of the table. Must match one of the predefined price units. |
ITEM_7_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 7 of the table when using Upgraded URLs. |
ITEM_7_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 7 of the table when using Upgraded URLs. |
ITEM_8_HEADER |
Data Type: STRING. The header of item 8 of the table. |
ITEM_8_DESCRIPTION |
Data Type: STRING. The description of item 8 of the table. |
ITEM_8_PRICE |
Data Type: MONEY. The price (money with currency) of item 8 of the table, for example, 30 USD. The currency must match one of the available currencies. |
ITEM_8_UNIT |
Data Type: STRING. The price unit of item 8 of the table. Must match one of the predefined price units. |
ITEM_8_FINAL_URLS |
Data Type: URL_LIST. The final URLs of item 8 of the table when using Upgraded URLs. |
ITEM_8_FINAL_MOBILE_URLS |
Data Type: URL_LIST. The final mobile URLs of item 8 of the table when using Upgraded URLs. |
PromotionPlaceholderField
Possible values for Promotion placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PROMOTION_TARGET |
Data Type: STRING. The text that appears on the ad when the extension is shown. |
DISCOUNT_MODIFIER |
Data Type: STRING. Lets you add "up to" phrase to the promotion, in case you have variable promotion rates. |
PERCENT_OFF |
Data Type: INT64. Takes a value in micros, where 1 million micros represents 1%, and is shown as a percentage when rendered. |
MONEY_AMOUNT_OFF |
Data Type: MONEY. Requires a currency and an amount of money. |
PROMOTION_CODE |
Data Type: STRING. A string that the user enters to get the discount. |
ORDERS_OVER_AMOUNT |
Data Type: MONEY. A minimum spend before the user qualifies for the promotion. |
PROMOTION_START |
Data Type: DATE. The start date of the promotion. |
PROMOTION_END |
Data Type: DATE. The end date of the promotion. |
OCCASION |
Data Type: STRING. Describes the associated event for the promotion using one of the PromotionExtensionOccasion enum values, for example NEW_YEARS. |
FINAL_URLS |
Data Type: URL_LIST. Final URLs to be used in the ad when using Upgraded URLs. |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
LANGUAGE |
Data Type: STRING. A string represented by a language code for the promotion. |
FINAL_URL_SUFFIX |
Data Type: STRING. Final URL suffix for the ad when using parallel tracking. |
AdCustomizerPlaceholderField
Possible values for Ad Customizers placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
INTEGER |
Data Type: INT64. Integer value to be inserted. |
PRICE |
Data Type: STRING. Price value to be inserted. |
DATE |
Data Type: DATE_TIME. Date value to be inserted. |
STRING |
Data Type: STRING. String value to be inserted. |
DsaPageFeedCriterionField
Possible values for Dynamic Search Ad Page Feed criterion fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PAGE_URL |
Data Type: URL or URL_LIST. URL of the web page you want to target. |
LABEL |
Data Type: STRING_LIST. The labels that will help you target ads within your page feed. |
LocationExtensionTargetingCriterionField
Possible values for Location Extension Targeting criterion fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ADDRESS_LINE_1 |
Data Type: STRING. Line 1 of the business address. |
ADDRESS_LINE_2 |
Data Type: STRING. Line 2 of the business address. |
CITY |
Data Type: STRING. City of the business address. |
PROVINCE |
Data Type: STRING. Province of the business address. |
POSTAL_CODE |
Data Type: STRING. Postal code of the business address. |
COUNTRY_CODE |
Data Type: STRING. Country code of the business address. |
EducationPlaceholderField
Possible values for Education placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PROGRAM_ID |
Data Type: STRING. Required. Combination of PROGRAM ID and LOCATION ID must be unique per offer. |
LOCATION_ID |
Data Type: STRING. Combination of PROGRAM ID and LOCATION ID must be unique per offer. |
PROGRAM_NAME |
Data Type: STRING. Required. Main headline with program name to be shown in dynamic ad. |
AREA_OF_STUDY |
Data Type: STRING. Area of study that can be shown in dynamic ad. |
PROGRAM_DESCRIPTION |
Data Type: STRING. Description of program that can be shown in dynamic ad. |
SCHOOL_NAME |
Data Type: STRING. Name of school that can be shown in dynamic ad. |
ADDRESS |
Data Type: STRING. Complete school address, including postal code. |
THUMBNAIL_IMAGE_URL |
Data Type: URL. Image to be displayed in ads. |
ALTERNATIVE_THUMBNAIL_IMAGE_URL |
Data Type: URL. Alternative hosted file of image to be used in the ad. |
FINAL_URLS |
Data Type: URL_LIST. Required. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (for example, the individual URL of a specific program and its location). |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_PROGRAM_IDS |
Data Type: STRING_LIST. List of recommended program IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
FlightPlaceholderField
Possible values for Flight placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DESTINATION_ID |
Data Type: STRING. Required. Destination id. Example: PAR, LON. For feed items that only have destination id, destination id must be a unique key. For feed items that have both destination id and origin id, then the combination must be a unique key. |
ORIGIN_ID |
Data Type: STRING. Origin id. Example: PAR, LON. Optional. Combination of destination id and origin id must be unique per offer. |
FLIGHT_DESCRIPTION |
Data Type: STRING. Required. Main headline with product name to be shown in dynamic ad. |
ORIGIN_NAME |
Data Type: STRING. Shorter names are recommended. |
DESTINATION_NAME |
Data Type: STRING. Shorter names are recommended. |
FLIGHT_PRICE |
Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD" |
FORMATTED_PRICE |
Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100" |
FLIGHT_SALE_PRICE |
Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD" |
FORMATTED_SALE_PRICE |
Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80" |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. |
FINAL_URLS |
Data Type: URL_LIST. Required. Final URLs for the ad when using Upgraded URLs. User will be redirected to these URLs when they click on an ad, or when they click on a specific flight for ads that show multiple flights. |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_DESTINATION_IDS |
Data Type: STRING_LIST. List of recommended destination IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
CustomPlaceholderField
Possible values for Custom placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ID |
Data Type: STRING. Required. Combination ID and ID2 must be unique per offer. |
ID2 |
Data Type: STRING. Combination ID and ID2 must be unique per offer. |
ITEM_TITLE |
Data Type: STRING. Required. Main headline with product name to be shown in dynamic ad. |
ITEM_SUBTITLE |
Data Type: STRING. Optional text to be shown in the image ad. |
ITEM_DESCRIPTION |
Data Type: STRING. Optional description of the product to be shown in the ad. |
ITEM_ADDRESS |
Data Type: STRING. Full address of your offer or service, including postal code. This will be used to identify the closest product to the user when there are multiple offers in the feed that are relevant to the user. |
PRICE |
Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD" |
FORMATTED_PRICE |
Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100" |
SALE_PRICE |
Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD" |
FORMATTED_SALE_PRICE |
Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80" |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. Highly recommended for image ads. |
ITEM_CATEGORY |
Data Type: STRING. Used as a recommendation engine signal to serve items in the same category. |
FINAL_URLS |
Data Type: URL_LIST. Final URLs for the ad when using Upgraded URLs. User will be redirected to these URLs when they click on an ad, or when they click on a specific product for ads that have multiple products. |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_IDS |
Data Type: STRING_LIST. List of recommended IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
HotelPlaceholderField
Possible values for Hotel placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PROPERTY_ID |
Data Type: STRING. Required. Unique ID. |
PROPERTY_NAME |
Data Type: STRING. Required. Main headline with property name to be shown in dynamic ad. |
DESTINATION_NAME |
Data Type: STRING. Name of destination to be shown in dynamic ad. |
DESCRIPTION |
Data Type: STRING. Description of destination to be shown in dynamic ad. |
ADDRESS |
Data Type: STRING. Complete property address, including postal code. |
PRICE |
Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD" |
FORMATTED_PRICE |
Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100" |
SALE_PRICE |
Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD" |
FORMATTED_SALE_PRICE |
Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80" |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. |
CATEGORY |
Data Type: STRING. Category of property used to group like items together for recommendation engine. |
STAR_RATING |
Data Type: INT64. Star rating (1 to 5) used to group like items together for recommendation engine. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
FINAL_URLS |
Data Type: URL_LIST. Required. Final URLs for the ad when using Upgraded URLs. User will be redirected to these URLs when they click on an ad, or when they click on a specific flight for ads that show multiple flights. |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_PROPERTY_IDS |
Data Type: STRING_LIST. List of recommended property IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
RealEstatePlaceholderField
Possible values for Real Estate placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LISTING_ID |
Data Type: STRING. Unique ID. |
LISTING_NAME |
Data Type: STRING. Main headline with listing name to be shown in dynamic ad. |
CITY_NAME |
Data Type: STRING. City name to be shown in dynamic ad. |
DESCRIPTION |
Data Type: STRING. Description of listing to be shown in dynamic ad. |
ADDRESS |
Data Type: STRING. Complete listing address, including postal code. |
PRICE |
Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD" |
FORMATTED_PRICE |
Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100" |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. |
PROPERTY_TYPE |
Data Type: STRING. Type of property (house, condo, apartment, etc.) used to group like items together for recommendation engine. |
LISTING_TYPE |
Data Type: STRING. Type of listing (resale, rental, foreclosure, etc.) used to group like items together for recommendation engine. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
FINAL_URLS |
Data Type: URL_LIST. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (for example, the individual URL of a specific listing and its location). |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_LISTING_IDS |
Data Type: STRING_LIST. List of recommended listing IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
TravelPlaceholderField
Possible values for Travel placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DESTINATION_ID |
Data Type: STRING. Required. Destination id. Example: PAR, LON. For feed items that only have destination id, destination id must be a unique key. For feed items that have both destination id and origin id, then the combination must be a unique key. |
ORIGIN_ID |
Data Type: STRING. Origin id. Example: PAR, LON. Combination of DESTINATION_ID and ORIGIN_ID must be unique per offer. |
TITLE |
Data Type: STRING. Required. Main headline with name to be shown in dynamic ad. |
DESTINATION_NAME |
Data Type: STRING. The destination name. Shorter names are recommended. |
ORIGIN_NAME |
Data Type: STRING. Origin name. Shorter names are recommended. |
PRICE |
Data Type: STRING. Price to be shown in the ad. Highly recommended for dynamic ads. Example: "100.00 USD" |
FORMATTED_PRICE |
Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100" |
SALE_PRICE |
Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD" |
FORMATTED_SALE_PRICE |
Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80" |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. |
CATEGORY |
Data Type: STRING. Category of travel offer used to group like items together for recommendation engine. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
DESTINATION_ADDRESS |
Data Type: STRING. Address of travel offer, including postal code. |
FINAL_URL |
Data Type: URL_LIST. Required. Final URLs to be used in ad, when using Upgraded URLs; the more specific the better (for example, the individual URL of a specific travel offer and its location). |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_DESTINATION_IDS |
Data Type: STRING_LIST. List of recommended destination IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
LocalPlaceholderField
Possible values for Local placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
DEAL_ID |
Data Type: STRING. Required. Unique ID. |
DEAL_NAME |
Data Type: STRING. Required. Main headline with local deal title to be shown in dynamic ad. |
SUBTITLE |
Data Type: STRING. Local deal subtitle to be shown in dynamic ad. |
DESCRIPTION |
Data Type: STRING. Description of local deal to be shown in dynamic ad. |
PRICE |
Data Type: STRING. Price to be shown in the ad. Highly recommended for dynamic ads. Example: "100.00 USD" |
FORMATTED_PRICE |
Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100" |
SALE_PRICE |
Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD" |
FORMATTED_SALE_PRICE |
Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80" |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. |
ADDRESS |
Data Type: STRING. Complete property address, including postal code. |
CATEGORY |
Data Type: STRING. Category of local deal used to group like items together for recommendation engine. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
FINAL_URLS |
Data Type: URL_LIST. Required. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (for example, the individual URL of a specific local deal and its location). |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_DEAL_IDS |
Data Type: STRING_LIST. List of recommended local deal IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
JobPlaceholderField
Possible values for Job placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
JOB_ID |
Data Type: STRING. Required. If only JOB_ID is specified, then it must be unique. If both JOB_ID and LOCATION_ID are specified, then the pair must be unique. ID) pair must be unique. |
LOCATION_ID |
Data Type: STRING. Combination of JOB_ID and LOCATION_ID must be unique per offer. |
TITLE |
Data Type: STRING. Required. Main headline with job title to be shown in dynamic ad. |
SUBTITLE |
Data Type: STRING. Job subtitle to be shown in dynamic ad. |
DESCRIPTION |
Data Type: STRING. Description of job to be shown in dynamic ad. |
IMAGE_URL |
Data Type: URL. Image to be displayed in the ad. Highly recommended for image ads. |
CATEGORY |
Data Type: STRING. Category of property used to group like items together for recommendation engine. |
CONTEXTUAL_KEYWORDS |
Data Type: STRING_LIST. Keywords used for product retrieval. |
ADDRESS |
Data Type: STRING. Complete property address, including postal code. |
SALARY |
Data Type: STRING. Salary or salary range of job to be shown in dynamic ad. |
FINAL_URLS |
Data Type: URL_LIST. Required. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (for example, the individual URL of a specific job and its location). |
FINAL_MOBILE_URLS |
Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs. |
TRACKING_URL |
Data Type: URL. Tracking template for the ad when using Upgraded URLs. |
ANDROID_APP_LINK |
Data Type: STRING. Android app link. Must be formatted as: android-app://{package_id}/{scheme}/{host_path}. The components are defined as follows: package_id: app ID as specified in Google Play. scheme: the scheme to pass to the application. Can be HTTP, or a custom scheme. host_path: identifies the specific content within your application. |
SIMILAR_JOB_IDS |
Data Type: STRING_LIST. List of recommended job IDs to show together with this item. |
IOS_APP_LINK |
Data Type: STRING. iOS app link. |
IOS_APP_STORE_ID |
Data Type: INT64. iOS app store ID. |
ImagePlaceholderField
Possible values for Advertiser Provided Image placeholder fields.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ASSET_ID |
Data Type: INT64. The asset ID of the image. |
FeedMappingStatus
Possible statuses of a feed mapping.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Feed mapping is enabled. |
REMOVED |
Feed mapping has been removed. |
FeedMappingCriterionType
Possible placeholder types for a feed mapping.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
LOCATION_EXTENSION_TARGETING |
Allows campaign targeting at locations within a location feed. |
DSA_PAGE_FEED |
Allows url targeting for your dynamic search ads within a page feed. |