type PromotionFeedItem (v201809)

Represents a promotion extension.


Namespace
https://adwords.google.com/api/adwords/cm/v201809

Field

ExtensionFeedItem (inherited)

feedId

xsd:long

Id of this feed item's feed.

This field is read only and will be ignored when sent to the API.

feedItemId

xsd:long

Id of the feed item.

status

FeedItem.Status

Status of the feed item.


Enumerations
ENABLED
Feed item is active
REMOVED
Feed item is removed
UNKNOWN
Unknown status

This field is read only and will be ignored when sent to the API.

feedType

Feed.Type

The type of the feed containing this extension feed item data. The field will be set by a subclass with a defined feed type.


Enumerations
NONE
SITELINK
Sitelink placeholder typed
CALL
Call placeholder typed
APP
App placeholder typed
REVIEW
Review placeholder typed
AD_CUSTOMIZER
AdCustomizer placeholder typed
CALLOUT
Callout placeholder typed
STRUCTURED_SNIPPET
Structured snippets placeholder typed
MESSAGE
Message placeholder typed
PRICE
Price placeholder typed
PROMOTION
Promotion placeholder typed

This field is read only and will be ignored when sent to the API.

startTime

xsd:string

Start time in which this feed item is effective and can begin serving. The time zone of startTime must either match the time zone of the account or be unspecified where the time zone defaults to the account time zone. This field may be null to indicate no start time restriction. The special value "00000101 000000" may be used to clear an existing start time.

This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.

endTime

xsd:string

End time in which this feed item is no longer effective and will stop serving. The time zone of endTime must either match the time zone of the account or be unspecified where the time zone defaults to the account time zone. This field may be null to indicate no end time restriction. The special value "00000101 000000" may be used to clear an existing end time.

This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.

devicePreference

FeedItemDevicePreference

Device preference for the feed item.

scheduling

FeedItemScheduling

FeedItemScheduling specifying times for when the feed item may serve. On retrieval or creation of the feed item, if the field is left null, no feed item scheduling restrictions are placed on the feed item. On update, if the field is left unspecified, the previous feedItemScheduling state will not be changed. On update, if the field is set with a FeedItemScheduling with an empty feedItemSchedules list, the scheduling will be cleared of all FeedItemSchedules indicating the feed item has no scheduling restrictions.

campaignTargeting

FeedItemCampaignTargeting

Campaign targeting specifying what campaign this extension can serve with. On update, if the field is left unspecified, the previous campaign targeting state will not be changed. On update, if the field is set with an empty FeedItemCampaignTargeting, the campaign targeting will be cleared. Note: If adGroupTargeting and campaignTargeting are set (either in the request or pre-existing from a previous request), the targeted campaign must match the targeted adgroup's campaign. If only adGroupTargeting is specified and there is no campaignTargeting, then a campaignTargeting will be set to the targeted adgroup's campaign.

adGroupTargeting

FeedItemAdGroupTargeting

Adgroup targeting specifying what adgroup this extension can serve with. On update, if the field is left unspecified, the previous adgroup targeting state will not be changed. On update, if the field is set with an empty FeedItemAdGroupTargeting, the adgroup targeting will be cleared. Note: If adGroupTargeting and campaignTargeting are set (either in the request or pre-existing from a previous request), the targeted campaign must match the targeted adgroup's campaign. If only adGroupTargeting is specified and there is no campaignTargeting, then a campaignTargeting will be set to the targeted adgroup's campaign.

keywordTargeting

Keyword

Keyword targeting specifies what keyword this extension can serve with. On update, if the field is left unspecified, the previous keyword targeting state will not be changed. On update, if the field is set with a Keyword and without Keyword.text set keyword targeting will be cleared.

geoTargeting

Location

Geo targeting specifies what locations this extension can serve with. On update, if the field is left unspecified, the previous geo targeting state will not be changed. On update, if the field is set with a null value for criterionId, the geo targeting will be cleared.

geoTargetingRestriction

FeedItemGeoRestriction

Geo targeting restriction specifies the type of location that can be used for targeting. On update, if the field is left unspecified, the previous geo targeting restriction state will not be changed. On update, if the field is set with a null GeoRestriction enum, the geo targeting restriction will be cleared.

policySummaries

FeedItemPolicySummary[]

Summary of a feed item's offline validation, policy findings, and approval results.

This field is read only and will be ignored when sent to the API.

ExtensionFeedItem.Type

xsd:string

Indicates that this instance is a subtype of ExtensionFeedItem. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

PromotionFeedItem

promotionTarget

xsd:string

Promotion target. Required.

discountModifier

PromotionExtensionDiscountM...

Discount modifier. Optional.


Enumerations
UNKNOWN
UP_TO
/'Up to'/.
NONE
None is used for clearing the discount modifier.

percentOff

xsd:long

Percent off in micros. One million is equivalent to one percent. Either percentOff or moneyAmountOff is required. Cannot set both percentOff and moneyAmountOff.

moneyAmountOff

MoneyWithCurrency

Money amount off. Either percentOff or moneyAmountOff is required. Cannot set both moneyAmountOff and percentOff.

promotionCode

xsd:string

Promotion code. Optional. Cannot set both promotionCode and ordersOverAmount.

ordersOverAmount

MoneyWithCurrency

Orders over amount. Optional. Cannot set both ordersOverAmount and promotionCode.

promotionStart

xsd:string

Promotion start. Optional. The time part must be set to midnight. The special value "00000101 000000" may be used to clear an existing value.

promotionEnd

xsd:string

Promotion end. Optional The time part must be set to midnight. The special value "00000101 000000" may be used to clear an existing value.

occasion

PromotionExtensionOccasion

Occasion of the promotion. Optional.


Enumerations
UNKNOWN
NEW_YEARS
New Year's.
VALENTINES_DAY
Valentine's Day.
EASTER
Easter.
MOTHERS_DAY
Mother's Day.
FATHERS_DAY
Father's Day.
LABOR_DAY
Labor Day.
BACK_TO_SCHOOL
Back To School.
HALLOWEEN
Halloween.
BLACK_FRIDAY
Black Friday.
CYBER_MONDAY
Cyber Monday.
CHRISTMAS
Christmas.
BOXING_DAY
Boxing Day.
NONE
None is used for clearing the occasion.
INDEPENDENCE_DAY
Independence Day.
NATIONAL_DAY
National Day.
END_OF_SEASON
End of Season.
WINTER_SALE
Winter Sale.
SUMMER_SALE
Summer Sale.
FALL_SALE
Fall Sale.
SPRING_SALE
Spring Sale.
RAMADAN
Ramadan.
EID_AL_FITR
Eid al-Fitr.
EID_AL_ADHA
Eid al-Adha.
SINGLES_DAY
Singles Day.
WOMENS_DAY
Women's Day.
HOLI
Holi.
PARENTS_DAY
Parent's Day.
ST_NICHOLAS_DAY
St. Nicholas Day.
CHINESE_NEW_YEAR
Chinese New Year.
CARNIVAL
Carnival.
EPIPHANY
Epiphany.
ROSH_HASHANAH
Rosh Hashanah.
PASSOVER
Passover.
HANUKKAH
Hanukkah.
DIWALI
Diwali.
NAVRATRI
Navratri.
SONGKRAN
Songkran.
YEAR_END_GIFT
Year-end Gift.

finalUrls

UrlList

Final URLs. Required.

finalMobileUrls

UrlList

Final mobile URLs. Optional.

trackingUrlTemplate

xsd:string

Tracking URL template. Optional.

finalUrlSuffix

xsd:string

Final URL suffix to be appended to landing page URLs served with parallel tracking. To clear this field, set its value to the empty string.

promotionUrlCustomParameters

CustomParameters

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

language

xsd:string

The language of the promotion. Optional. The default language is English. Represented as a BCP 47 language tag. Supported language codes:

  • ar
  • bg
  • ca
  • zh-HK
  • zh-CN
  • zh-TW
  • hr
  • cs
  • da
  • nl
  • en-AU
  • en
  • en-GB
  • en-US
  • et
  • fil
  • fi
  • fr
  • de
  • el
  • iw
  • hi
  • hu
  • id
  • it
  • ja
  • ko
  • lv
  • lt
  • ms
  • no
  • pl
  • pt-BR
  • pt-PT
  • ro
  • ru
  • sr
  • sk
  • sl
  • es
  • es-419
  • sv
  • th
  • tr
  • uk
  • vi

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.