Constructors
Constructor
new MetricsService(
client):MetricsService
Parameters
client
Returns
MetricsService
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
fetchMultiDailyMetricsTimeSeries()
fetchMultiDailyMetricsTimeSeries(
locationId,request):Promise<FetchMultiDailyMetricsTimeSeriesResponse>
Returns a report containing performance metrics by location. Note: This uses the Business Profile Performance API v1.
Parameters
locationId
string
The location ID.
request
The PerformanceMetricsRequest containing dailyMetrics and dailyRange.
Returns
Promise<FetchMultiDailyMetricsTimeSeriesResponse>
getDailyMetricsTimeSeries()
getDailyMetricsTimeSeries(
locationId,request):Promise<GetDailyMetricsTimeSeriesResponse>
Returns daily metrics time series for a location. Note: This uses the Business Profile Performance API v1.
Parameters
locationId
string
The location ID.
request
GetDailyMetricsTimeSeriesRequest
The GetDailyMetricsTimeSeriesRequest containing dailyMetric, dailyRange, and optional dailySubEntityType.
Returns
Promise<GetDailyMetricsTimeSeriesResponse>
getSearchKeywordsImpressionsMonthly()
getSearchKeywordsImpressionsMonthly(
locationId,request):Promise<ListSearchKeywordsImpressionsMonthlyResponse>
Alias for listSearchKeywordsImpressionsMonthly.
Parameters
locationId
string
request
ListSearchKeywordsImpressionsMonthlyRequest
Returns
Promise<ListSearchKeywordsImpressionsMonthlyResponse>
listAllSearchKeywordsImpressionsMonthly()
listAllSearchKeywordsImpressionsMonthly(
locationId,request):Promise<SearchKeywordCount[]>
Automatically fetches all search keywords impressions across all pages.
Parameters
locationId
string
request
Omit<ListSearchKeywordsImpressionsMonthlyRequest, "pageToken">
Returns
Promise<SearchKeywordCount[]>
listSearchKeywordsImpressionsMonthly()
listSearchKeywordsImpressionsMonthly(
locationId,request):Promise<ListSearchKeywordsImpressionsMonthlyResponse>
Returns search keywords impressions monthly for a location. Note: This uses the Business Profile Performance API v1.
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.
Parameters
locationId
string
request
ListSearchKeywordsImpressionsMonthlyRequest