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.

ExtensionFeedItem

Stay organized with collections Save and categorize content based on your preferences.

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 Business Profile 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