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.feeds

Resource: Feed

A feed.

JSON representation
{
  "resourceName": string,
  "attributes": [
    {
      object (FeedAttribute)
    }
  ],
  "attributeOperations": [
    {
      object (FeedAttributeOperation)
    }
  ],
  "origin": enum (FeedOrigin),
  "status": enum (FeedStatus),
  "id": string,
  "name": string,

  // Union field system_feed_generation_data can be only one of the following:
  "placesLocationFeedData": {
    object (PlacesLocationFeedData)
  },
  "affiliateLocationFeedData": {
    object (AffiliateLocationFeedData)
  }
  // End of list of possible types for union field system_feed_generation_data.
}
Fields
resourceName

string

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

customers/{customerId}/feeds/{feedId}

attributes[]

object (FeedAttribute)

The Feed's attributes. Required on CREATE, unless system_feed_generation_data is provided, in which case Google Ads will update the feed with the correct attributes. Disallowed on UPDATE. Use attributeOperations to add new attributes.

attributeOperations[]

object (FeedAttributeOperation)

The list of operations changing the feed attributes. Attributes can only be added, not removed.

origin

enum (FeedOrigin)

Immutable. Specifies who manages the FeedAttributes for the Feed.

status

enum (FeedStatus)

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

id

string (int64 format)

Output only. The ID of the feed. This field is read-only.

name

string

Immutable. Name of the feed. Required.

Union field system_feed_generation_data. The system data for the Feed. This data specifies information for generating the feed items of the system generated feed. system_feed_generation_data can be only one of the following:
placesLocationFeedData

object (PlacesLocationFeedData)

Data used to configure a location feed populated from Google My Business Locations.

affiliateLocationFeedData

object (AffiliateLocationFeedData)

Data used to configure an affiliate location feed populated with the specified chains.

FeedAttribute

FeedAttributes define the types of data expected to be present in a Feed. A single FeedAttribute specifies the expected type of the FeedItemAttributes with the same FeedAttributeId. Optionally, a FeedAttribute can be marked as being part of a FeedItem's unique key.

JSON representation
{
  "type": enum (FeedAttributeType),
  "id": string,
  "name": string,
  "isPartOfKey": boolean
}
Fields
type

enum (FeedAttributeType)

Data type for feed attribute. Required.

id

string (int64 format)

ID of the attribute.

name

string

The name of the attribute. Required.

isPartOfKey

boolean

Indicates that data corresponding to this attribute is part of a FeedItem's unique key. It defaults to false if it is unspecified. Note that a unique key is not required in a Feed's schema, in which case the FeedItems must be referenced by their feed_item_id.

FeedAttributeType

Possible data types for a feed attribute.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INT64 Int64.
DOUBLE Double.
STRING String.
BOOLEAN Boolean.
URL Url.
DATE_TIME Datetime.
INT64_LIST Int64 list.
DOUBLE_LIST Double (8 bytes) list.
STRING_LIST String list.
BOOLEAN_LIST Boolean list.
URL_LIST Url list.
DATE_TIME_LIST Datetime list.
PRICE Price.

FeedAttributeOperation

Operation to be performed on a feed attribute list in a mutate.

JSON representation
{
  "operator": enum (Operator),
  "value": {
    object (FeedAttribute)
  }
}
Fields
operator

enum (Operator)

Output only. Type of list operation to perform.

value

object (FeedAttribute)

Output only. The feed attribute being added to the list.

Operator

The operator.

Enums
UNSPECIFIED Unspecified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADD Add the attribute to the existing attributes.

FeedOrigin

Possible values for a feed origin.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
USER The FeedAttributes for this Feed are managed by the user. Users can add FeedAttributes to this Feed.
GOOGLE The FeedAttributes for an GOOGLE Feed are created by Google. A feed of this type is maintained by Google and will have the correct attributes for the placeholder type of the feed.

FeedStatus

Possible statuses of a feed.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Feed is enabled.
REMOVED Feed has been removed.

PlacesLocationFeedData

Data used to configure a location feed populated from Google My Business Locations.

JSON representation
{
  "oauthInfo": {
    object (OAuthInfo)
  },
  "businessAccountId": string,
  "categoryFilters": [
    string
  ],
  "labelFilters": [
    string
  ],
  "emailAddress": string,
  "businessNameFilter": string
}
Fields
oauthInfo

object (OAuthInfo)

Immutable. Required authentication token (from OAuth API) for the email. This field can only be specified in a create request. All its subfields are not selectable.

businessAccountId

string

Plus page ID of the managed business whose locations should be used. If this field is not set, then all businesses accessible by the user (specified by emailAddress) are used. This field is mutate-only and is not selectable.

categoryFilters[]

string

Used to filter Google My Business listings by categories. If entries exist in categoryFilters, only listings that belong to any of the categories are candidates to be sync'd into FeedItems. If no entries exist in categoryFilters, then all listings are candidates for syncing.

labelFilters[]

string

Used to filter Google My Business listings by labels. If entries exist in labelFilters, only listings that has any of the labels set are candidates to be synchronized into FeedItems. If no entries exist in labelFilters, then all listings are candidates for syncing.

emailAddress

string

Email address of a Google My Business account or email address of a manager of the Google My Business account. Required.

businessNameFilter

string

Used to filter Google My Business listings by business name. If businessNameFilter is set, only listings with a matching business name are candidates to be sync'd into FeedItems.

OAuthInfo

Data used for authorization using OAuth.

JSON representation
{
  "httpMethod": string,
  "httpRequestUrl": string,
  "httpAuthorizationHeader": string
}
Fields
httpMethod

string

The HTTP method used to obtain authorization.

httpRequestUrl

string

The HTTP request URL used to obtain authorization.

httpAuthorizationHeader

string

The HTTP authorization header used to obtain authorization.

AffiliateLocationFeedData

Data used to configure an affiliate location feed populated with the specified chains.

JSON representation
{
  "chainIds": [
    string
  ],
  "relationshipType": enum (AffiliateLocationFeedRelationshipType)
}
Fields
chainIds[]

string (int64 format)

The list of chains that the affiliate location feed will sync the locations from.

relationshipType

enum (AffiliateLocationFeedRelationshipType)

The relationship the chains have with the advertiser.

AffiliateLocationFeedRelationshipType

Possible values for a relationship type for an affiliate location feed.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
GENERAL_RETAILER General retailer relationship.

Methods

get

Returns the requested feed in full detail.

mutate

Creates, updates, or removes feeds.