- Resource: ExtensionFeedItem
- StructuredSnippetFeedItem
- AppFeedItem
- AppStore
- TextMessageFeedItem
- PriceFeedItem
- PriceExtensionType
- PriceExtensionPriceQualifier
- PriceOffer
- PriceExtensionPriceUnit
- PromotionFeedItem
- LocationFeedItem
- AffiliateLocationFeedItem
- HotelCalloutFeedItem
- ImageFeedItem
- Methods
Resource: ExtensionFeedItem
An extension feed item.
JSON representation | |
---|---|
{ "resourceName": string, "extensionType": enum ( |
Fields | ||
---|---|---|
resourceName |
Immutable. The resource name of the extension feed item. Extension feed item resource names have the form:
|
|
extensionType |
Output only. The extension type of the extension feed item. This field is read-only. |
|
adSchedules[] |
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. |
|
device |
The targeted device. |
|
targetedKeyword |
The targeted keyword. |
|
status |
Output only. Status of the feed item. This field is read-only. |
|
id |
Output only. The ID of this feed item. Read-only. |
|
startDateTime |
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" |
|
endDateTime |
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" |
|
targetedGeoTargetConstant |
The targeted geo target constant. |
|
Union field extension . Extension type. extension can be only one of the following: |
||
sitelinkFeedItem |
Sitelink extension. |
|
structuredSnippetFeedItem |
Structured snippet extension. |
|
appFeedItem |
App extension. |
|
callFeedItem |
Call extension. |
|
calloutFeedItem |
Callout extension. |
|
textMessageFeedItem |
Text message extension. |
|
priceFeedItem |
Price extension. |
|
promotionFeedItem |
Promotion extension. |
|
locationFeedItem |
Output only. Location extension. Locations are synced from a Business Profile into a feed. This field is read-only. |
|
affiliateLocationFeedItem |
Output only. Affiliate location extension. Feed locations are populated by Google Ads based on a chain ID. This field is read-only. |
|
hotelCalloutFeedItem |
Hotel Callout extension. |
|
imageFeedItem |
Immutable. Advertiser provided image extension. |
|
Union field serving_resource_targeting . Targeting at either the campaign or ad group level. Feed items that target a campaign or ad group will only serve with that resource. serving_resource_targeting can be only one of the following: |
||
targetedCampaign |
The targeted campaign. |
|
targetedAdGroup |
The targeted ad group. |
StructuredSnippetFeedItem
Represents a structured snippet extension.
JSON representation | |
---|---|
{ "values": [ string ], "header": string } |
Fields | |
---|---|
values[] |
The values in the snippet. The maximum size of this collection is 10. |
header |
The header of the snippet. This string must not be empty. |
AppFeedItem
Represents an App extension.
JSON representation | |
---|---|
{ "appStore": enum ( |
Fields | |
---|---|
appStore |
The application store that the target application belongs to. This field is required. |
finalUrls[] |
A list of possible final URLs after all cross domain redirects. This list must not be empty. |
finalMobileUrls[] |
A list of possible final mobile URLs after all cross domain redirects. |
urlCustomParameters[] |
A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. |
linkText |
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. |
appId |
The store-specific ID for the target application. This string must not be empty. |
trackingUrlTemplate |
URL template for constructing a tracking URL. Default value is "{lpurl}". |
finalUrlSuffix |
URL template for appending params to landing page URLs served with parallel tracking. |
AppStore
App store type in an app extension.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
APPLE_ITUNES |
Apple iTunes. |
GOOGLE_PLAY |
Google Play. |
TextMessageFeedItem
An extension that users can click on to send a text message to the advertiser.
JSON representation | |
---|---|
{ "businessName": string, "countryCode": string, "phoneNumber": string, "text": string, "extensionText": string } |
Fields | |
---|---|
businessName |
The business name to prepend to the message text. This field is required. |
countryCode |
Uppercase two-letter country code of the advertiser's phone number. This field is required. |
phoneNumber |
The advertiser's phone number the message will be sent to. Required. |
text |
The text to show in the ad. This field is required. |
extensionText |
The message extensionText populated in the messaging app. |
PriceFeedItem
Represents a Price extension.
JSON representation | |
---|---|
{ "type": enum ( |
Fields | |
---|---|
type |
Price extension type of this extension. |
priceQualifier |
Price qualifier for all offers of this price extension. |
priceOfferings[] |
The price offerings in this price extension. |
trackingUrlTemplate |
Tracking URL template for all offers of this price extension. |
languageCode |
The code of the language used for this price extension. |
finalUrlSuffix |
Tracking URL template for all offers of this price extension. |
PriceExtensionType
Price extension type.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
BRANDS |
The type for showing a list of brands. |
EVENTS |
The type for showing a list of events. |
LOCATIONS |
The type for showing locations relevant to your business. |
NEIGHBORHOODS |
The type for showing sub-regions or districts within a city or region. |
PRODUCT_CATEGORIES |
The type for showing a collection of product categories. |
PRODUCT_TIERS |
The type for showing a collection of related product tiers. |
SERVICES |
The type for showing a collection of services offered by your business. |
SERVICE_CATEGORIES |
The type for showing a collection of service categories. |
SERVICE_TIERS |
The type for showing a collection of related service tiers. |
PriceExtensionPriceQualifier
Enums of price extension price qualifier.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
FROM |
'From' qualifier for the price. |
UP_TO |
'Up to' qualifier for the price. |
AVERAGE |
'Average' qualifier for the price. |
PriceOffer
Represents one price offer in a price extension.
JSON representation | |
---|---|
{ "price": { object ( |
Fields | |
---|---|
price |
Price value of this offer. |
unit |
Price unit for this offer. |
finalUrls[] |
A list of possible final URLs after all cross domain redirects. |
finalMobileUrls[] |
A list of possible final mobile URLs after all cross domain redirects. |
header |
Header text of this offer. |
description |
Description text of this offer. |
PriceExtensionPriceUnit
Price extension price unit.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
PER_HOUR |
Per hour. |
PER_DAY |
Per day. |
PER_WEEK |
Per week. |
PER_MONTH |
Per month. |
PER_YEAR |
Per year. |
PER_NIGHT |
Per night. |
PromotionFeedItem
Represents a Promotion extension.
JSON representation | |
---|---|
{ "discountModifier": enum ( |
Fields | ||
---|---|---|
discountModifier |
Enum that modifies the qualification of the discount. |
|
occasion |
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. |
|
finalUrls[] |
A list of possible final URLs after all cross domain redirects. This field is required. |
|
finalMobileUrls[] |
A list of possible final mobile URLs after all cross domain redirects. |
|
urlCustomParameters[] |
A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. |
|
promotionTarget |
A freeform description of what the promotion is targeting. This field is required. |
|
promotionStartDate |
Start date of when the promotion is eligible to be redeemed. |
|
promotionEndDate |
Last date when the promotion is eligible to be redeemed. |
|
trackingUrlTemplate |
URL template for constructing a tracking URL. |
|
finalUrlSuffix |
URL template for appending params to landing page URLs served with parallel tracking. |
|
languageCode |
The language of the promotion. Represented as BCP 47 language tag. |
|
Union field discount_type . Discount type, can be percentage off or amount off. discount_type can be only one of the following: |
||
percentOff |
Percentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required. |
|
moneyAmountOff |
Money amount off for discount in the promotion. Either this or percentOff is required. |
|
Union field promotion_trigger . Promotion trigger. Can be by promotion code or promo by eligible order amount. promotion_trigger can be only one of the following: |
||
promotionCode |
A code the user should use in order to be eligible for the promotion. |
|
ordersOverAmount |
The amount the total order needs to be for the user to be eligible for the promotion. |
LocationFeedItem
Represents a location extension.
JSON representation | |
---|---|
{ "businessName": string, "addressLine1": string, "addressLine2": string, "city": string, "province": string, "postalCode": string, "countryCode": string, "phoneNumber": string } |
Fields | |
---|---|
businessName |
The name of the business. |
addressLine1 |
Line 1 of the business address. |
addressLine2 |
Line 2 of the business address. |
city |
City of the business address. |
province |
Province of the business address. |
postalCode |
Postal code of the business address. |
countryCode |
Country code of the business address. |
phoneNumber |
Phone number of the business. |
AffiliateLocationFeedItem
Represents an affiliate location extension.
JSON representation | |
---|---|
{ "businessName": string, "addressLine1": string, "addressLine2": string, "city": string, "province": string, "postalCode": string, "countryCode": string, "phoneNumber": string, "chainId": string, "chainName": string } |
Fields | |
---|---|
businessName |
The name of the business. |
addressLine1 |
Line 1 of the business address. |
addressLine2 |
Line 2 of the business address. |
city |
City of the business address. |
province |
Province of the business address. |
postalCode |
Postal code of the business address. |
countryCode |
Country code of the business address. |
phoneNumber |
Phone number of the business. |
chainId |
Id of the retail chain that is advertised as a seller of your product. |
chainName |
Name of chain. |
HotelCalloutFeedItem
Represents a hotel callout extension.
JSON representation | |
---|---|
{ "text": string, "languageCode": string } |
Fields | |
---|---|
text |
The callout text. The length of this string should be between 1 and 25, inclusive. |
languageCode |
The language of the hotel callout text. IETF BCP 47 compliant language code. |
ImageFeedItem
Represents an advertiser provided image extension.
JSON representation | |
---|---|
{ "imageAsset": string } |
Fields | |
---|---|
imageAsset |
Required. Resource name of the image asset. |
Methods |
|
---|---|
|
Returns the requested extension feed item in full detail. |
|
Creates, updates, or removes extension feed items. |