Location (My Business Business Information API v1-rev20250723-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.mybusinessbusinessinformation.v1.model.Location

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Location
extends com.google.api.client.json.GenericJson
```
A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my- business/reference/rest/v4/categories) for a list of valid business categories.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the My Business Business Information API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Location()

Constructors
Constructor and Description
`Location()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Location`	`clone()`
`AdWordsLocationExtensions`	`getAdWordsLocationExtensions()` Optional.
`Categories`	`getCategories()` Optional.
`List<String>`	`getLabels()` Optional.
`String`	`getLanguageCode()` Immutable.
`LatLng`	`getLatlng()` Optional.
`Metadata`	`getMetadata()` Output only.
`List<MoreHours>`	`getMoreHours()` Optional.
`String`	`getName()` Google identifier for this location in the form: `locations/{location_id}`.
`OpenInfo`	`getOpenInfo()` Optional.
`PhoneNumbers`	`getPhoneNumbers()` Optional.
`Profile`	`getProfile()` Optional.
`BusinessHours`	`getRegularHours()` Optional.
`RelationshipData`	`getRelationshipData()` Optional.
`ServiceAreaBusiness`	`getServiceArea()` Optional.
`List<ServiceItem>`	`getServiceItems()` Optional.
`SpecialHours`	`getSpecialHours()` Optional.
`String`	`getStoreCode()` Optional.
`PostalAddress`	`getStorefrontAddress()` Optional.
`String`	`getTitle()` Required.
`String`	`getWebsiteUri()` Optional.
`Location`	`set(String fieldName, Object value)`
`Location`	`setAdWordsLocationExtensions(AdWordsLocationExtensions adWordsLocationExtensions)` Optional.
`Location`	`setCategories(Categories categories)` Optional.
`Location`	`setLabels(List<String> labels)` Optional.
`Location`	`setLanguageCode(String languageCode)` Immutable.
`Location`	`setLatlng(LatLng latlng)` Optional.
`Location`	`setMetadata(Metadata metadata)` Output only.
`Location`	`setMoreHours(List<MoreHours> moreHours)` Optional.
`Location`	`setName(String name)` Google identifier for this location in the form: `locations/{location_id}`.
`Location`	`setOpenInfo(OpenInfo openInfo)` Optional.
`Location`	`setPhoneNumbers(PhoneNumbers phoneNumbers)` Optional.
`Location`	`setProfile(Profile profile)` Optional.
`Location`	`setRegularHours(BusinessHours regularHours)` Optional.
`Location`	`setRelationshipData(RelationshipData relationshipData)` Optional.
`Location`	`setServiceArea(ServiceAreaBusiness serviceArea)` Optional.
`Location`	`setServiceItems(List<ServiceItem> serviceItems)` Optional.
`Location`	`setSpecialHours(SpecialHours specialHours)` Optional.
`Location`	`setStoreCode(String storeCode)` Optional.
`Location`	`setStorefrontAddress(PostalAddress storefrontAddress)` Optional.
`Location`	`setTitle(String title)` Required.
`Location`	`setWebsiteUri(String websiteUri)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Location
```
public Location()
```
- Method Detail
  - getAdWordsLocationExtensions
```
public AdWordsLocationExtensions getAdWordsLocationExtensions()
```
    Optional. Additional information that is surfaced in AdWords.
    
    Returns:
    
    value or null for none
  - setAdWordsLocationExtensions
```
public Location setAdWordsLocationExtensions(AdWordsLocationExtensions adWordsLocationExtensions)
```
    Optional. Additional information that is surfaced in AdWords.
    
    Parameters:
    
    adWordsLocationExtensions - adWordsLocationExtensions or null for none
  - getCategories
```
public Categories getCategories()
```
    Optional. The different categories that describe the business.
    
    Returns:
    
    value or null for none
  - setCategories
```
public Location setCategories(Categories categories)
```
    Optional. The different categories that describe the business.
    
    Parameters:
    
    categories - categories or null for none
  - getLabels
```
public List<String> getLabels()
```
    Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Location setLabels(List<String> labels)
```
    Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
    
    Parameters:
    
    labels - labels or null for none
  - getLanguageCode
```
public String getLanguageCode()
```
    Immutable. The language of the location. Set during creation and not updateable.
    
    Returns:
    
    value or null for none
  - setLanguageCode
```
public Location setLanguageCode(String languageCode)
```
    Immutable. The language of the location. Set during creation and not updateable.
    
    Parameters:
    
    languageCode - languageCode or null for none
  - getLatlng
```
public LatLng getLatlng()
```
    Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
    
    Returns:
    
    value or null for none
  - setLatlng
```
public Location setLatlng(LatLng latlng)
```
    Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
    
    Parameters:
    
    latlng - latlng or null for none
  - getMetadata
```
public Metadata getMetadata()
```
    Output only. Additional non-user-editable information.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Location setMetadata(Metadata metadata)
```
    Output only. Additional non-user-editable information.
    
    Parameters:
    
    metadata - metadata or null for none
  - getMoreHours
```
public List<MoreHours> getMoreHours()
```
    Optional. More hours for a business's different departments or specific customers.
    
    Returns:
    
    value or null for none
  - setMoreHours
```
public Location setMoreHours(List<MoreHours> moreHours)
```
    Optional. More hours for a business's different departments or specific customers.
    
    Parameters:
    
    moreHours - moreHours or null for none
  - getName
```
public String getName()
```
    Google identifier for this location in the form: `locations/{location_id}`.
    
    Returns:
    
    value or null for none
  - setName
```
public Location setName(String name)
```
    Google identifier for this location in the form: `locations/{location_id}`.
    
    Parameters:
    
    name - name or null for none
  - getOpenInfo
```
public OpenInfo getOpenInfo()
```
    Optional. A flag that indicates whether the location is currently open for business.
    
    Returns:
    
    value or null for none
  - setOpenInfo
```
public Location setOpenInfo(OpenInfo openInfo)
```
    Optional. A flag that indicates whether the location is currently open for business.
    
    Parameters:
    
    openInfo - openInfo or null for none
  - getPhoneNumbers
```
public PhoneNumbers getPhoneNumbers()
```
    Optional. The different phone numbers that customers can use to get in touch with the business.
    
    Returns:
    
    value or null for none
  - setPhoneNumbers
```
public Location setPhoneNumbers(PhoneNumbers phoneNumbers)
```
    Optional. The different phone numbers that customers can use to get in touch with the business.
    
    Parameters:
    
    phoneNumbers - phoneNumbers or null for none
  - getProfile
```
public Profile getProfile()
```
    Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns).
    
    Returns:
    
    value or null for none
  - setProfile
```
public Location setProfile(Profile profile)
```
    Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns).
    
    Parameters:
    
    profile - profile or null for none
  - getRegularHours
```
public BusinessHours getRegularHours()
```
    Optional. Operating hours for the business.
    
    Returns:
    
    value or null for none
  - setRegularHours
```
public Location setRegularHours(BusinessHours regularHours)
```
    Optional. Operating hours for the business.
    
    Parameters:
    
    regularHours - regularHours or null for none
  - getRelationshipData
```
public RelationshipData getRelationshipData()
```
    Optional. All locations and chain related to this one.
    
    Returns:
    
    value or null for none
  - setRelationshipData
```
public Location setRelationshipData(RelationshipData relationshipData)
```
    Optional. All locations and chain related to this one.
    
    Parameters:
    
    relationshipData - relationshipData or null for none
  - getServiceArea
```
public ServiceAreaBusiness getServiceArea()
```
    Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
    
    Returns:
    
    value or null for none
  - setServiceArea
```
public Location setServiceArea(ServiceAreaBusiness serviceArea)
```
    Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
    
    Parameters:
    
    serviceArea - serviceArea or null for none
  - getServiceItems
```
public List<ServiceItem> getServiceItems()
```
    Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
    
    Returns:
    
    value or null for none
  - setServiceItems
```
public Location setServiceItems(List<ServiceItem> serviceItems)
```
    Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
    
    Parameters:
    
    serviceItems - serviceItems or null for none
  - getSpecialHours
```
public SpecialHours getSpecialHours()
```
    Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
    
    Returns:
    
    value or null for none
  - setSpecialHours
```
public Location setSpecialHours(SpecialHours specialHours)
```
    Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
    
    Parameters:
    
    specialHours - specialHours or null for none
  - getStoreCode
```
public String getStoreCode()
```
    Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
    
    Returns:
    
    value or null for none
  - setStoreCode
```
public Location setStoreCode(String storeCode)
```
    Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
    
    Parameters:
    
    storeCode - storeCode or null for none
  - getStorefrontAddress
```
public PostalAddress getStorefrontAddress()
```
    Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
    
    Returns:
    
    value or null for none
  - setStorefrontAddress
```
public Location setStorefrontAddress(PostalAddress storefrontAddress)
```
    Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
    
    Parameters:
    
    storefrontAddress - storefrontAddress or null for none
  - getTitle
```
public String getTitle()
```
    Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
    
    Returns:
    
    value or null for none
  - setTitle
```
public Location setTitle(String title)
```
    Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
    
    Parameters:
    
    title - title or null for none
  - getWebsiteUri
```
public String getWebsiteUri()
```
    Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
    
    Returns:
    
    value or null for none
  - setWebsiteUri
```
public Location setWebsiteUri(String websiteUri)
```
    Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
    
    Parameters:
    
    websiteUri - websiteUri or null for none
  - set
```
public Location set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Location clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Location

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Location

Method Detail

getAdWordsLocationExtensions

setAdWordsLocationExtensions

getCategories

setCategories

getLabels

setLabels

getLanguageCode

setLanguageCode

getLatlng

setLatlng

getMetadata

setMetadata

getMoreHours

setMoreHours

getName

setName

getOpenInfo

setOpenInfo

getPhoneNumbers

setPhoneNumbers

getProfile

setProfile

getRegularHours

setRegularHours

getRelationshipData

setRelationshipData

getServiceArea

setServiceArea

getServiceItems

setServiceItems

getSpecialHours

setSpecialHours

getStoreCode

setStoreCode

getStorefrontAddress

setStorefrontAddress

getTitle

setTitle

getWebsiteUri

setWebsiteUri

set

clone