class Locations extends Resource (View source)

The "locations" collection of methods.

Typical usage is:

 $mybusinessbusinessinformationService = new Google\Service\MyBusinessBusinessInformation(...);
 $locations = $mybusinessbusinessinformationService->locations;

Methods

delete(string $name, array $optParams = [])

Deletes a location. If this location cannot be deleted using the API and it is marked so in the google.mybusiness.businessinformation.v1.LocationState, use the Google Business Profile website. (locations.delete)

get(string $name, array $optParams = [])

Returns the specified location. (locations.get)

getAttributes(string $name, array $optParams = [])

Looks up all the attributes set for a given location.

getGoogleUpdated(string $name, array $optParams = [])

Gets the Google-updated version of the specified location.

patch(string $name, Location $postBody, array $optParams = [])

Updates the specified location. (locations.patch)

updateAttributes(string $name, Attributes $postBody, array $optParams = [])

Update attributes for a given location. (locations.updateAttributes)

Details

MybusinessbusinessinformationEmpty delete(string $name, array $optParams = [])

Deletes a location. If this location cannot be deleted using the API and it is marked so in the google.mybusiness.businessinformation.v1.LocationState, use the Google Business Profile website. (locations.delete)

Parameters

string $name

Required. The name of the location to delete.

array $optParams

Optional parameters.

Return Value

MybusinessbusinessinformationEmpty

Exceptions

Exception

Location get(string $name, array $optParams = [])

Returns the specified location. (locations.get)

Parameters

string $name

Required. The name of the location to fetch.

array $optParams

Optional parameters.

Return Value

Location

Exceptions

Exception

Attributes getAttributes(string $name, array $optParams = [])

Looks up all the attributes set for a given location.

(locations.getAttributes)

Parameters

string $name

Required. Google identifier for this location in the form of locations/{location_id}/attributes.

array $optParams

Optional parameters.

Return Value

Attributes

Exceptions

Exception

GoogleUpdatedLocation getGoogleUpdated(string $name, array $optParams = [])

Gets the Google-updated version of the specified location.

(locations.getGoogleUpdated)

Parameters

string $name

Required. The name of the location to fetch.

array $optParams

Optional parameters.

Return Value

GoogleUpdatedLocation

Exceptions

Exception

Location patch(string $name, Location $postBody, array $optParams = [])

Updates the specified location. (locations.patch)

Parameters

string $name

Google identifier for this location in the form: locations/{location_id}.

Location $postBody
array $optParams

Optional parameters.

Return Value

Location

Exceptions

Exception

Attributes updateAttributes(string $name, Attributes $postBody, array $optParams = [])

Update attributes for a given location. (locations.updateAttributes)

Parameters

string $name

Required. Google identifier for this location in the form of locations/{location_id}/attributes.

Attributes $postBody
array $optParams

Optional parameters.

Return Value

Attributes

Exceptions

Exception