MyBusinessBusinessInformation

import { MyBusinessBusinessInformation } from "https://googleapis.deno.dev/v1/mybusinessbusinessinformation:v1.ts";

The My Business Business Information API provides an interface for managing business information. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.

class MyBusinessBusinessInformation {

constructor(client?: CredentialsClient, baseUrl?: string);

async accountsLocationsCreate(

parent: string,

req: Location,

opts?: AccountsLocationsCreateOptions,

): Promise<Location>;

async accountsLocationsList(parent: string, opts?: AccountsLocationsListOptions): Promise<ListLocationsResponse>;

async attributesList(opts?: AttributesListOptions): Promise<ListAttributeMetadataResponse>;

async categoriesBatchGet(opts?: CategoriesBatchGetOptions): Promise<BatchGetCategoriesResponse>;

async categoriesList(opts?: CategoriesListOptions): Promise<ListCategoriesResponse>;

async chainsGet(name: string): Promise<Chain>;

async chainsSearch(opts?: ChainsSearchOptions): Promise<SearchChainsResponse>;

async googleLocationsSearch(req: SearchGoogleLocationsRequest): Promise<SearchGoogleLocationsResponse>;

async locationsAttributesGetGoogleUpdated(name: string): Promise<Attributes>;

async locationsDelete(name: string): Promise<Empty>;

async locationsGet(name: string, opts?: LocationsGetOptions): Promise<Location>;

async locationsGetAttributes(name: string): Promise<Attributes>;

async locationsGetGoogleUpdated(name: string, opts?: LocationsGetGoogleUpdatedOptions): Promise<GoogleUpdatedLocation>;

async locationsPatch(

name: string,

req: Location,

opts?: LocationsPatchOptions,

): Promise<Location>;

async locationsUpdateAttributes(

name: string,

req: Attributes,

opts?: LocationsUpdateAttributesOptions,

): Promise<Attributes>;

}

§Constructors

new MyBusinessBusinessInformation(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

accountsLocationsCreate(parent: string, req: Location, opts?: AccountsLocationsCreateOptions): Promise<Location>

[src]

Creates a new Location that will be owned by the logged in user.

@param parent

Required. The name of the account in which to create this location.

accountsLocationsList(parent: string, opts?: AccountsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists the locations for the specified account.

@param parent

Required. The name of the account to fetch locations from. If the parent Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly.

attributesList(opts?: AttributesListOptions): Promise<ListAttributeMetadataResponse>

[src]

Returns the list of attributes that would be available for a location with the given primary category and country.

categoriesBatchGet(opts?: CategoriesBatchGetOptions): Promise<BatchGetCategoriesResponse>

[src]

Returns a list of business categories for the provided language and GConcept ids.

chainsGet(name: string): Promise<Chain>

[src]

Gets the specified chain. Returns NOT_FOUND if the chain does not exist.

@param name

Required. The chain's resource name, in the format chains/{chain_place_id}.

chainsSearch(opts?: ChainsSearchOptions): Promise<SearchChainsResponse>

[src]

Searches the chain based on chain name.

googleLocationsSearch(req: SearchGoogleLocationsRequest): Promise<SearchGoogleLocationsResponse>

[src]

Search all of the possible locations that are a match to the specified request.

locationsAttributesGetGoogleUpdated(name: string): Promise<Attributes>

[src]

Gets the Google-updated version of the specified location.

@param name

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

locationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

Required. The name of the location to delete.

locationsGet(name: string, opts?: LocationsGetOptions): Promise<Location>

[src]

Returns the specified location.

@param name

Required. The name of the location to fetch.

locationsGetAttributes(name: string): Promise<Attributes>

[src]

Looks up all the attributes set for a given location.

@param name

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

locationsGetGoogleUpdated(name: string, opts?: LocationsGetGoogleUpdatedOptions): Promise<GoogleUpdatedLocation>

[src]

Gets the Google-updated version of the specified location.

@param name

Required. The name of the location to fetch.

locationsPatch(name: string, req: Location, opts?: LocationsPatchOptions): Promise<Location>

[src]

Updates the specified location.

@param name

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

locationsUpdateAttributes(name: string, req: Attributes, opts?: LocationsUpdateAttributesOptions): Promise<Attributes>

[src]

Update attributes for a given location.

@param name

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