The Business Profile Performance API is now launched! Migration work is required.
Review the deprecation schedule and instructions to migrate over to new v1 APIs from older deprecated v4 API.

Package google.mybusiness.performance.v1

Stay organized with collections Save and categorize content based on your preferences.

Index

PerformanceService

This service allows merchants to fetch performance reports about their business profile on Google.

API attempts to follow guidelines found on aip.dev.

GetDailyMetricsTimeSeries

rpc GetDailyMetricsTimeSeries(GetDailyMetricsTimeSeriesRequest) returns (GetDailyMetricsTimeSeriesResponse)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

ListSearchKeywordImpressionsMonthly

rpc ListSearchKeywordImpressionsMonthly(ListSearchKeywordImpressionsMonthlyRequest) returns (ListSearchKeywordImpressionsMonthlyResponse)

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

DailyMetric

Represents all available daily metrics for a business.

Enums
DAILY_METRIC_UNKNOWN Represents the default unknown value.
BUSINESS_IMPRESSIONS_DESKTOP_MAPS Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.
BUSINESS_IMPRESSIONS_MOBILE_MAPS Business impressions on Google Maps on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.
BUSINESS_CONVERSATIONS The number of message conversations received on the business profile.
BUSINESS_DIRECTION_REQUESTS The number of times a direction request was requested to the business location.
CALL_CLICKS The number of times the business profile call button was clicked.
WEBSITE_CLICKS The number of times the business profile website was clicked.
BUSINESS_BOOKINGS The number of bookings received from the business profile.
BUSINESS_FOOD_ORDERS The number of food orders received from the business profile.

DailyRange

Time range indicating a date range (both inclusive).

Fields
start_date

Date

Required. Inclusive

end_date

Date

Required. Inclusive

DailySubEntityType

Represents all possible subentity types that are associated with DailyMetrics.

Fields
Union field Type. Represents that only one of the following proto fields must be present. Type can be only one of the following:
day_of_week

DayOfWeek

Represents the day of the week. Eg: MONDAY.

time_of_day

TimeOfDay

Represents the time of the day in 24 hour format. Eg: 13:34:20

DatedValue

Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.

Fields
date

Date

The date that the datapoint corresponds to. This represents a month value if the day field is not set.

value

int64

The value of the datapoint.

GetDailyMetricsTimeSeriesRequest

Represents the request for GetDailyMetricsTimeSeries.

Fields
name

string

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

daily_metric

DailyMetric

Required. The metric to retrieve time series.

daily_range

DailyRange

Required. The timerange for which the time series will be fetched.

daily_sub_entity_type

DailySubEntityType

Optional. The Sub-entity type and id that the time series relates to.

GetDailyMetricsTimeSeriesResponse

Represents the response for GetDailyMetricsTimeSeries.

Fields
time_series

TimeSeries

The daily time series.

InsightsValue

Represents an insights value.

Fields
Union field InsightsValue. Represents that only one of the following proto fields must be present. InsightsValue can be only one of the following:
value

int64

Represents the actual value.

threshold

int64

Represents the threshold below which the actual value falls.

ListSearchKeywordImpressionsMonthlyRequest

Represents the request for ListSearchKeywordImpressionsMonthly.

Fields
parent

string

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

monthly_range

MonthlyRange

Required. The range in months to aggregate the search keywords impressions over.

page_size

int32

Optional. The number of results requested. The default page size is 100. Page size can be set to a maximum of 100.

page_token

bytes

Optional. A token indicating the next paginated result to be returned.

ListSearchKeywordImpressionsMonthlyResponse

Represents the response for ListSearchKeywordImpressionsMonthly.

Fields
search_keywords_counts[]

SearchKeywordCount

Search terms which have been used to find a business.

next_page_token

bytes

A token indicating the last paginated result returned. This can be used by succeeding requests to get the next "page" of keywords. It will only be present when there are more results to be returned.

MonthlyRange

Time range indicating a month range (both inclusive).

Fields
start_month

Date

Required. Inclusive - Only the year and months fields will be considered

end_month

Date

Required. Inclusive - Only the year and months fields will be considered

SearchKeywordCount

Represents a single search keyword and its value.

Fields
search_keyword

string

The lower-cased string that the user entered.

insights_value

InsightsValue

One of either: 1) The sum of the number of unique users that used the keyword in a month, aggregated for each month requested. 2) A threshold that indicates that the actual value is below this threshold.

TimeSeries

Represents a timeseries.

Fields
dated_values[]

DatedValue

List of datapoints in the timeseries, where each datapoint is a date-value pair.