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

Resource: FeedItemSet

Represents a set of feed items. The set can be used and shared among certain feed item features. For instance, the set can be referenced within the matching functions of CustomerFeed, CampaignFeed, and AdGroupFeed.

JSON representation
{
  "resourceName": string,
  "feed": string,
  "feedItemSetId": string,
  "displayName": string,
  "status": enum (FeedItemSetStatus),

  // Union field dynamic_set_filter can be only one of the following:
  "dynamicLocationSetFilter": {
    object (DynamicLocationSetFilter)
  },
  "dynamicAffiliateLocationSetFilter": {
    object (DynamicAffiliateLocationSetFilter)
  }
  // End of list of possible types for union field dynamic_set_filter.
}
Fields
resourceName

string

Immutable. The resource name of the feed item set. Feed item set resource names have the form: customers/{customerId}/feedItemSets/{feedId}~{feedItemSetId}

feed

string

Immutable. The resource name of the feed containing the feed items in the set. Immutable. Required.

feedItemSetId

string (int64 format)

Output only. ID of the set.

displayName

string

Name of the set. Must be unique within the account.

status

enum (FeedItemSetStatus)

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

Union field dynamic_set_filter. Represents a filter on locations in a feed item set. Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed. dynamic_set_filter can be only one of the following:
dynamicLocationSetFilter

object (DynamicLocationSetFilter)

Filter for dynamic location set. It is only used for sets of locations.

dynamicAffiliateLocationSetFilter

object (DynamicAffiliateLocationSetFilter)

Filter for dynamic affiliate location set. This field doesn't apply generally to feed item sets. It is only used for sets of affiliate locations.

FeedItemSetStatus

Possible statuses of a feed item set.

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

DynamicLocationSetFilter

Represents a filter on locations in a feed item set. Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed.

JSON representation
{
  "labels": [
    string
  ],
  "businessNameFilter": {
    object (BusinessNameFilter)
  }
}
Fields
labels[]

string

If multiple labels are set, then only feeditems marked with all the labels will be added to the FeedItemSet.

businessNameFilter

object (BusinessNameFilter)

Business name filter.

BusinessNameFilter

Represents a business name filter on locations in a FeedItemSet.

JSON representation
{
  "businessName": string,
  "filterType": enum (FeedItemSetStringFilterType)
}
Fields
businessName

string

Business name string to use for filtering.

filterType

enum (FeedItemSetStringFilterType)

The type of string matching to use when filtering with businessName.

FeedItemSetStringFilterType

describe the possible types for a FeedItemSetStringFilter.

Enums
UNSPECIFIED Not specified.
UNKNOWN The received error code is not known in this version.
EXACT The dynamic set filter will use exact string matching.

DynamicAffiliateLocationSetFilter

Represents a filter on affiliate locations in a FeedItemSet. Only applicable if the parent Feed of the FeedItemSet is an AFFILIATE_LOCATION feed.

JSON representation
{
  "chainIds": [
    string
  ]
}
Fields
chainIds[]

string (int64 format)

Used to filter affiliate locations by chain ids. Only affiliate locations that belong to the specified chain(s) will be added to the FeedItemSet.

Methods

get

Returns the requested feed item set in full detail.

mutate

Creates, updates or removes feed item sets.