Google Business Profile SDK

Appearance

VS Code Extension
Ludo Player
Play Ludo directly in your VS Code editor.
by VitableTech

@vitabletech/gbp-sdk

Constructors ​

Constructor ​

new LocationsService(client): LocationsService

Parameters ​

client ​

HttpClient

Returns ​

LocationsService

Accessors ​

searchkeywords ​

Get Signature ​

get searchkeywords(): object

REST resource accessor for locations.searchkeywords.impressions.monthly.

Returns ​

object

impressions ​

impressions: object

impressions.monthly ​

monthly: object

impressions.monthly.list ​

list: (locationId, request) => Promise<ListSearchKeywordsImpressionsMonthlyResponse>

Parameters ​
locationId ​

string

request ​

ListSearchKeywordsImpressionsMonthlyRequest

Returns ​

Promise<ListSearchKeywordsImpressionsMonthlyResponse>

impressions.monthly.listAll ​

listAll: (locationId, request) => Promise<SearchKeywordCount[]>

Parameters ​
locationId ​

string

request ​

Omit<ListSearchKeywordsImpressionsMonthlyRequest, "pageToken">

Returns ​

Promise<SearchKeywordCount[]>

impressions.monthly.listPaginator ​

listPaginator: (locationId, request) => CursorPaginator<SearchKeywordCount>

Parameters ​
locationId ​

string

request ​

ListSearchKeywordsImpressionsMonthlyRequest

Returns ​

CursorPaginator<SearchKeywordCount>

searchKeywords ​

Get Signature ​

get searchKeywords(): object

CamelCase alias for searchkeywords REST resource accessor.

Returns ​

object

impressions ​

impressions: object

impressions.monthly ​

monthly: object

impressions.monthly.list ​

list: (locationId, request) => Promise<ListSearchKeywordsImpressionsMonthlyResponse>

Parameters ​
locationId ​

string

request ​

ListSearchKeywordsImpressionsMonthlyRequest

Returns ​

Promise<ListSearchKeywordsImpressionsMonthlyResponse>

impressions.monthly.listAll ​

listAll: (locationId, request) => Promise<SearchKeywordCount[]>

Parameters ​
locationId ​

string

request ​

Omit<ListSearchKeywordsImpressionsMonthlyRequest, "pageToken">

Returns ​

Promise<SearchKeywordCount[]>

impressions.monthly.listPaginator ​

listPaginator: (locationId, request) => CursorPaginator<SearchKeywordCount>

Parameters ​
locationId ​

string

request ​

ListSearchKeywordsImpressionsMonthlyRequest

Returns ​

CursorPaginator<SearchKeywordCount>

Methods ​

create() ​

create(accountId, data, options?): Promise<any>

Creates a new location.

Parameters ​

accountId ​

string

data ​

any

options? ​
requestId? ​

string

validateOnly? ​

boolean

Returns ​

Promise<any>

delete() ​

delete(locationId): Promise<void>

Deletes a location.

Parameters ​

locationId ​

string

Returns ​

Promise<void>

fetchMultiDailyMetricsTimeSeries() ​

fetchMultiDailyMetricsTimeSeries(locationId, request): Promise<FetchMultiDailyMetricsTimeSeriesResponse>

Returns a report containing multi daily performance metrics for a location. Shortcut to MetricsService.fetchMultiDailyMetricsTimeSeries.

Parameters ​

locationId ​

string

The location ID.

request ​

PerformanceMetricsRequest

The PerformanceMetricsRequest containing dailyMetrics and dailyRange.

Returns ​

Promise<FetchMultiDailyMetricsTimeSeriesResponse>

get() ​

get(locationId, options?): Promise<any>

Gets a specific location by ID.

Parameters ​

locationId ​

string

options? ​
readMask? ​

string

Returns ​

Promise<any>

getAttributes() ​

getAttributes(locationId): Promise<any>

Gets attributes for a location.

Parameters ​

locationId ​

string

Returns ​

Promise<any>

getDailyMetricsTimeSeries() ​

getDailyMetricsTimeSeries(locationId, request): Promise<GetDailyMetricsTimeSeriesResponse>

Returns daily metrics time series for a location. Shortcut to MetricsService.getDailyMetricsTimeSeries.

Parameters ​

locationId ​

string

The location ID.

request ​

GetDailyMetricsTimeSeriesRequest

The GetDailyMetricsTimeSeriesRequest containing dailyMetric, dailyRange, and optional dailySubEntityType.

Returns ​

Promise<GetDailyMetricsTimeSeriesResponse>

getMetadata() ​

getMetadata(locationId): Promise<any>

Retrieves metadata for a location.

Parameters ​

locationId ​

string

Returns ​

Promise<any>

getSearchKeywordsImpressionsMonthly() ​

getSearchKeywordsImpressionsMonthly(locationId, request): Promise<ListSearchKeywordsImpressionsMonthlyResponse>

Alias for listSearchKeywordsImpressionsMonthly.

Parameters ​

locationId ​

string

request ​

ListSearchKeywordsImpressionsMonthlyRequest

Returns ​

Promise<ListSearchKeywordsImpressionsMonthlyResponse>

getServiceItems() ​

getServiceItems(locationId): Promise<any>

Retrieves service items for a location.

Parameters ​

locationId ​

string

Returns ​

Promise<any>

list() ​

list(accountId, options?): Promise<any>

Lists all locations for a specific account.

Parameters ​

accountId ​

string

options? ​
pageToken? ​

string

readMask? ​

string

Returns ​

Promise<any>

listAll() ​

listAll(accountId, readMask?): Promise<any[]>

Automatically fetches all locations for an account.

Parameters ​

accountId ​

string

readMask? ​

string = 'name,title,storeCode,websiteUri,phoneNumbers,regularHours'

Returns ​

Promise<any[]>

listAllSearchKeywordsImpressionsMonthly() ​

listAllSearchKeywordsImpressionsMonthly(locationId, request): Promise<SearchKeywordCount[]>

Automatically fetches all search keywords impressions across all pages for a location. Shortcut to MetricsService.listAllSearchKeywordsImpressionsMonthly.

Parameters ​

locationId ​

string

request ​

Omit<ListSearchKeywordsImpressionsMonthlyRequest, "pageToken">

Returns ​

Promise<SearchKeywordCount[]>

listPaginator() ​

listPaginator(accountId, options?): CursorPaginator<any>

Returns a paginator object to manually fetch locations page by page.

Parameters ​

accountId ​

string

options? ​
pageSize? ​

number

readMask? ​

string

Returns ​

CursorPaginator<any>

listSearchKeywordsImpressionsMonthly() ​

listSearchKeywordsImpressionsMonthly(locationId, request): Promise<ListSearchKeywordsImpressionsMonthlyResponse>

Returns search keywords impressions monthly for a location. Shortcut to MetricsService.listSearchKeywordsImpressionsMonthly.

Parameters ​

locationId ​

string

The location ID.

request ​

ListSearchKeywordsImpressionsMonthlyRequest

The ListSearchKeywordsImpressionsMonthlyRequest containing monthlyRange and pagination options.

Returns ​

Promise<ListSearchKeywordsImpressionsMonthlyResponse>

listSearchKeywordsImpressionsMonthlyPaginator() ​

listSearchKeywordsImpressionsMonthlyPaginator(locationId, request): CursorPaginator<SearchKeywordCount>

Returns a cursor paginator to fetch search keywords impressions page by page for a location. Shortcut to MetricsService.listSearchKeywordsImpressionsMonthlyPaginator.

Parameters ​

locationId ​

string

request ​

ListSearchKeywordsImpressionsMonthlyRequest

Returns ​

CursorPaginator<SearchKeywordCount>

patch() ​

patch(locationId, data, updateMask): Promise<any>

Updates an existing location.

Parameters ​

locationId ​

string

data ​

any

updateMask ​

string

Returns ​

Promise<any>

patchAttributes() ​

patchAttributes(locationId, data, attributeMask): Promise<any>

Updates attributes for a location.

Parameters ​

locationId ​

string

data ​

any

attributeMask ​

string

Returns ​

Promise<any>

updateServiceItems() ​

updateServiceItems(locationId, serviceItems): Promise<any>

Updates service items for a location.

Parameters ​

locationId ​

string

serviceItems ​

any[]

Returns ​

Promise<any>