BusinessProfilePerformance

import { BusinessProfilePerformance } from "https://googleapis.deno.dev/v1/businessprofileperformance:v1.ts";

The Business Profile Performance API allows merchants to fetch performance reports about their business profile on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.

class BusinessProfilePerformance {

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

async locationsFetchMultiDailyMetricsTimeSeries(location: string, opts?: LocationsFetchMultiDailyMetricsTimeSeriesOptions): Promise<FetchMultiDailyMetricsTimeSeriesResponse>;

async locationsGetDailyMetricsTimeSeries(name: string, opts?: LocationsGetDailyMetricsTimeSeriesOptions): Promise<GetDailyMetricsTimeSeriesResponse>;

async locationsSearchkeywordsImpressionsMonthlyList(parent: string, opts?: LocationsSearchkeywordsImpressionsMonthlyListOptions): Promise<ListSearchKeywordImpressionsMonthlyResponse>;

}

§Constructors

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

[src]

§Methods

locationsFetchMultiDailyMetricsTimeSeries(location: string, opts?: LocationsFetchMultiDailyMetricsTimeSeriesOptions): Promise<FetchMultiDailyMetricsTimeSeriesResponse>

[src]

Returns the values for each date from a given time range and optionally the sub entity type, where applicable, that are associated with the specific daily metrics. Example request: GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31

@param location

Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.

locationsGetDailyMetricsTimeSeries(name: string, opts?: LocationsGetDailyMetricsTimeSeriesOptions): Promise<GetDailyMetricsTimeSeriesResponse>

[src]

Returns the values for each date from a given time range that are associated with the specific daily metric. Example request: GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31

@param name

Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.

locationsSearchkeywordsImpressionsMonthlyList(parent: string, opts?: LocationsSearchkeywordsImpressionsMonthlyListOptions): Promise<ListSearchKeywordImpressionsMonthlyResponse>

[src]

Returns the search keywords used to find a business in search or maps. Each search keyword is accompanied by impressions which are aggregated on a monthly basis. Example request: GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.start_month.year=2022&monthly_range.start_month.month=1&monthly_range.end_month.year=2022&monthly_range.end_month.month=3

@param parent

Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.