FeedStatus

  • FeedStatus reflects the processing status of a feed uploaded by an aggregator's platform, including merchants, services, or availability.

  • It provides information on the feed's state (e.g., processing, succeeded, failed), errors encountered, and overall statistics.

  • FeedStatistics offers a breakdown of the impact of the feed, showing the number of new, updated, and removed items.

  • The feed resource is identified by a unique name in the format of partners/{partner_id}/feeds/{feed_type}/{fileName}.

Status of a feed uploaded by the aggregator's platform.

JSON representation
{
  "name": string,
  "state": enum (State),
  "errorDetails": string,
  "statistics": {
    object (FeedStatistics)
  }
}
Fields
name

string

The feed resource name, which has the format of

  • partners/{partner_id}/feeds/merchants/{fileName}
  • partners/{partner_id}/feeds/services/{fileName}
  • partners/{partner_id}/feeds/availability/{fileName}
state

enum (State)

The processing state of this feed.

errorDetails

string

Human readable string providing more details if we failed to process this feed.

statistics

object (FeedStatistics)

Statistics specific to this feed.

FeedStatistics

Statistics obtained while processing an uploaded feed.

JSON representation
{
  "newItems": string,
  "existingItems": string,
  "deletedItems": string
}
Fields
newItems

string (int64 format)

Newly added items by this feed. Items can be merchants, services or availability slots, depending on the type of the feed.

existingItems

string (int64 format)

Existing items, updated as needed from newer information from the feed.

deletedItems

string (int64 format)

Items no longer present in this feed, and that were removed as a result.