type SitelinkFeedItem (v201809)

Represents a sitelink 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.

SitelinkFeedItem

sitelinkText

xsd:string

URL display text for the sitelink.

The length of this string should be between 1 and 25, inclusive, (trimmed).

sitelinkUrl

xsd:string

Destination URL for the sitelink.

The length of this string should be between 0 and 2076, inclusive, (trimmed).

sitelinkLine2

xsd:string

First line of the description for the sitelink. To clear this field, set its value to the empty string. If this value is set, sitelinkLine3 must also be set.

The length of this string should be between 0 and 35, inclusive, (trimmed).

sitelinkLine3

xsd:string

Second line of the description for the sitelink. To clear this field, set its value to the empty string. If this value is set, sitelinkLine2 must also be set.

The length of this string should be between 0 and 35, inclusive, (trimmed).

sitelinkFinalUrls

UrlList

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

sitelinkFinalMobileUrls

UrlList

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

sitelinkTrackingUrlTemplate

xsd:string

URL template for constructing a tracking URL. To clear this field, set its value to the empty string.

sitelinkFinalUrlSuffix

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.

sitelinkUrlCustomParameters

CustomParameters

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

Send feedback about...

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