Skip to content
Verve Retail Media

Get location

GET
/v1alpha2/inventory/locations/{externalId}

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
externalId
required
string
/[^/]+/

The shared identifier of the physical location to fetch.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
object
resource

The partner version, falling back to the canonical.

object
data

Location represents a retail store with its full operational profile.

object
metadata

The metadata of the location.

object
id
read-only

The unique identifier for the resource.

string
fqn
read-only

The fully qualified name of the resource.

string
name

The name of the resource.

string
firstCreatedAt
read-only

The timestamp when the resource was first created.

string format: date-time
lastUpdatedAt
read-only

The timestamp when the resource was last updated.

string format: date-time
revision
read-only

The revision of the resource. Must be empty if the resource is not under version control.

object
id
read-only

The unique identifier for a particular revision of the resource.

string
createdAt
read-only

The timestamp when this particular revision was created.

string format: date-time
latestId
read-only

The unique identifier for the latest revision of the resource. Must be empty if this is already the latest revision.

string
labels

The labels of the resource.

object
key
additional properties
string
mask

The fields to update or to return in the location.

string
supportedCurrencies

ISO 4217 currency codes, e.g. “EUR”.

Array<string>
supportedLanguages

BCP-47 language tags, e.g. [“de”, “en”].

Array<string>
status

The operational status of the location.

string
default: STATUS_UNSPECIFIED
Allowed values: STATUS_UNSPECIFIED STATUS_INACTIVE STATUS_ACTIVE
timezone

IANA timezone, e.g. “Europe/Berlin”.

string
address
object
country
string
city
string
street
string
number
string
zipCode
string
region
string
state
string
coordinates

GPS coordinates of the location.

object
latitude

The latitude in degrees. It must be in the range [-90.0, +90.0].

number format: double
longitude

The longitude in degrees. It must be in the range [-180.0, +180.0].

number format: double
weeklyHours

Recurring weekly operating rules (open/closed windows per day).

Array<object>

WeeklyHours is a recurring weekly operating rule for a single day. An unset start/end means the rule applies to the whole day.

object
day

Represents a day of the week.

  • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
  • MONDAY: Monday
  • TUESDAY: Tuesday
  • WEDNESDAY: Wednesday
  • THURSDAY: Thursday
  • FRIDAY: Friday
  • SATURDAY: Saturday
  • SUNDAY: Sunday
string
default: DAY_OF_WEEK_UNSPECIFIED
Allowed values: DAY_OF_WEEK_UNSPECIFIED MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
availability

Availability indicates whether a time rule opens or closes the location.

string
default: AVAILABILITY_UNSPECIFIED
Allowed values: AVAILABILITY_UNSPECIFIED AVAILABILITY_OPEN AVAILABILITY_CLOSED
start

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
end

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
dateOverrides

Date-specific operating overrides (annual if year=0, otherwise one-off).

Array<object>

DateOverride is a date-specific operating rule. year=0 means it recurs annually; otherwise it is a one-off date. An unset start/end means the rule applies to the whole day.

object
date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

  • [google.type.TimeOfDay][google.type.TimeOfDay]
  • [google.type.DateTime][google.type.DateTime]
  • [google.protobuf.Timestamp][google.protobuf.Timestamp]
object
year

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

integer format: int32
month

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

integer format: int32
day

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn’t significant.

integer format: int32
availability

Availability indicates whether a time rule opens or closes the location.

string
default: AVAILABILITY_UNSPECIFIED
Allowed values: AVAILABILITY_UNSPECIFIED AVAILABILITY_OPEN AVAILABILITY_CLOSED
start

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
end

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
externalId

Client defined unique id.

string
gln

Global Location Number (GLN / ILN), e.g. “4314318377126”.

string
tdlinx

TDLinx store identifier.

string
nielsenArea

Nielsen geographic marketing area.

string
default: NIELSEN_AREA_UNSPECIFIED
Allowed values: NIELSEN_AREA_UNSPECIFIED NIELSEN_AREA_I NIELSEN_AREA_II NIELSEN_AREA_IIIA NIELSEN_AREA_IIIB NIELSEN_AREA_IV NIELSEN_AREA_V NIELSEN_AREA_VI NIELSEN_AREA_VII NIELSEN_AREA_V_VI
salesAreaSqm

Sales floor size in square metres.

integer format: int32
storeChain

Retail chain brand, e.g. “EDEKA”.

object
internalId
read-only

Read-only unique id.

string
externalId

Client defined unique id.

string
name
Name of the Entity
string
storeSubchain

Distribution line / sub-chain, e.g. “EDEKA Nordbayern”.

object
internalId
read-only

Read-only unique id.

string
externalId

Client defined unique id.

string
name
Name of the Entity
string
merchant

Store owner / contract holder name.

object
internalId
read-only

Read-only unique id.

string
externalId

Client defined unique id.

string
name
Name of the Entity
string
municipality
object
name
string
administrativeArea
string
population
integer format: int32
excludedAdProducts

Advertising-industry taxonomy categories that must not be served for every Device at this location.

Array<string>
Allowed values: AD_PRODUCT_UNSPECIFIED AD_PRODUCT_GENERAL AD_PRODUCT_RELIGION AD_PRODUCT_EROTIC_CONTENT AD_PRODUCT_FUNERAL_SERVICES AD_PRODUCT_BEVERAGES AD_PRODUCT_NON_ALCOHOLIC_BEVERAGES AD_PRODUCT_BEER AD_PRODUCT_BEVERAGES_GENERAL AD_PRODUCT_BEVERAGES_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_COFFEE_TEA_COCOA AD_PRODUCT_SPARKLING_WINE AD_PRODUCT_WINE AD_PRODUCT_SPIRITS AD_PRODUCT_FINANCE AD_PRODUCT_RETIREMENT_PROVISION AD_PRODUCT_FINANCIAL_SERVICES_CORPORATE_CLIENTS AD_PRODUCT_FINANCIAL_SERVICES_PRIVATE_CLIENTS AD_PRODUCT_FINANCIAL_INVESTMENTS AD_PRODUCT_FINANCE_GENERAL AD_PRODUCT_FINANCE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_INSURANCE AD_PRODUCT_SERVICES AD_PRODUCT_EQUIPMENT_LEASING_RENTAL AD_PRODUCT_VOCATIONAL_TRAINING AD_PRODUCT_CAR_WASHES AD_PRODUCT_CONSULTING_SERVICES AD_PRODUCT_SERVICES_GENERAL AD_PRODUCT_SERVICES_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_SERVICES_OTHER AD_PRODUCT_PRINTING_COMPANIES AD_PRODUCT_IT_SERVICES AD_PRODUCT_PROPERTY_MANAGEMENT AD_PRODUCT_DELIVERY_SERVICES AD_PRODUCT_PUBLIC_CORPORATIONS AD_PRODUCT_LOTTERIES_LOTTO_SPORTS_BETTING AD_PRODUCT_MARKETING_ADVERTISING AD_PRODUCT_MARKET_RESEARCH AD_PRODUCT_TRADE_FAIRS_EXHIBITIONS_SEMINARS AD_PRODUCT_ONLINE_SERVICES AD_PRODUCT_TELEPHONE_FAX_SERVICES AD_PRODUCT_BROKERAGE_SERVICES AD_PRODUCT_LEGAL_AND_BUSINESS_CONSULTING AD_PRODUCT_CAPITAL_GOODS AD_PRODUCT_DRIVES_BEARINGS AD_PRODUCT_COMMERCIAL_INDUSTRIAL_FURNISHING AD_PRODUCT_CAPITAL_GOODS_GENERAL AD_PRODUCT_CAPITAL_GOODS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_CAPITAL_GOODS_OTHER AD_PRODUCT_MACHINERY_SYSTEMS AD_PRODUCT_MACHINERY_INDUSTRY_AGRICULTURE AD_PRODUCT_TOOLS AD_PRODUCT_HEALTH_PHARMACEUTICALS AD_PRODUCT_MEDICINES AD_PRODUCT_HEALTH_CARE_FACILITIES AD_PRODUCT_HEALTH_PHARMACEUTICALS_GENERAL AD_PRODUCT_HEALTH_PHARMACEUTICALS_OTHER AD_PRODUCT_HEALTH_PHARMACEUTICALS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_MEDICAL_DEVICES AD_PRODUCT_OPTICS AD_PRODUCT_SPORT_DIET_PROGRAMS AD_PRODUCT_ACOUSTICS AD_PRODUCT_CLINICS_SANATORIUMS_AND_DOCTORS AD_PRODUCT_CONSUMER_ELECTRONICS AD_PRODUCT_AUDIO_DEVICES AD_PRODUCT_PHOTOGRAPHY AD_PRODUCT_CONSUMER_ELECTRONICS_GENERAL AD_PRODUCT_GAMES_GAMING_COMPUTERS AD_PRODUCT_CONSUMER_ELECTRONICS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_PERSONAL_CARE AD_PRODUCT_BABY_CARE AD_PRODUCT_DECORATIVE_COSMETICS AD_PRODUCT_BODY_CARE AD_PRODUCT_FACIAL_CARE AD_PRODUCT_HAIR_CARE AD_PRODUCT_PERSONAL_HYGIENE AD_PRODUCT_PERSONAL_CARE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_PERFUMES_FRAGRANCE_PRODUCTS AD_PRODUCT_CARE_COSMETICS_COMPLETE_SERIES AD_PRODUCT_HOME_GARDEN_FURNISHINGS AD_PRODUCT_BATHROOM_SANITARY AD_PRODUCT_HOUSEHOLD_ELECTRICAL_APPLIANCES AD_PRODUCT_FLOORING AD_PRODUCT_GARDENING_AGRICULTURE AD_PRODUCT_GARDEN_TOOLS AD_PRODUCT_TABLEWARE_GLASSWARE AD_PRODUCT_HOME_GARDEN_FURNISHINGS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_HOME_GARDEN_FURNISHINGS_GENERAL AD_PRODUCT_HOUSEHOLD_ARTICLES AD_PRODUCT_LIGHTING_TECHNOLOGY AD_PRODUCT_AWNINGS_BLINDS AD_PRODUCT_FURNITURE_FURNISHINGS AD_PRODUCT_SECURITY_ALARM_DEVICES AD_PRODUCT_CONSTRUCTION_INDUSTRY AD_PRODUCT_BUILDING_MATERIALS_ACCESSORIES AD_PRODUCT_CONSTRUCTION_INDUSTRY_GENERAL AD_PRODUCT_CONSTRUCTION_INDUSTRY_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_CONSTRUCTION_MACHINERY AD_PRODUCT_PAINTS_WALLPAPER AD_PRODUCT_REAL_ESTATE AD_PRODUCT_TEXTILES_CLOTHING AD_PRODUCT_CLOTHING AD_PRODUCT_TEXTILES_CLOTHING_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TEXTILES_CLOTHING_GENERAL AD_PRODUCT_HOME_TEXTILES AD_PRODUCT_LEATHER_GOODS AD_PRODUCT_FURS AD_PRODUCT_SHOES AD_PRODUCT_UNDERWEAR AD_PRODUCT_MEDIA AD_PRODUCT_VIDEO_AUDIO_MEDIA_MUSIC AD_PRODUCT_TRADE_MAGAZINE_ADVERTISING AD_PRODUCT_FILM AD_PRODUCT_TV_PROGRAM AD_PRODUCT_TV_ADVERTISING AD_PRODUCT_NEWSPAPER_ADVERTISING AD_PRODUCT_MEDIA_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_CONSUMER_MAGAZINE_ADVERTISING AD_PRODUCT_RADIO_ADVERTISING AD_PRODUCT_OTHER_MEDIA_PUBLISHERS AD_PRODUCT_FOOD_NUTRITION AD_PRODUCT_BREAD_LONG_LIFE_BAKED_GOODS AD_PRODUCT_SPREADS AD_PRODUCT_DESSERTS AD_PRODUCT_DIET_SPORTS_NUTRITION AD_PRODUCT_FOOD_GENERAL AD_PRODUCT_FOOD_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_DELICATESSEN AD_PRODUCT_MEAT_FISH AD_PRODUCT_FRUITS_VEGETABLES AD_PRODUCT_SPICES_SEASONING_SAUCES AD_PRODUCT_FROZEN_FOOD AD_PRODUCT_DAIRY_PRODUCTS_YELLOW_LINE AD_PRODUCT_DAIRY_PRODUCTS_WHITE_LINE AD_PRODUCT_STAPLE_FOODS AD_PRODUCT_CONFECTIONERY AD_PRODUCT_BAKERIES_PASTRY_SHOPS AD_PRODUCT_OTHER_ADVERTISING AD_PRODUCT_CHARITABLE_ORGANIZATIONS AD_PRODUCT_CLASSIFIED_ADVERTISING AD_PRODUCT_CORPORATE_ADVERTISING AD_PRODUCT_COMPUTER_OFFICE AD_PRODUCT_COMPUTERS_PERIPHERALS AD_PRODUCT_COMPUTER_OFFICE_GENERAL AD_PRODUCT_SOFTWARE AD_PRODUCT_OTHER_OFFICE_EQUIPMENT_PAPER AD_PRODUCT_ENERGY AD_PRODUCT_ENERGY_GENERAL AD_PRODUCT_ENERGY_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_ENERGY_SUPPLY AD_PRODUCT_HEATING_TECHNOLOGY AD_PRODUCT_FUELS_LUBRICANTS AD_PRODUCT_ELECTRICITY_PROVIDERS AD_PRODUCT_ELECTRICITY_PROVIDERS_ELECTROMOBILITY AD_PRODUCT_GAS_STATIONS AD_PRODUCT_AUTOMOTIVE_MARKET AD_PRODUCT_VEHICLE_SERVICE AD_PRODUCT_VEHICLE_ACCESSORIES AD_PRODUCT_TWO_WHEELER_INDUSTRY AD_PRODUCT_AUTOMOTIVE_MARKET_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_AUTOMOTIVE_MARKET_GENERAL AD_PRODUCT_CARAVANS_MOTORHOMES AD_PRODUCT_COMMERCIAL_VEHICLES AD_PRODUCT_PASSENGER_CARS AD_PRODUCT_TIRES AD_PRODUCT_TRANSPORT_LOGISTICS AD_PRODUCT_VEHICLE_RENTAL AD_PRODUCT_AVIATION AD_PRODUCT_ROAD_RAIL_TRANSPORT AD_PRODUCT_TRANSPORT_LOGISTICS_GENERAL AD_PRODUCT_TRANSPORT_LOGISTICS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TELECOMMUNICATIONS AD_PRODUCT_LANDLINE AD_PRODUCT_TELECOMMUNICATIONS_GENERAL AD_PRODUCT_TELECOMMUNICATIONS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TELECOMMUNICATIONS_BUNDLES AD_PRODUCT_TELECOMMUNICATIONS_OTHER AD_PRODUCT_TELECOMMUNICATIONS_DEVICES AD_PRODUCT_MOBILE_NETWORK AD_PRODUCT_HOUSEHOLD_AGRICULTURE_FORESTRY_HUNTING AD_PRODUCT_FISHING_HUNTING_WEAPONS AD_PRODUCT_PET_FOOD AD_PRODUCT_ANIMAL_CARE AD_PRODUCT_TOURISM AD_PRODUCT_AIRLINES_AIR_TRAVEL AD_PRODUCT_VISITOR_TOURISM AD_PRODUCT_TOURISM_GENERAL AD_PRODUCT_TOURISM_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TRAVEL_COMPANIES AD_PRODUCT_CRUISE_LINES_SEA_TRAVEL AD_PRODUCT_LEISURE_SPORT AD_PRODUCT_LEISURE_SPORT_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_SPORT_CAMPING AD_PRODUCT_TRADE AD_PRODUCT_TRADE_GENERAL AD_PRODUCT_TRADE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TRADE_OTHER AD_PRODUCT_FOOD_RETAIL AD_PRODUCT_FOOD_WHOLESALE AD_PRODUCT_DEPARTMENT_STORES AD_PRODUCT_EXPORT_IMPORT AD_PRODUCT_DRUGSTORES AD_PRODUCT_BEVERAGE_STORES AD_PRODUCT_OUTLET_CENTERS AD_PRODUCT_ELECTRONICS_STORES AD_PRODUCT_BAKERIES AD_PRODUCT_RETAIL_OTHER AD_PRODUCT_GASTRONOMY AD_PRODUCT_HOTELS AD_PRODUCT_HOTELS_GASTRONOMY_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_HOTELS_GASTRONOMY_E_COMMERCE AD_PRODUCT_INDUSTRIAL_CONSUMER_GOODS AD_PRODUCT_PACKAGING AD_PRODUCT_INDUSTRIAL_CONSUMER_GOODS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_INDUSTRIAL_CONSUMER_GOODS_GENERAL AD_PRODUCT_PLASTICS AD_PRODUCT_ADHESIVES AD_PRODUCT_ART_CULTURE_ENTERTAINMENT AD_PRODUCT_ART_CULTURE AD_PRODUCT_ART_CULTURE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_ART_CULTURE_ENTERTAINMENT_ADVERTISING_RANGE AD_PRODUCT_ENTERTAINMENT AD_PRODUCT_PERSONAL_NEEDS AD_PRODUCT_WATCHES_JEWELRY AD_PRODUCT_MUSICAL_INSTRUMENTS AD_PRODUCT_PERSONAL_NEEDS_OTHER AD_PRODUCT_COLLECTIBLES AD_PRODUCT_WRITING_INSTRUMENTS AD_PRODUCT_TOYS AD_PRODUCT_TOBACCO AD_PRODUCT_CLEANING AD_PRODUCT_CLEANING_GENERAL AD_PRODUCT_CLEANING_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_DETERGENTS AD_PRODUCT_POLITICAL_PARTIES AD_PRODUCT_CDU AD_PRODUCT_FDP AD_PRODUCT_SPD AD_PRODUCT_ALLIANCE_90_THE_GREENS AD_PRODUCT_THE_LEFT AD_PRODUCT_FREE_DEMOCRATS AD_PRODUCT_ALTERNATIVE_FOR_GERMANY AD_PRODUCT_POLITICAL_PARTIES_OTHER
source

LocationSource tells which collection a version comes from.

  • LOCATION_SOURCE_CANONICAL: The tenant-wide consensus record.
  • LOCATION_SOURCE_LATEST: One partner’s latest copy.
string
default: LOCATION_SOURCE_UNSPECIFIED
Allowed values: LOCATION_SOURCE_UNSPECIFIED LOCATION_SOURCE_CANONICAL LOCATION_SOURCE_LATEST
organization

The partner’s organization name; empty for the canonical version.

string
versions

Every stored version of this physical location, canonical first.

Array<object>

LocationGetItem is one stored version of a physical location, carrying its full resource data. Mirrors LocationVersion, but data (the full Location) instead of summary.

object
data

Location represents a retail store with its full operational profile.

object
metadata

The metadata of the location.

object
id
read-only

The unique identifier for the resource.

string
fqn
read-only

The fully qualified name of the resource.

string
name

The name of the resource.

string
firstCreatedAt
read-only

The timestamp when the resource was first created.

string format: date-time
lastUpdatedAt
read-only

The timestamp when the resource was last updated.

string format: date-time
revision
read-only

The revision of the resource. Must be empty if the resource is not under version control.

object
id
read-only

The unique identifier for a particular revision of the resource.

string
createdAt
read-only

The timestamp when this particular revision was created.

string format: date-time
latestId
read-only

The unique identifier for the latest revision of the resource. Must be empty if this is already the latest revision.

string
labels

The labels of the resource.

object
key
additional properties
string
mask

The fields to update or to return in the location.

string
supportedCurrencies

ISO 4217 currency codes, e.g. “EUR”.

Array<string>
supportedLanguages

BCP-47 language tags, e.g. [“de”, “en”].

Array<string>
status

The operational status of the location.

string
default: STATUS_UNSPECIFIED
Allowed values: STATUS_UNSPECIFIED STATUS_INACTIVE STATUS_ACTIVE
timezone

IANA timezone, e.g. “Europe/Berlin”.

string
address
object
country
string
city
string
street
string
number
string
zipCode
string
region
string
state
string
coordinates

GPS coordinates of the location.

object
latitude

The latitude in degrees. It must be in the range [-90.0, +90.0].

number format: double
longitude

The longitude in degrees. It must be in the range [-180.0, +180.0].

number format: double
weeklyHours

Recurring weekly operating rules (open/closed windows per day).

Array<object>

WeeklyHours is a recurring weekly operating rule for a single day. An unset start/end means the rule applies to the whole day.

object
day

Represents a day of the week.

  • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
  • MONDAY: Monday
  • TUESDAY: Tuesday
  • WEDNESDAY: Wednesday
  • THURSDAY: Thursday
  • FRIDAY: Friday
  • SATURDAY: Saturday
  • SUNDAY: Sunday
string
default: DAY_OF_WEEK_UNSPECIFIED
Allowed values: DAY_OF_WEEK_UNSPECIFIED MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
availability

Availability indicates whether a time rule opens or closes the location.

string
default: AVAILABILITY_UNSPECIFIED
Allowed values: AVAILABILITY_UNSPECIFIED AVAILABILITY_OPEN AVAILABILITY_CLOSED
start

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
end

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
dateOverrides

Date-specific operating overrides (annual if year=0, otherwise one-off).

Array<object>

DateOverride is a date-specific operating rule. year=0 means it recurs annually; otherwise it is a one-off date. An unset start/end means the rule applies to the whole day.

object
date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

  • [google.type.TimeOfDay][google.type.TimeOfDay]
  • [google.type.DateTime][google.type.DateTime]
  • [google.protobuf.Timestamp][google.protobuf.Timestamp]
object
year

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

integer format: int32
month

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

integer format: int32
day

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn’t significant.

integer format: int32
availability

Availability indicates whether a time rule opens or closes the location.

string
default: AVAILABILITY_UNSPECIFIED
Allowed values: AVAILABILITY_UNSPECIFIED AVAILABILITY_OPEN AVAILABILITY_CLOSED
start

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
end

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object
hours

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time.

integer format: int32
minutes

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.

integer format: int32
seconds

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

integer format: int32
nanos

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

integer format: int32
externalId

Client defined unique id.

string
gln

Global Location Number (GLN / ILN), e.g. “4314318377126”.

string
tdlinx

TDLinx store identifier.

string
nielsenArea

Nielsen geographic marketing area.

string
default: NIELSEN_AREA_UNSPECIFIED
Allowed values: NIELSEN_AREA_UNSPECIFIED NIELSEN_AREA_I NIELSEN_AREA_II NIELSEN_AREA_IIIA NIELSEN_AREA_IIIB NIELSEN_AREA_IV NIELSEN_AREA_V NIELSEN_AREA_VI NIELSEN_AREA_VII NIELSEN_AREA_V_VI
salesAreaSqm

Sales floor size in square metres.

integer format: int32
storeChain

Retail chain brand, e.g. “EDEKA”.

object
internalId
read-only

Read-only unique id.

string
externalId

Client defined unique id.

string
name
Name of the Entity
string
storeSubchain

Distribution line / sub-chain, e.g. “EDEKA Nordbayern”.

object
internalId
read-only

Read-only unique id.

string
externalId

Client defined unique id.

string
name
Name of the Entity
string
merchant

Store owner / contract holder name.

object
internalId
read-only

Read-only unique id.

string
externalId

Client defined unique id.

string
name
Name of the Entity
string
municipality
object
name
string
administrativeArea
string
population
integer format: int32
excludedAdProducts

Advertising-industry taxonomy categories that must not be served for every Device at this location.

Array<string>
Allowed values: AD_PRODUCT_UNSPECIFIED AD_PRODUCT_GENERAL AD_PRODUCT_RELIGION AD_PRODUCT_EROTIC_CONTENT AD_PRODUCT_FUNERAL_SERVICES AD_PRODUCT_BEVERAGES AD_PRODUCT_NON_ALCOHOLIC_BEVERAGES AD_PRODUCT_BEER AD_PRODUCT_BEVERAGES_GENERAL AD_PRODUCT_BEVERAGES_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_COFFEE_TEA_COCOA AD_PRODUCT_SPARKLING_WINE AD_PRODUCT_WINE AD_PRODUCT_SPIRITS AD_PRODUCT_FINANCE AD_PRODUCT_RETIREMENT_PROVISION AD_PRODUCT_FINANCIAL_SERVICES_CORPORATE_CLIENTS AD_PRODUCT_FINANCIAL_SERVICES_PRIVATE_CLIENTS AD_PRODUCT_FINANCIAL_INVESTMENTS AD_PRODUCT_FINANCE_GENERAL AD_PRODUCT_FINANCE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_INSURANCE AD_PRODUCT_SERVICES AD_PRODUCT_EQUIPMENT_LEASING_RENTAL AD_PRODUCT_VOCATIONAL_TRAINING AD_PRODUCT_CAR_WASHES AD_PRODUCT_CONSULTING_SERVICES AD_PRODUCT_SERVICES_GENERAL AD_PRODUCT_SERVICES_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_SERVICES_OTHER AD_PRODUCT_PRINTING_COMPANIES AD_PRODUCT_IT_SERVICES AD_PRODUCT_PROPERTY_MANAGEMENT AD_PRODUCT_DELIVERY_SERVICES AD_PRODUCT_PUBLIC_CORPORATIONS AD_PRODUCT_LOTTERIES_LOTTO_SPORTS_BETTING AD_PRODUCT_MARKETING_ADVERTISING AD_PRODUCT_MARKET_RESEARCH AD_PRODUCT_TRADE_FAIRS_EXHIBITIONS_SEMINARS AD_PRODUCT_ONLINE_SERVICES AD_PRODUCT_TELEPHONE_FAX_SERVICES AD_PRODUCT_BROKERAGE_SERVICES AD_PRODUCT_LEGAL_AND_BUSINESS_CONSULTING AD_PRODUCT_CAPITAL_GOODS AD_PRODUCT_DRIVES_BEARINGS AD_PRODUCT_COMMERCIAL_INDUSTRIAL_FURNISHING AD_PRODUCT_CAPITAL_GOODS_GENERAL AD_PRODUCT_CAPITAL_GOODS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_CAPITAL_GOODS_OTHER AD_PRODUCT_MACHINERY_SYSTEMS AD_PRODUCT_MACHINERY_INDUSTRY_AGRICULTURE AD_PRODUCT_TOOLS AD_PRODUCT_HEALTH_PHARMACEUTICALS AD_PRODUCT_MEDICINES AD_PRODUCT_HEALTH_CARE_FACILITIES AD_PRODUCT_HEALTH_PHARMACEUTICALS_GENERAL AD_PRODUCT_HEALTH_PHARMACEUTICALS_OTHER AD_PRODUCT_HEALTH_PHARMACEUTICALS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_MEDICAL_DEVICES AD_PRODUCT_OPTICS AD_PRODUCT_SPORT_DIET_PROGRAMS AD_PRODUCT_ACOUSTICS AD_PRODUCT_CLINICS_SANATORIUMS_AND_DOCTORS AD_PRODUCT_CONSUMER_ELECTRONICS AD_PRODUCT_AUDIO_DEVICES AD_PRODUCT_PHOTOGRAPHY AD_PRODUCT_CONSUMER_ELECTRONICS_GENERAL AD_PRODUCT_GAMES_GAMING_COMPUTERS AD_PRODUCT_CONSUMER_ELECTRONICS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_PERSONAL_CARE AD_PRODUCT_BABY_CARE AD_PRODUCT_DECORATIVE_COSMETICS AD_PRODUCT_BODY_CARE AD_PRODUCT_FACIAL_CARE AD_PRODUCT_HAIR_CARE AD_PRODUCT_PERSONAL_HYGIENE AD_PRODUCT_PERSONAL_CARE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_PERFUMES_FRAGRANCE_PRODUCTS AD_PRODUCT_CARE_COSMETICS_COMPLETE_SERIES AD_PRODUCT_HOME_GARDEN_FURNISHINGS AD_PRODUCT_BATHROOM_SANITARY AD_PRODUCT_HOUSEHOLD_ELECTRICAL_APPLIANCES AD_PRODUCT_FLOORING AD_PRODUCT_GARDENING_AGRICULTURE AD_PRODUCT_GARDEN_TOOLS AD_PRODUCT_TABLEWARE_GLASSWARE AD_PRODUCT_HOME_GARDEN_FURNISHINGS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_HOME_GARDEN_FURNISHINGS_GENERAL AD_PRODUCT_HOUSEHOLD_ARTICLES AD_PRODUCT_LIGHTING_TECHNOLOGY AD_PRODUCT_AWNINGS_BLINDS AD_PRODUCT_FURNITURE_FURNISHINGS AD_PRODUCT_SECURITY_ALARM_DEVICES AD_PRODUCT_CONSTRUCTION_INDUSTRY AD_PRODUCT_BUILDING_MATERIALS_ACCESSORIES AD_PRODUCT_CONSTRUCTION_INDUSTRY_GENERAL AD_PRODUCT_CONSTRUCTION_INDUSTRY_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_CONSTRUCTION_MACHINERY AD_PRODUCT_PAINTS_WALLPAPER AD_PRODUCT_REAL_ESTATE AD_PRODUCT_TEXTILES_CLOTHING AD_PRODUCT_CLOTHING AD_PRODUCT_TEXTILES_CLOTHING_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TEXTILES_CLOTHING_GENERAL AD_PRODUCT_HOME_TEXTILES AD_PRODUCT_LEATHER_GOODS AD_PRODUCT_FURS AD_PRODUCT_SHOES AD_PRODUCT_UNDERWEAR AD_PRODUCT_MEDIA AD_PRODUCT_VIDEO_AUDIO_MEDIA_MUSIC AD_PRODUCT_TRADE_MAGAZINE_ADVERTISING AD_PRODUCT_FILM AD_PRODUCT_TV_PROGRAM AD_PRODUCT_TV_ADVERTISING AD_PRODUCT_NEWSPAPER_ADVERTISING AD_PRODUCT_MEDIA_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_CONSUMER_MAGAZINE_ADVERTISING AD_PRODUCT_RADIO_ADVERTISING AD_PRODUCT_OTHER_MEDIA_PUBLISHERS AD_PRODUCT_FOOD_NUTRITION AD_PRODUCT_BREAD_LONG_LIFE_BAKED_GOODS AD_PRODUCT_SPREADS AD_PRODUCT_DESSERTS AD_PRODUCT_DIET_SPORTS_NUTRITION AD_PRODUCT_FOOD_GENERAL AD_PRODUCT_FOOD_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_DELICATESSEN AD_PRODUCT_MEAT_FISH AD_PRODUCT_FRUITS_VEGETABLES AD_PRODUCT_SPICES_SEASONING_SAUCES AD_PRODUCT_FROZEN_FOOD AD_PRODUCT_DAIRY_PRODUCTS_YELLOW_LINE AD_PRODUCT_DAIRY_PRODUCTS_WHITE_LINE AD_PRODUCT_STAPLE_FOODS AD_PRODUCT_CONFECTIONERY AD_PRODUCT_BAKERIES_PASTRY_SHOPS AD_PRODUCT_OTHER_ADVERTISING AD_PRODUCT_CHARITABLE_ORGANIZATIONS AD_PRODUCT_CLASSIFIED_ADVERTISING AD_PRODUCT_CORPORATE_ADVERTISING AD_PRODUCT_COMPUTER_OFFICE AD_PRODUCT_COMPUTERS_PERIPHERALS AD_PRODUCT_COMPUTER_OFFICE_GENERAL AD_PRODUCT_SOFTWARE AD_PRODUCT_OTHER_OFFICE_EQUIPMENT_PAPER AD_PRODUCT_ENERGY AD_PRODUCT_ENERGY_GENERAL AD_PRODUCT_ENERGY_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_ENERGY_SUPPLY AD_PRODUCT_HEATING_TECHNOLOGY AD_PRODUCT_FUELS_LUBRICANTS AD_PRODUCT_ELECTRICITY_PROVIDERS AD_PRODUCT_ELECTRICITY_PROVIDERS_ELECTROMOBILITY AD_PRODUCT_GAS_STATIONS AD_PRODUCT_AUTOMOTIVE_MARKET AD_PRODUCT_VEHICLE_SERVICE AD_PRODUCT_VEHICLE_ACCESSORIES AD_PRODUCT_TWO_WHEELER_INDUSTRY AD_PRODUCT_AUTOMOTIVE_MARKET_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_AUTOMOTIVE_MARKET_GENERAL AD_PRODUCT_CARAVANS_MOTORHOMES AD_PRODUCT_COMMERCIAL_VEHICLES AD_PRODUCT_PASSENGER_CARS AD_PRODUCT_TIRES AD_PRODUCT_TRANSPORT_LOGISTICS AD_PRODUCT_VEHICLE_RENTAL AD_PRODUCT_AVIATION AD_PRODUCT_ROAD_RAIL_TRANSPORT AD_PRODUCT_TRANSPORT_LOGISTICS_GENERAL AD_PRODUCT_TRANSPORT_LOGISTICS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TELECOMMUNICATIONS AD_PRODUCT_LANDLINE AD_PRODUCT_TELECOMMUNICATIONS_GENERAL AD_PRODUCT_TELECOMMUNICATIONS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TELECOMMUNICATIONS_BUNDLES AD_PRODUCT_TELECOMMUNICATIONS_OTHER AD_PRODUCT_TELECOMMUNICATIONS_DEVICES AD_PRODUCT_MOBILE_NETWORK AD_PRODUCT_HOUSEHOLD_AGRICULTURE_FORESTRY_HUNTING AD_PRODUCT_FISHING_HUNTING_WEAPONS AD_PRODUCT_PET_FOOD AD_PRODUCT_ANIMAL_CARE AD_PRODUCT_TOURISM AD_PRODUCT_AIRLINES_AIR_TRAVEL AD_PRODUCT_VISITOR_TOURISM AD_PRODUCT_TOURISM_GENERAL AD_PRODUCT_TOURISM_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TRAVEL_COMPANIES AD_PRODUCT_CRUISE_LINES_SEA_TRAVEL AD_PRODUCT_LEISURE_SPORT AD_PRODUCT_LEISURE_SPORT_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_SPORT_CAMPING AD_PRODUCT_TRADE AD_PRODUCT_TRADE_GENERAL AD_PRODUCT_TRADE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_TRADE_OTHER AD_PRODUCT_FOOD_RETAIL AD_PRODUCT_FOOD_WHOLESALE AD_PRODUCT_DEPARTMENT_STORES AD_PRODUCT_EXPORT_IMPORT AD_PRODUCT_DRUGSTORES AD_PRODUCT_BEVERAGE_STORES AD_PRODUCT_OUTLET_CENTERS AD_PRODUCT_ELECTRONICS_STORES AD_PRODUCT_BAKERIES AD_PRODUCT_RETAIL_OTHER AD_PRODUCT_GASTRONOMY AD_PRODUCT_HOTELS AD_PRODUCT_HOTELS_GASTRONOMY_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_HOTELS_GASTRONOMY_E_COMMERCE AD_PRODUCT_INDUSTRIAL_CONSUMER_GOODS AD_PRODUCT_PACKAGING AD_PRODUCT_INDUSTRIAL_CONSUMER_GOODS_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_INDUSTRIAL_CONSUMER_GOODS_GENERAL AD_PRODUCT_PLASTICS AD_PRODUCT_ADHESIVES AD_PRODUCT_ART_CULTURE_ENTERTAINMENT AD_PRODUCT_ART_CULTURE AD_PRODUCT_ART_CULTURE_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_ART_CULTURE_ENTERTAINMENT_ADVERTISING_RANGE AD_PRODUCT_ENTERTAINMENT AD_PRODUCT_PERSONAL_NEEDS AD_PRODUCT_WATCHES_JEWELRY AD_PRODUCT_MUSICAL_INSTRUMENTS AD_PRODUCT_PERSONAL_NEEDS_OTHER AD_PRODUCT_COLLECTIBLES AD_PRODUCT_WRITING_INSTRUMENTS AD_PRODUCT_TOYS AD_PRODUCT_TOBACCO AD_PRODUCT_CLEANING AD_PRODUCT_CLEANING_GENERAL AD_PRODUCT_CLEANING_CORPORATE_IMAGE_ADVERTISING AD_PRODUCT_DETERGENTS AD_PRODUCT_POLITICAL_PARTIES AD_PRODUCT_CDU AD_PRODUCT_FDP AD_PRODUCT_SPD AD_PRODUCT_ALLIANCE_90_THE_GREENS AD_PRODUCT_THE_LEFT AD_PRODUCT_FREE_DEMOCRATS AD_PRODUCT_ALTERNATIVE_FOR_GERMANY AD_PRODUCT_POLITICAL_PARTIES_OTHER
source

LocationSource tells which collection a version comes from.

  • LOCATION_SOURCE_CANONICAL: The tenant-wide consensus record.
  • LOCATION_SOURCE_LATEST: One partner’s latest copy.
string
default: LOCATION_SOURCE_UNSPECIFIED
Allowed values: LOCATION_SOURCE_UNSPECIFIED LOCATION_SOURCE_CANONICAL LOCATION_SOURCE_LATEST
organization

The partner’s organization name; empty for the canonical version.

string
hasConflict

True when the versions carry more than one distinct content checksum.

boolean
conflicts

One entry per content-checksummed field that diverges across versions. Always empty when has_conflict is false.

Array<object>

FieldConflict is one content-checksummed field whose value diverges across at least two of the versions in this response.

object
field

The full path of the diverging field, matching Location’s proto field names: dotted for nested messages, bracket-indexed for repeated entries, e.g. “address.city”, “weekly_hours[1].availability”.

string
values

One entry per distinct value observed for this field across versions.

Array<object>
object
value

The field’s value shared by every version listed in versions below. An unset/absent field is rendered as an explicit null, not omitted.

versions

Metadata.id of every LocationGetItem in LocationsGetResponse.versions that holds this exact value.

Array<string>
devices

Every device deployed across this physical location’s versions (the canonical and every partner’s), regardless of which project claims them — the itemized pair of LocationListItem.device_count. The caller’s own devices come first.

Array<object>

LocationDeviceItem is one device deployed at this physical location, in its short summary form, tagged with whether it is the caller’s own.

object
summary

Summary is the short list-view projection of one stored Device.

object
ids

The ids of this device’s record.

object
device
string
organization
string
project
string
name

Display name of the device.

string
type

The hardware form factor of the device.

string
default: DEVICE_TYPE_UNSPECIFIED
Allowed values: DEVICE_TYPE_UNSPECIFIED DEVICE_TYPE_CHECKOUT_TV DEVICE_TYPE_STELE DEVICE_TYPE_POLARLIGHT DEVICE_TYPE_SPOTLIGHT_ONE DEVICE_TYPE_EXCLUSIVE DEVICE_TYPE_DCLP DEVICE_TYPE_SPOTLIGHT DEVICE_TYPE_EXCLUSIVE_SCREEN DEVICE_TYPE_PRICE_BOARD DEVICE_TYPE_HANDHELD
status

The operational status of the device.

string
default: STATUS_UNSPECIFIED
Allowed values: STATUS_UNSPECIFIED STATUS_INACTIVE STATUS_ACTIVE
externalId

Device unique external identifier, in the format “{identifier.key}_{identifier.player_id}”.

string
isOwn

True when the device belongs to the caller’s own organization. Always false for a tenant-scoped caller, which has no organization of its own.

boolean
Example
{
  "resource": {
    "data": {
      "status": "STATUS_UNSPECIFIED",
      "weeklyHours": [
        {
          "day": "DAY_OF_WEEK_UNSPECIFIED",
          "availability": "AVAILABILITY_UNSPECIFIED"
        }
      ],
      "dateOverrides": [
        {
          "availability": "AVAILABILITY_UNSPECIFIED"
        }
      ],
      "nielsenArea": "NIELSEN_AREA_UNSPECIFIED",
      "excludedAdProducts": [
        "AD_PRODUCT_UNSPECIFIED"
      ]
    },
    "source": "LOCATION_SOURCE_UNSPECIFIED"
  },
  "versions": [
    {
      "data": {
        "status": "STATUS_UNSPECIFIED",
        "weeklyHours": [
          {
            "day": "DAY_OF_WEEK_UNSPECIFIED",
            "availability": "AVAILABILITY_UNSPECIFIED"
          }
        ],
        "dateOverrides": [
          {
            "availability": "AVAILABILITY_UNSPECIFIED"
          }
        ],
        "nielsenArea": "NIELSEN_AREA_UNSPECIFIED",
        "excludedAdProducts": [
          "AD_PRODUCT_UNSPECIFIED"
        ]
      },
      "source": "LOCATION_SOURCE_UNSPECIFIED"
    }
  ],
  "devices": [
    {
      "summary": {
        "type": "DEVICE_TYPE_UNSPECIFIED",
        "status": "STATUS_UNSPECIFIED"
      }
    }
  ]
}