REST Resource: accounts.locations

{
  "primaryPhone": string,
  "additionalPhones": [
    string
  ]
}

string

Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.

string

Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.

{
  "primaryCategory": {
    object (Category)
  },
  "additionalCategories": [
    {
      object (Category)
    }
  ]
}

object (Category)

Required. Category that best describes the core business this location engages in.

object (Category)

Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.

{
  "name": string,
  "displayName": string,
  "serviceTypes": [
    {
      object (ServiceType)
    }
  ],
  "moreHoursTypes": [
    {
      object (MoreHoursType)
    }
  ]
}

string

Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).

string

Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, category_id must be set.

object (ServiceType)

Output only. A list of all the service types that are available for this business category.

object (MoreHoursType)

Output only. More hours types that are available for this business category.

{
  "serviceTypeId": string,
  "displayName": string
}

string

Output only. A stable ID (provided by Google) for this service type.

string

Output only. The human-readable display name for the service type.

{
  "hoursTypeId": string,
  "displayName": string,
  "localizedDisplayName": string
}

string

Output only. A stable ID provided by Google for this hours type.

string

Output only. The human-readable English display name for the hours type.

string

Output only. The human-readable localized display name for the hours type.

{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

integer

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision.

All new revisions must be backward compatible with old revisions.

string

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.

If this value is not known, it should be omitted (rather than specifying a possibly incorrect default).

Examples: "zh-Hant", "ja", "ja-Latn", "en".

string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.

string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

string

Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language.

The minimum permitted structural representation of an address consists of a regionCode with all remaining information placed in the addressLines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.

Creating an address only containing a regionCode and addressLines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

string

Optional. The name of the organization at the address.

{
  "periods": [
    {
      object (TimePeriod)
    }
  ]
}

object (TimePeriod)

Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.

{
  "openDay": enum (DayOfWeek),
  "openTime": {
    object (TimeOfDay)
  },
  "closeDay": enum (DayOfWeek),
  "closeTime": {
    object (TimeOfDay)
  }
}

enum (DayOfWeek)

Required. Indicates the day of the week this period starts on.

object (TimeOfDay)

Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

enum (DayOfWeek)

Required. Indicates the day of the week this period ends on.

object (TimeOfDay)

Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.

{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}

integer

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

integer

Minutes of hour of day. Must be from 0 to 59.

integer

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

{
  "specialHourPeriods": [
    {
      object (SpecialHourPeriod)
    }
  ]
}

object (SpecialHourPeriod)

Required. A list of exceptions to the business's regular hours.

{
  "startDate": {
    object (Date)
  },
  "openTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "closeTime": {
    object (TimeOfDay)
  },
  "closed": boolean
}

object (Date)

Required. The calendar date this special hour period starts on.

object (TimeOfDay)

Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if closed is false.

object (Date)

Optional. The calendar date this special hour period ends on. If endDate field is not set, default to the date specified in startDate. If set, this field must be equal to or at most 1 day after startDate.

object (TimeOfDay)

Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if closed is false.

boolean

Optional. If true, endDate, openTime, and closeTime are ignored, and the date specified in startDate is treated as the location being closed for the entire day.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

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

integer

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

integer

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.

{
  "businessType": enum (BusinessType),
  "places": {
    object (Places)
  },
  "regionCode": string
}

enum (BusinessType)

Required. Indicates the [type] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType] of the service area business.

object (Places)

The area that this business serves defined through a set of places.

string

Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise.

The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in).

If this location requires verification after creation, the address provided for verification purposes must be located within this region, and the business owner or their authorized representative must be able to receive postal mail at the provided verification address.

{
  "placeInfos": [
    {
      object (PlaceInfo)
    }
  ]
}

object (PlaceInfo)

The areas represented by place IDs. Limited to a maximum of 20 places.

{
  "placeName": string,
  "placeId": string
}

string

Required. The localized name of the place. For example, Scottsdale, AZ.

string

Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)

{
  "adPhone": string
}

string

Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.

{
  "latitude": number,
  "longitude": number
}

number

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

number

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

{
  "status": enum (OpenForBusiness),
  "canReopen": boolean,
  "openingDate": {
    object (Date)
  }
}

enum (OpenForBusiness)

Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.

boolean

Output only. Indicates whether this business is eligible for re-open.

object (Date)

Optional. The date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.

{
  "hasGoogleUpdated": boolean,
  "hasPendingEdits": boolean,
  "canDelete": boolean,
  "canOperateLocalPost": boolean,
  "canModifyServiceList": boolean,
  "canHaveFoodMenus": boolean,
  "canOperateHealthData": boolean,
  "canOperateLodgingData": boolean,
  "placeId": string,
  "duplicateLocation": string,
  "mapsUri": string,
  "newReviewUri": string,
  "canHaveBusinessCalls": boolean,
  "hasVoiceOfMerchant": boolean
}

boolean

Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the getGoogleUpdated method to lookup information that's needs to be verified.

boolean

Output only. Indicates whether any of this Location's properties are in the edit pending state.

boolean

Output only. Indicates whether the location can be deleted using the API.

boolean

Output only. Indicates if the listing can manage local posts.

boolean

Output only. Indicates if the listing can modify the service list.

boolean

Output only. Indicates if the listing is eligible for food menu.

boolean

Output only. Indicates whether the location can operate on Health data.

boolean

Output only. Indicates whether the location can operate on Lodging data.

string

Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs.

This field can be set during Create calls, but not for Update.

string

Output only. The location resource that this location duplicates.

string

Output only. A link to the location on Maps.

string

Output only. A link to the page on Google Search where a customer can leave a review for the location.

boolean

Output only. Indicates if the listing is eligible for business calls.

boolean

Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.

{
  "description": string
}

string

Required. Description of the location in your own voice, not editable by anyone else.

{
  "parentLocation": {
    object (RelevantLocation)
  },
  "childrenLocations": [
    {
      object (RelevantLocation)
    }
  ],
  "parentChain": string
}

object (RelevantLocation)

The parent location that this location has relations with.

object (RelevantLocation)

The list of children locations that this location has relations with.

string

The resource name of the Chain that this location is member of. [How to find Chain ID] [Locations.SearchChains]

{
  "placeId": string,
  "relationType": enum (RelationType)
}

string

Required. Specify the location that is on the other side of the relation by its placeID.

enum (RelationType)

Required. The type of the relationship.

{
  "hoursTypeId": string,
  "periods": [
    {
      object (TimePeriod)
    }
  ]
}

string

Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.

object (TimePeriod)

Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.

{
  "price": {
    object (Money)
  },

  // Union field service_item_info can be only one of the following:
  "structuredServiceItem": {
    object (StructuredServiceItem)
  },
  "freeFormServiceItem": {
    object (FreeFormServiceItem)
  }
  // End of list of possible types for union field service_item_info.
}

object (Money)

Optional. Represents the monetary price of the service item. We recommend that currencyCode and units should be set when including a price. This will be treated as a fixed price for the service item.

object (StructuredServiceItem)

Optional. This field will be set case of structured services data.

object (FreeFormServiceItem)

Optional. This field will be set case of free-form services data.

{
  "serviceTypeId": string,
  "description": string
}

string

Required. The serviceTypeId field is a Google provided unique ID that can be found in ServiceType. This information is provided by categories.batchGet rpc service.

string

Optional. Description of structured service item. The character limit is 300.

{
  "category": string,
  "label": {
    object (Label)
  }
}

string

Required. This field represents the category name (i.e. the category's stable ID). The category and serviceTypeId should match the possible combinations provided in the Category message.

object (Label)

Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated via serviceTypeId.

{
  "displayName": string,
  "description": string,
  "languageCode": string
}

string

Required. Display name for the price list, section, or item.

string

Optional. Description of the price list, section, or item.

string

Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.

{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}

string

The three-letter currency code defined in ISO 4217.

string (int64 format)

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

integer

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.