Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.extensionFeedItems

Resource: ExtensionFeedItem

An extension feed item.

JSON representation
{
  "resourceName": string,
  "extensionType": enum (ExtensionType),
  "adSchedules": [
    {
      object (AdScheduleInfo)
    }
  ],
  "device": enum (FeedItemTargetDevice),
  "targetedKeyword": {
    object (KeywordInfo)
  },
  "status": enum (FeedItemStatus),
  "id": string,
  "startDateTime": string,
  "endDateTime": string,
  "targetedGeoTargetConstant": string,

  // Union field extension can be only one of the following:
  "sitelinkFeedItem": {
    object (SitelinkFeedItem)
  },
  "structuredSnippetFeedItem": {
    object (StructuredSnippetFeedItem)
  },
  "appFeedItem": {
    object (AppFeedItem)
  },
  "callFeedItem": {
    object (CallFeedItem)
  },
  "calloutFeedItem": {
    object (CalloutFeedItem)
  },
  "textMessageFeedItem": {
    object (TextMessageFeedItem)
  },
  "priceFeedItem": {
    object (PriceFeedItem)
  },
  "promotionFeedItem": {
    object (PromotionFeedItem)
  },
  "locationFeedItem": {
    object (LocationFeedItem)
  },
  "affiliateLocationFeedItem": {
    object (AffiliateLocationFeedItem)
  },
  "hotelCalloutFeedItem": {
    object (HotelCalloutFeedItem)
  },
  "imageFeedItem": {
    object (ImageFeedItem)
  }
  // End of list of possible types for union field extension.

  // Union field serving_resource_targeting can be only one of the following:
  "targetedCampaign": string,
  "targetedAdGroup": string
  // End of list of possible types for union field serving_resource_targeting.
}
Fields
resourceName

string

Immutable. The resource name of the extension feed item. Extension feed item resource names have the form:

customers/{customerId}/extensionFeedItems/{feed_item_id}

extensionType

enum (ExtensionType)

Output only. The extension type of the extension feed item. This field is read-only.

adSchedules[]

object (AdScheduleInfo)

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

enum (FeedItemTargetDevice)

The targeted device.

targetedKeyword

object (KeywordInfo)

The targeted keyword.

status

enum (FeedItemStatus)

Output only. Status of the feed item. This field is read-only.

id

string (int64 format)

Output only. The ID of this feed item. Read-only.

startDateTime

string

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

string

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

string

The targeted geo target constant.

Union field extension. Extension type. extension can be only one of the following:
structuredSnippetFeedItem

object (StructuredSnippetFeedItem)

Structured snippet extension.

appFeedItem

object (AppFeedItem)

App extension.

callFeedItem

object (CallFeedItem)

Call extension.

calloutFeedItem

object (CalloutFeedItem)

Callout extension.

textMessageFeedItem

object (TextMessageFeedItem)

Text message extension.

priceFeedItem

object (PriceFeedItem)

Price extension.

promotionFeedItem

object (PromotionFeedItem)

Promotion extension.

locationFeedItem

object (LocationFeedItem)

Output only. Location extension. Locations are synced from a GMB account into a feed. This field is read-only.

affiliateLocationFeedItem

object (AffiliateLocationFeedItem)

Output only. Affiliate location extension. Feed locations are populated by Google Ads based on a chain ID. This field is read-only.

hotelCalloutFeedItem

object (HotelCalloutFeedItem)

Hotel Callout extension.

imageFeedItem

object (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

string

The targeted campaign.

targetedAdGroup

string

The targeted ad group.

StructuredSnippetFeedItem

Represents a structured snippet extension.

JSON representation
{
  "values": [
    string
  ],
  "header": string
}
Fields
values[]

string

The values in the snippet. The maximum size of this collection is 10.

header

string

The header of the snippet. This string must not be empty.

AppFeedItem

Represents an App extension.

JSON representation
{
  "appStore": enum (AppStore),
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "linkText": string,
  "appId": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string
}
Fields
appStore

enum (AppStore)

The application store that the target application belongs to. This field is required.

finalUrls[]

string

A list of possible final URLs after all cross domain redirects. This list must not be empty.

finalMobileUrls[]

string

A list of possible final mobile URLs after all cross domain redirects.

urlCustomParameters[]

object (CustomParameter)

A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.

appId

string

The store-specific ID for the target application. This string must not be empty.

trackingUrlTemplate

string

URL template for constructing a tracking URL. Default value is "{lpurl}".

finalUrlSuffix

string

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

string

The business name to prepend to the message text. This field is required.

countryCode

string

Uppercase two-letter country code of the advertiser's phone number. This field is required.

phoneNumber

string

The advertiser's phone number the message will be sent to. Required.

text

string

The text to show in the ad. This field is required.

extensionText

string

The message extensionText populated in the messaging app.

PriceFeedItem

Represents a Price extension.

JSON representation
{
  "type": enum (PriceExtensionType),
  "priceQualifier": enum (PriceExtensionPriceQualifier),
  "priceOfferings": [
    {
      object (PriceOffer)
    }
  ],
  "trackingUrlTemplate": string,
  "languageCode": string,
  "finalUrlSuffix": string
}
Fields
type

enum (PriceExtensionType)

Price extension type of this extension.

priceQualifier

enum (PriceExtensionPriceQualifier)

Price qualifier for all offers of this price extension.

priceOfferings[]

object (PriceOffer)

The price offerings in this price extension.

trackingUrlTemplate

string

Tracking URL template for all offers of this price extension.

languageCode

string

The code of the language used for this price extension.

finalUrlSuffix

string

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 (Money)
  },
  "unit": enum (PriceExtensionPriceUnit),
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "header": string,
  "description": string
}
Fields
price

object (Money)

Price value of this offer.

unit

enum (PriceExtensionPriceUnit)

Price unit for this offer.

finalUrls[]

string

A list of possible final URLs after all cross domain redirects.

finalMobileUrls[]

string

A list of possible final mobile URLs after all cross domain redirects.

header

string

Header text of this offer.

description

string

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 (PromotionExtensionDiscountModifier),
  "occasion": enum (PromotionExtensionOccasion),
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "promotionTarget": string,
  "promotionStartDate": string,
  "promotionEndDate": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string,
  "languageCode": string,

  // Union field discount_type can be only one of the following:
  "percentOff": string,
  "moneyAmountOff": {
    object (Money)
  }
  // End of list of possible types for union field discount_type.

  // Union field promotion_trigger can be only one of the following:
  "promotionCode": string,
  "ordersOverAmount": {
    object (Money)
  }
  // End of list of possible types for union field promotion_trigger.
}
Fields
discountModifier

enum (PromotionExtensionDiscountModifier)

Enum that modifies the qualification of the discount.

occasion

enum (PromotionExtensionOccasion)

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[]

string

A list of possible final URLs after all cross domain redirects. This field is required.

finalMobileUrls[]

string

A list of possible final mobile URLs after all cross domain redirects.

urlCustomParameters[]

object (CustomParameter)

A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.

promotionTarget

string

A freeform description of what the promotion is targeting. This field is required.

promotionStartDate

string

Start date of when the promotion is eligible to be redeemed.

promotionEndDate

string

Last date when the promotion is eligible to be redeemed.

trackingUrlTemplate

string

URL template for constructing a tracking URL.

finalUrlSuffix

string

URL template for appending params to landing page URLs served with parallel tracking.

languageCode

string

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

string (int64 format)

Percentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required.

moneyAmountOff

object (Money)

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

string

A code the user should use in order to be eligible for the promotion.

ordersOverAmount

object (Money)

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

string

The name of the business.

addressLine1

string

Line 1 of the business address.

addressLine2

string

Line 2 of the business address.

city

string

City of the business address.

province

string

Province of the business address.

postalCode

string

Postal code of the business address.

countryCode

string

Country code of the business address.

phoneNumber

string

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

string

The name of the business.

addressLine1

string

Line 1 of the business address.

addressLine2

string

Line 2 of the business address.

city

string

City of the business address.

province

string

Province of the business address.

postalCode

string

Postal code of the business address.

countryCode

string

Country code of the business address.

phoneNumber

string

Phone number of the business.

chainId

string (int64 format)

Id of the retail chain that is advertised as a seller of your product.

chainName

string

Name of chain.

HotelCalloutFeedItem

Represents a hotel callout extension.

JSON representation
{
  "text": string,
  "languageCode": string
}
Fields
text

string

The callout text. The length of this string should be between 1 and 25, inclusive.

languageCode

string

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

string

Required. Resource name of the image asset.

Methods

get

Returns the requested extension feed item in full detail.

mutate

Creates, updates, or removes extension feed items.