Types

Index

AmenityFeature

The amenity features for the property.

Enums
AMENITY_FEATURE_UNSPECIFIED Unspecified amenity feature.
BALCONY Balcony.
BASEMENT Basement.
BASKETBALL_COURT Basketball court.
BIKE_STORAGE Bike storage.
CENTRAL_AC Central air conditioning.
DISHWASHER Dishwasher.
DOG_PARK Dog park.
ELEVATOR Elevator.
EV_CHARGING EV charging.
FENCED_LOT Fenced lot.
FIREPLACE Fireplace.
FITNESS_CENTER Fitness center.
FORCED_AIR_HEATING Forced air heating.
FULLY_FURNISHED Fully furnished.
GARAGE Garage.
GATED_COMMUNITY Gated community.
HARDWOOD_FLOORS Hardwood floors.
HIGH_SPEED_INTERNET High speed internet.
INTERCOM Intercom.
IN_UNIT_WASHER_DRYER In-unit washer and dryer.
KITCHEN Kitchen.
LARGE_CLOSETS Large closets.
MULTISPORT_COURT Multisport court.
ONSITE_LAUNDRY Onsite laundry.
OUTDOOR_LOUNGE Outdoor lounge.
PARKING Parking.
PATIO Patio.
PICKLEBALL_COURT Pickleball court.
POOL Pool.
REFRIGERATOR Refrigerator.
SOCCER_FIELD Soccer field.
TENNIS_COURT Tennis court.
WALK_IN_CLOSETS Walk-in closets.
WHEELCHAIR_ACCESS Wheelchair accessibility.

CarrierPriceOption

Possible carrier where price is coming from.

Enums
CARRIER_PRICE_OPTION_UNSPECIFIED Carrier price option is unspecified.
AUSTRALIA_POST_REGULAR Australia Post Regular shipping service.
AUSTRALIA_POST_EXPRESS Australia Post Express shipping service.
AUSTRALIA_POST_REGULAR_S Australia Post Regular Small shipping service.
AUSTRALIA_POST_REGULAR_M Australia Post Regular Medium shipping service.
AUSTRALIA_POST_REGULAR_L Australia Post Regular Large shipping service.
AUSTRALIA_POST_REGULAR_XL Australia Post Regular XL shipping service.
AUSTRALIA_POST_EXPRESS_S Australia Post Express Small shipping service.
AUSTRALIA_POST_EXPRESS_M Australia Post Express Medium shipping service.
AUSTRALIA_POST_EXPRESS_L Australia Post Express Large shipping service.
AUSTRALIA_POST_EXPRESS_XL Australia Post Express XL shipping service.
TNT_ROAD_EXPRESS TNT Road Express shipping service.
TNT_OVERNIGHT_EXPRESS TNT Overnight Express shipping service.
TOLL_ROAD_DELIVERY Toll Road Delivery shipping service.
TOLL_OVERNIGHT_PRIORITY Toll Overnight Priority shipping service.
DHL_PAKET DHL Paket shipping service.
DHL_PACKCHEN DHL Packchen shipping service.
DPD_EXPRESS_12 DPD Express 12 shipping service.
DPD_EXPRESS DPD Express shipping service.
DPD_CLASSIC_PARCEL DPD Classic Parcel shipping service.
HERMES_PACKCHEN Hermes Packchen shipping service.
HERMES_PAKETKLASSE_S Hermes Paketklasse S shipping service.
HERMES_PAKETKLASSE_M Hermes Paketklasse M shipping service.
HERMES_PAKETKLASSE_L Hermes Paketklasse L shipping service.
UPS_EXPRESS UPS Express shipping service.
UPS_EXPRESS_SAVER UPS Express Saver shipping service.
UPS_EXPRESS_STANDARD UPS Express Standard shipping service.
DHL_EXPRESS DHL Express shipping service.
DHL_EXPRESS_12 DHL Express 12 shipping service.
DPD_NEXT_DAY DPD Next Day shipping service.
DPD_STANDARD_NEXT_DAY DPD Standard Next Day shipping service.
DPD_STANDARD_TWO_DAY DPD Standard Two Day shipping service.
RMG_1ST_CLASS_SMALL RMG 1st Class Small shipping service.
RMG_1ST_CLASS_MEDIUM RMG 1st Class Medium shipping service.
RMG_2ND_CLASS_SMALL RMG 2nd Class Small shipping service.
RMG_2ND_CLASS_MEDIUM RMG 2nd Class Medium shipping service.
TNT_EXPRESS TNT Express shipping service.
TNT_EXPRESS_10 TNT Express 10 shipping service.
TNT_EXPRESS_12 TNT Express 12 shipping service.
YODEL_B2C_48HR Yodel B2C 48HR shipping service.
YODEL_B2C_72HR Yodel B2C 72HR shipping service.
YODEL_B2C_PACKET Yodel B2C Packet shipping service.
FEDEX_GROUND FedEx Ground shipping service.
FEDEX_HOME_DELIVERY FedEx Home Delivery shipping service.
FEDEX_EXPRESS_SAVER FedEx Express Saver shipping service.
FEDEX_FIRST_OVERNIGHT FedEx First Overnight shipping service.
FEDEX_PRIORITY_OVERNIGHT FedEx Priority Overnight shipping service.
FEDEX_STANDARD_OVERNIGHT FedEx Standard Overnight shipping service.
FEDEX_2DAY FedEx 2Day shipping service.
UPS_STANDARD UPS Standard shipping service.
UPS_2ND_DAY_AIR UPS 2nd Day Air shipping service.
UPS_2ND_DAY_AM UPS 2nd Day AM shipping service.
UPS_3_DAY_SELECT UPS 3 Day Select shipping service.
UPS_GROUND UPS Ground shipping service.
UPS_NEXT_DAY_AIR UPS Next Day Air shipping service.
UPS_NEXT_DAY_AIR_EARLY_AM UPS Next Day Air Early AM shipping service.
UPS_NEXT_DAY_AIR_SAVER UPS Next Day Air Saver shipping service.
USPS_PRIORITY_MAIL_EXPRESS USPS Priority Mail Express shipping service.
USPS_MEDIA_MAIL USPS Media Mail shipping service.
USPS_GROUND_ADVANTAGE_RETAIL USPS Ground Advantage Retail shipping service.
USPS_PRIORITY_MAIL USPS Priority Mail shipping service.
USPS_GROUND_ADVANTAGE_COMMERCIAL USPS Ground Advantage Commercial shipping service.

CarrierShipping

Carrier-based shipping configuration. Allows for setting shipping speed or shipping cost based on a carrier's provided info.

Fields
country

string

The CLDR territory code of the country to which an item will ship.

region

string

The geographic region to which a shipping rate applies. See region for more information.

postal_code

string

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94*), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94*-98*).

origin_postal_code

string

The source location postal code from which this offer ships. Represented only by a full-length postal code.

flat_price

Price

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

carrier_price

CarrierPriceOption

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

carrier_price_flat_adjustment

Price

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

carrier_price_percentage_adjustment

double

A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPriceFlatAdjustment.

min_handling_time

int64

Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be set if maxHandlingTime is also set.

max_handling_time

int64

Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and fixedMaxTransitTime or carrierTransitTime are required if providing shipping speeds.

fixed_min_transit_time

int64

Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. fixedMinTransitTime can only be set if fixedMaxTransitTime is set. Cannot be set if carrierTransitTime is present.

fixed_max_transit_time

int64

Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Needs to be provided together with maxHandlingTime. Cannot be set if carrierTransitTime is present.

carrier_transit_time

CarrierTransitTimeOption

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

Co2Emissions

The co2 emission of the vehicle.

Fields
unit

Unit

The unit of the co2 emission.

value

int64

The co2 emission value.

Unit

The unit of the co2 emission.

Enums
UNIT_UNSPECIFIED Unspecified unit.
GPERKM Grams per kilometer.

DisplayAddress

The display address of the property.

Fields
street_number

string

The street number.

street_name

string

The street name.

city

string

The city such as Seattle, New York, etc.

region

string

The region(state), such as WA, OH, etc.

postal_code

string

The postal code, such as 94043.

EmissionsStandard

The emission standard of the vehicle.

Enums
EMISSIONS_STANDARD_UNSPECIFIED Unspecified emission standard.
ZERO_EMISSIONS Zero emissions.
EURO1 Euro 1.
EURO2 Euro 2.
EURO3 Euro 3.
EURO4 Euro 4.
EURO5 Euro 5.
EURO5B Euro 5b.
EURO6 Euro 6.
EURO6C Euro 6c.
EURO6D Euro 6d.
EURO6D_TEMP Euro 6d-TEMP.
EURO6E Euro 6e.

EnergyConsumption

The energy consumption of the vehicle.

Fields
unit

Unit

The unit of the energy consumption.

value

double

The energy consumption value.

Unit

The unit of the energy consumption.

Enums
UNIT_UNSPECIFIED Unspecified unit.
KWHPER100KM Kilowatt hours per 100 kilometers.

EngineType

The engine type of the vehicle.

Enums
ENGINE_TYPE_UNSPECIFIED Unspecified engine type.
GASOLINE Gasoline.
DIESEL Diesel.
ELECTRIC Electric.
HYBRID Hybrid.
PLUG_IN_HYBRID Plug-in hybrid.
NATURAL_GAS Natural gas.
LPG LPG.
METHANE Methane.
OTHER Other.

FuelConsumption

The fuel consumption of the vehicle.

Fields
unit

Unit

The unit of the fuel consumption.

value

double

The fuel consumption value.

Unit

The unit of the fuel consumption.

Enums
UNIT_UNSPECIFIED Unspecified unit.
LPER100KM Liter per 100 kilometers.
KGPER100KM Kilograms per 100 kilometers.

LeaseTerm

The lease term of the property.

Fields
type

LeaseTermType

The type of lease term.

duration_unit

DurationUnit

The duration unit of the lease term.

duration_value

int64

The duration value of the lease term.

DurationUnit

The unit of duration.

Enums
DURATION_UNIT_UNSPECIFIED Unspecified duration unit.
MONTHS Month.
WEEKS Week.

LeaseTermType

The type of lease term.

Enums
LEASE_TERM_TYPE_UNSPECIFIED Unspecified lease term type.
FIXED_TERM Fixed term.

Mileage

The mileage of the vehicle.

Fields
unit

Unit

The unit of the mileage.

value

int64

The distance value.

Unit

The unit of the mileage.

Enums
UNIT_UNSPECIFIED Unspecified unit.
MILES Miles.
KM Kilometers.

PetPolicy

The pet policy of the property.

Fields
pets_allowed

bool

Whether pets are allowed.

pet_types[]

PetType

The pet types allowed.

PetType

The pet types.

Enums
PET_TYPE_UNSPECIFIED Unspecified pet type.
CATS Cats.
LARGE_DOGS Large dogs.
SMALL_DOGS Small dogs.

ProductFee

The product fee attribute containing type and amount.

Fields
type

FeeType

The type of product fee.

amount

Price

The amount of product fee.

FeeType

The type of product fee.

Enums
FEE_TYPE_UNSPECIFIED Unspecified fee type.
ADMIN_FEE Admin fee.
APPLICATION_FEE Application fee.
SECURITY_DEPOSIT Security deposit.

PropertyType

The property type.

Enums
PROPERTY_TYPE_UNSPECIFIED Unspecified property type.
APARTMENT Apartment.
CONDO Condo.
LOFT Loft.
MULTI_FAMILY_HOME Multi-family home.
PENTHOUSE Penthouse.
ROOM Room.
SINGLE_FAMILY_HOME Single-family home.
STUDIO Studio.
TOWNHOUSE Townhouse.

QuestionAndAnswer

The question and answer for the product.

Fields
question

string

Required. The question text.

answer

string

Required. The answer text.

RelatedProduct

Specifies how other products are related to this product.

Fields
relationship_type

RelationshipType

Required. The type of the relationship between this product and the related product.

id_type

IdType

Required. The type of the identifier of the related product. For example, GTIN or product ID.

id

string

Required. The identifier of the related product.

IdType

The type of the identifier of the related product.

Enums
ID_TYPE_UNSPECIFIED The identifier type is unspecified.
GTIN The identifier is a GTIN.
ID The identifier is a product ID in the feed.

RelationshipType

The various types of the relationships between this product and the related product.

Enums
RELATIONSHIP_TYPE_UNSPECIFIED The relationship type is unspecified.
PART_OF_SET Part of a set of products that are often purchased together.
REQUIRED_PART Part that is necessary for the product to function, for example a battery for a battery-operated lamp.
OFTEN_BOUGHT_WITH A product that this product is often purchased together with, for example a phone case with a phone.
SUBSTITUTE Product that this product can be substituted for. For example a printer comparable in function to another printer.
DIFFERENT_BRAND An identical product sold under a different brand, for example a cheaper house brand.
ACCESSORY An accessory to this product, for example a side table that matches the style of a couch.

Returns

The returns of the product.

Fields
countries[]

string

The CLDR territory code of the countries to which an item can be returned.

item_conditions[]

ItemCondition

The condition the item must be in to be accepted.

methods[]

ReturnMethod

The physical methods by which the item can be returned.

outcomes[]

ReturnOutcome

The financial outcomes available for a return.

Union field restocking_fee_oneof. The restocking fee charged to the customer. restocking_fee_oneof can be only one of the following:
restocking_fee

Price

A flat restocking fee penalty.

restocking_percentage_fee

double

A percentage restocking fee penalty.

window_days

int64

The duration of the return window in days.

window_type

ReturnWindowType

Special return window behavior.

shipping_fee

Price

The fixed cost out-of-pocket for a customer to return an item.

shipping_fee_type

ReturnShippingFeeType

The type of return shipping fee.

policy_url

string

The URL of the return policy.

ItemCondition

The acceptable item condition for a return.

Enums
ITEM_CONDITION_UNSPECIFIED The item condition is unspecified.
NEW New condition.
LIKE_NEW Like new condition.
USED Used condition.
DEFECTIVE_ONLY Only defective items are accepted.

ReturnMethod

The physical method by which the item can be returned.

Enums
RETURN_METHOD_UNSPECIFIED The return method is unspecified.
BY_MAIL Customer returns the item by mail.
IN_STORE Customer returns the item in a store.
AT_A_KIOSK Customer drops off the item at a kiosk.
DROP_OFF_LOCATION Customer drops off the item at a 3rd party partner location.

ReturnOutcome

The financial outcome of a return.

Enums
RETURN_OUTCOME_UNSPECIFIED The return outcome is unspecified.
REFUND Customer receives a refund.
EXCHANGE Customer receives an exchange.
STORE_CREDIT Customer receives store credit.

ReturnShippingFeeType

The type of the return shipping fee.

Enums
RETURN_SHIPPING_FEE_TYPE_UNSPECIFIED The return shipping fee type is unspecified.
CUSTOMER_RESPONSIBILITY The customer is responsible for shipping costs.
DEDUCTED_FROM_REFUND The shipping cost is deducted from the refund.

ReturnWindowType

Type of return window for the return policy.

Enums
RETURN_WINDOW_TYPE_UNSPECIFIED The return window type is unspecified.
FINITE_RETURN_WINDOW Window with a fixed number of days. If this is set, the window_days field must be set.
NO_RETURNS No returns accepted.
LIFETIME Lifetime returns accepted.

ShippingBusinessDaysConfig

The business days during which orders are on their path to fulfillment. If not provided, Monday to Friday business days will be assumed.

Fields
country

string

The CLDR territory code of the country to which an item will ship.

business_days

string

Effective days of the week considered for the delivery time calculation. May not be empty. The more business days included the faster the delivery. Can be set through individual days (e.g. MTWRF), or day ranges (e.g. Mon-Fri). For more information about accepted formats, see Shipping handling business days.

SpecialtyHousingType

The specialty housing type for the property.

Enums
SPECIALTY_HOUSING_TYPE_UNSPECIFIED Unspecified specialty housing type.
CORPORATE Corporate housing.
LOW_INCOME Low income housing.
MILITARY Military housing.
SENIOR Senior housing.
SHORT_TERM Short term housing.
STUDENT Student housing.

UnitArea

The unit area of the property.

Fields
unit

Unit

The unit of area.

value

double

The area value.

Unit

The unit of area.

Enums
UNIT_UNSPECIFIED Unspecified unit.
SQM Square meters.
SQFT Square feet.

UtilitiesIncluded

The utilities included for the property.

Enums
UTILITIES_INCLUDED_UNSPECIFIED Unspecified utilities included.
ELECTRICITY Electricity.
GAS Gas.
INTERNET Internet.
TRASH Trash.
WATER Water.

VariantOption

Additional product variants for the product.

Fields
name

string

Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"

value

string

Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"

VehicleBodyStyle

The vehicle body style. See the Body style for more information.

Enums
VEHICLE_BODY_STYLE_UNSPECIFIED Unspecified vehicle body style.
ATV_SPORT ATV Sport.
ATV_TOURING ATV Touring.
ATV_UTILITY ATV Utility.
ATV_YOUTH ATV Youth.
CITY_CAR City car.
CLASS_A_MOTORHOME Class A motorhome.
CLASS_B_MOTORHOME Class B motorhome.
CLASS_C_MOTORHOME Class C motorhome.
COMPACT_SUV Compact SUV.
CONVERTIBLE Convertible.
COUPE Coupe.
CROSSOVER Crossover.
FIFTH_WHEEL Fifth wheel.
FULL_SIZE_VAN Full size van.
HATCHBACK Hatchback.
LIMOUSINE Limousine.
MINIVAN Minivan.
NOTCHBACK Notchback.
POP_UP_CAMPER Pop up camper.
SEDAN Sedan.
SIDE_BY_SIDE Side by side.
STATION_WAGON Station wagon.
SUV SUV.
TRAVEL_TRAILER Travel trailer.
TRUCK Truck.
TRUCK_CAMPER Truck camper.
UTE Ute.
UTV_RECREATIONAL_UTILITY UTV Recreational utility.
UTV_SPORT UTV Sport.
UTV_UTILITY UTV Utility.
UTV_YOUTH UTV Youth.

VehiclePriceType

The vehicle price type.

Enums
VEHICLE_PRICE_TYPE_UNSPECIFIED Unspecified vehicle price type.
ALL_IN_PRICE All in price.
DRIVE_AWAY_PRICE Drive away price.
ESTIMATED_DRIVE_AWAY_PRICE Estimated drive away price.
EXCLUDING_GOVERNMENT_CHARGES_PRICE Excluding government charges price.
VEHICLE_BASE_PRICE Vehicle base price.

Warranty

The warranty of the vehicle.

Fields
duration

int64

The warranty duration in months.

mileage

Mileage

The warranty mileage.

Surface

The surface values to which the minimum order value applies.

Enums
SURFACE_UNSPECIFIED Surface is unspecified.
ONLINE Surface value to indicate online purchases.
LOCAL Surface value to indicate local purchases.
ONLINE_LOCAL Surface value to indicate online and local purchases.

DestinationStatus

The destination status of the product status.

Equivalent to StatusPerReportingContext in Reports API.

Fields
reporting_context

ReportingContextEnum

The name of the reporting context.

approved_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where the offer is approved.

pending_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.

disapproved_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.

ItemLevelIssue

The ItemLevelIssue of the product status.

Fields
code

string

The error code of the issue.

severity

Severity

How this issue affects serving of the offer.

resolution

string

Whether the issue can be resolved by the business.

attribute

string

The attribute's name, if the issue is caused by a single attribute.

reporting_context

ReportingContextEnum

The reporting context the issue applies to.

description

string

A short issue description in English.

detail

string

A detailed issue description in English.

documentation

string

The URL of a web page to help with resolving this issue.

applicable_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.

Severity

How the issue affects the serving of the product.

Enums
SEVERITY_UNSPECIFIED Not specified.
NOT_IMPACTED This issue represents a warning and does not have a direct affect on the product.
DEMOTED The product is demoted and most likely have limited performance in search results
DISAPPROVED Issue disapproves the product.

Type

Types of supported sustainability incentive programs.

Enums
TYPE_UNSPECIFIED Unspecified or unknown sustainability incentive type.
EV_TAX_CREDIT Program offering tax liability reductions for electric vehicles and, in some countries, plug-in hybrids. These reductions can be based on a specific amount or a percentage of the sale price.
EV_PRICE_DISCOUNT A subsidy program, often called an environmental bonus, provides a purchase grant for electric vehicles and, in some countries, plug-in hybrids. The grant amount may be a fixed sum or a percentage of the sale price.