Skip to main content

This type is used to provide metadata about each feed file in a getFile or getFiles response.

Type that uses FileMetadata

FileMetadataSearchResponse

Calls that use FileMetadata

GET
/file/{file_id}
GET
/file

Fields

Field
Type
Description
access
AccessEnum
Indicates whether the application is permitted to access the feed file. One of ALLOWED or RESTRICTED.
dimensions
array of Dimension
An array of dimensions supported by the corresponding feed file.

Currently the only dimension available is CATEGORY.

Example:
"dimensionKey": "CATEGORY",
"values": ["15032"]
feedDate
string
The date on which the feed was created.

Format: UTC format (yyyy-MM-ddThh:00:00.000Z).
feedScope
FeedScopeEnum
Specifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).

Currently only DAILY and HOURLY are supported.
feedTypeId
string
The unique identifier of the feed type.

Note: Refer to Supported feed types for additional details.
fileId
string
The file's unique identifier. This fileid is used to select the feed file when using the downloadFile method.
format
FormatEnum
Format of the returned feed file. Currently only TSV is supported.
marketplaceId
MarketplaceIdEnum
The eBay marketplace identifier for the marketplace(s) to which the feed applies.

Example: EBAY_UK.
schemaVersion
string
Version of the API schema under which the feed was created.
size
integer
Size of the feed file in bytes.
span
TimeDuration
The time span between feed files that applies to the feed type (e.g., hourly, daily, weekly).

Possible Values: YEAR, MONTH, DAY, HOUR