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.

FeedItem

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

A feed item.

JSON representation
{
  "resourceName": string,
  "attributeValues": [
    {
      object (FeedItemAttributeValue)
    }
  ],
  "geoTargetingRestriction": enum (GeoTargetingRestriction),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "status": enum (FeedItemStatus),
  "policyInfos": [
    {
      object (FeedItemPlaceholderPolicyInfo)
    }
  ],
  "feed": string,
  "id": string,
  "startDateTime": string,
  "endDateTime": string
}
Fields
resourceName

string

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

customers/{customerId}/feedItems/{feedId}~{feed_item_id}

attributeValues[]

object (FeedItemAttributeValue)

The feed item's attribute values.

geoTargetingRestriction

enum (GeoTargetingRestriction)

Geo targeting restriction specifies the type of location that can be used for targeting.

urlCustomParameters[]

object (CustomParameter)

The list of mappings used to substitute custom parameter tags in a trackingUrlTemplate, finalUrls, or mobile_final_urls.

status

enum (FeedItemStatus)

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

policyInfos[]

object (FeedItemPlaceholderPolicyInfo)

Output only. List of info about a feed item's validation and approval state for active feed mappings. There will be an entry in the list for each type of feed mapping associated with the feed, e.g. a feed with a sitelink and a call feed mapping would cause every feed item associated with that feed to have an entry in this list for both sitelink and call. This field is read-only.

feed

string

Immutable. The feed to which this feed item belongs.

id

string (int64 format)

Output only. The ID of this feed item.

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"

FeedItemAttributeValue

A feed item attribute value.

JSON representation
{
  "priceValue": {
    object (Money)
  },
  "integerValues": [
    string
  ],
  "booleanValues": [
    boolean
  ],
  "stringValues": [
    string
  ],
  "doubleValues": [
    number
  ],
  "feedAttributeId": string,
  "integerValue": string,
  "booleanValue": boolean,
  "stringValue": string,
  "doubleValue": number
}
Fields
priceValue

object (Money)

Price value. Should be set if feedAttributeId refers to a feed attribute of type PRICE.

integerValues[]

string (int64 format)

Repeated int64 value. Should be set if feedAttributeId refers to a feed attribute of type INT64_LIST.

booleanValues[]

boolean

Repeated bool value. Should be set if feedAttributeId refers to a feed attribute of type BOOLEAN_LIST.

stringValues[]

string

Repeated string value. Should be set if feedAttributeId refers to a feed attribute of type STRING_LIST, URL_LIST or DATE_TIME_LIST. For STRING_LIST and URL_LIST the total size of the list in bytes may not exceed 3000. For DATE_TIME_LIST the number of elements may not exceed 200.

For STRING_LIST the maximum length of each string element is 1500 characters. For URL_LIST the maximum length is 2076 characters. For DATE_TIME the format of the string must be the same as start and end time for the feed item.

doubleValues[]

number

Repeated double value. Should be set if feedAttributeId refers to a feed attribute of type DOUBLE_LIST.

feedAttributeId

string (int64 format)

Id of the feed attribute for which the value is associated with.

integerValue

string (int64 format)

Int64 value. Should be set if feedAttributeId refers to a feed attribute of type INT64.

booleanValue

boolean

Bool value. Should be set if feedAttributeId refers to a feed attribute of type BOOLEAN.

stringValue

string

String value. Should be set if feedAttributeId refers to a feed attribute of type STRING, URL or DATE_TIME. For STRING the maximum length is 1500 characters. For URL the maximum length is 2076 characters. For DATE_TIME the string must be in the format "YYYYMMDD HHMMSS".

doubleValue

number

Double value. Should be set if feedAttributeId refers to a feed attribute of type DOUBLE.

GeoTargetingRestriction

A restriction used to determine if the request context's geo should be matched.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LOCATION_OF_PRESENCE Indicates that request context should match the physical location of the user.

FeedItemPlaceholderPolicyInfo

Policy, validation, and quality approval info for a feed item for the specified placeholder type.

JSON representation
{
  "placeholderTypeEnum": enum (PlaceholderType),
  "reviewStatus": enum (PolicyReviewStatus),
  "approvalStatus": enum (PolicyApprovalStatus),
  "policyTopicEntries": [
    {
      object (PolicyTopicEntry)
    }
  ],
  "validationStatus": enum (FeedItemValidationStatus),
  "validationErrors": [
    {
      object (FeedItemValidationError)
    }
  ],
  "qualityApprovalStatus": enum (FeedItemQualityApprovalStatus),
  "qualityDisapprovalReasons": [
    enum (FeedItemQualityDisapprovalReason)
  ],
  "feedMappingResourceName": string
}
Fields
placeholderTypeEnum

enum (PlaceholderType)

Output only. The placeholder type.

reviewStatus

enum (PolicyReviewStatus)

Output only. Where the placeholder type is in the review process.

approvalStatus

enum (PolicyApprovalStatus)

Output only. The overall approval status of the placeholder type, calculated based on the status of its individual policy topic entries.

policyTopicEntries[]

object (PolicyTopicEntry)

Output only. The list of policy findings for the placeholder type.

validationStatus

enum (FeedItemValidationStatus)

Output only. The validation status of the palceholder type.

validationErrors[]

object (FeedItemValidationError)

Output only. List of placeholder type validation errors.

qualityApprovalStatus

enum (FeedItemQualityApprovalStatus)

Output only. Placeholder type quality evaluation approval status.

qualityDisapprovalReasons[]

enum (FeedItemQualityDisapprovalReason)

Output only. List of placeholder type quality evaluation disapproval reasons.

feedMappingResourceName

string

Output only. The FeedMapping that contains the placeholder type.

FeedItemValidationStatus

The possible validation statuses of a feed item.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING Validation pending.
INVALID An error was found.
VALID Feed item is semantically well-formed.

FeedItemValidationError

Stores a validation error and the set of offending feed attributes which together are responsible for causing a feed item validation error.

JSON representation
{
  "validationError": enum (FeedItemValidationError),
  "feedAttributeIds": [
    string
  ],
  "description": string,
  "extraInfo": string
}
Fields
validationError

enum (FeedItemValidationError)

Output only. Error code indicating what validation error was triggered. The description of the error can be found in the 'description' field.

feedAttributeIds[]

string (int64 format)

Output only. Set of feed attributes in the feed item flagged during validation. If empty, no specific feed attributes can be associated with the error (e.g. error across the entire feed item).

description

string

Output only. The description of the validation error.

extraInfo

string

Output only. Any extra information related to this error which is not captured by validationError and feedAttributeId (e.g. placeholder field IDs when feedAttributeId is not mapped). Note that extraInfo is not localized.

FeedItemValidationError

The possible validation errors of a feed item.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STRING_TOO_SHORT String is too short.
STRING_TOO_LONG String is too long.
VALUE_NOT_SPECIFIED Value is not provided.
INVALID_DOMESTIC_PHONE_NUMBER_FORMAT Phone number format is invalid for region.
INVALID_PHONE_NUMBER String does not represent a phone number.
PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY Phone number format is not compatible with country code.
PREMIUM_RATE_NUMBER_NOT_ALLOWED Premium rate number is not allowed.
DISALLOWED_NUMBER_TYPE Phone number type is not allowed.
VALUE_OUT_OF_RANGE Specified value is outside of the valid range.
CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY Call tracking is not supported in the selected country.
CUSTOMER_NOT_IN_ALLOWLIST_FOR_CALLTRACKING Customer is not on the allow-list for call tracking.
INVALID_COUNTRY_CODE Country code is invalid.
INVALID_APP_ID The specified mobile app id is invalid.
MISSING_ATTRIBUTES_FOR_FIELDS Some required field attributes are missing.
INVALID_TYPE_ID Invalid email button type for email extension.
INVALID_EMAIL_ADDRESS Email address is invalid.