{ "rootUrl": "https://businessprofileperformance.googleapis.com/", "ownerDomain": "google.com", "title": "Business Profile Performance API", "description": "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.", "version_module": true, "discoveryVersion": "v1", "ownerName": "Google", "version": "v1", "documentationLink": "https://developers.google.com/my-business/", "protocol": "rest", "canonicalName": "Business Profile Performance", "parameters": { "callback": { "type": "string", "location": "query", "description": "JSONP" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "$.xgafv": { "location": "query", "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "alt": { "description": "Data format for response.", "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "default": "json" }, "prettyPrint": { "default": "true", "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "resources": { "locations": { "methods": { "getDailyMetricsTimeSeries": { "parameterOrder": [ "name" ], "response": { "$ref": "GetDailyMetricsTimeSeriesResponse" }, "description": " Returns the values for each date from a given time range that are associated with the specific daily metric. Note: Only daily data is available. Hourly metrics are not supported. 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`", "id": "businessprofileperformance.locations.getDailyMetricsTimeSeries", "path": "v1/{+name}:getDailyMetricsTimeSeries", "parameters": { "dailyRange.endDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "location": "query", "type": "integer" }, "dailySubEntityType.timeOfDay.hours": { "location": "query", "type": "integer", "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32" }, "dailySubEntityType.dayOfWeek": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "description": "Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.", "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "location": "query" }, "dailySubEntityType.timeOfDay.seconds": { "location": "query", "type": "integer", "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32" }, "dailyRange.endDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "location": "query", "type": "integer" }, "dailySubEntityType.timeOfDay.nanos": { "location": "query", "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32" }, "dailyRange.startDate.year": { "location": "query", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "dailyRange.startDate.day": { "location": "query", "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32" }, "dailyRange.endDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "location": "query", "type": "integer" }, "dailyMetric": { "type": "string", "enumDescriptions": [ "Represents the default unknown value.", "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 on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", "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 impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", "The number of message conversations received on the business profile.", "The number of times a direction request was requested to the business location.", "The number of times the business profile call button was clicked.", "The number of times the business profile website was clicked.", "The number of bookings made from the business profile via Reserve with Google.", "The number of food orders received from the business profile.", "The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1." ], "description": "Required. The metric to retrieve time series.", "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, true, false ], "enum": [ "DAILY_METRIC_UNKNOWN", "BUSINESS_IMPRESSIONS_DESKTOP_MAPS", "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH", "BUSINESS_IMPRESSIONS_MOBILE_MAPS", "BUSINESS_IMPRESSIONS_MOBILE_SEARCH", "BUSINESS_CONVERSATIONS", "BUSINESS_DIRECTION_REQUESTS", "CALL_CLICKS", "WEBSITE_CLICKS", "BUSINESS_BOOKINGS", "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], "location": "query" }, "name": { "pattern": "^locations/[^/]+$", "type": "string", "description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.", "location": "path", "required": true }, "dailyRange.startDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "location": "query", "type": "integer" }, "dailySubEntityType.timeOfDay.minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "location": "query", "type": "integer" } }, "flatPath": "v1/locations/{locationsId}:getDailyMetricsTimeSeries", "httpMethod": "GET" }, "fetchMultiDailyMetricsTimeSeries": { "path": "v1/{+location}:fetchMultiDailyMetricsTimeSeries", "parameters": { "dailyRange.startDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "location": "query", "type": "integer" }, "dailyMetrics": { "repeated": true, "location": "query", "description": "Required. The metrics to retrieve time series for.", "type": "string", "enumDescriptions": [ "Represents the default unknown value.", "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 on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", "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 impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", "The number of message conversations received on the business profile.", "The number of times a direction request was requested to the business location.", "The number of times the business profile call button was clicked.", "The number of times the business profile website was clicked.", "The number of bookings made from the business profile via Reserve with Google.", "The number of food orders received from the business profile.", "The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1." ], "enum": [ "DAILY_METRIC_UNKNOWN", "BUSINESS_IMPRESSIONS_DESKTOP_MAPS", "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH", "BUSINESS_IMPRESSIONS_MOBILE_MAPS", "BUSINESS_IMPRESSIONS_MOBILE_SEARCH", "BUSINESS_CONVERSATIONS", "BUSINESS_DIRECTION_REQUESTS", "CALL_CLICKS", "WEBSITE_CLICKS", "BUSINESS_BOOKINGS", "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, true, false ] }, "dailyRange.endDate.year": { "location": "query", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "dailyRange.endDate.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "location": "query", "type": "integer" }, "location": { "required": true, "location": "path", "description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id.", "pattern": "^locations/[^/]+$", "type": "string" }, "dailyRange.startDate.year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "location": "query", "type": "integer" }, "dailyRange.startDate.day": { "location": "query", "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32" }, "dailyRange.endDate.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "location": "query", "type": "integer" } }, "id": "businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries", "parameterOrder": [ "location" ], "response": { "$ref": "FetchMultiDailyMetricsTimeSeriesResponse" }, "description": " Returns the values for each date from a given time range that are associated with the specific daily metrics. Note: Only daily data is available. Hourly metrics are not supported. 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`", "flatPath": "v1/locations/{locationsId}:fetchMultiDailyMetricsTimeSeries", "httpMethod": "GET" } }, "resources": { "searchkeywords": { "resources": { "impressions": { "resources": { "monthly": { "methods": { "list": { "flatPath": "v1/locations/{locationsId}/searchkeywords/impressions/monthly", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "ListSearchKeywordImpressionsMonthlyResponse" }, "description": "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`", "path": "v1/{+parent}/searchkeywords/impressions/monthly", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^locations/[^/]+$", "type": "string", "description": "Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id." }, "monthlyRange.startMonth.day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "location": "query", "type": "integer" }, "monthlyRange.startMonth.year": { "location": "query", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "monthlyRange.endMonth.day": { "location": "query", "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32" }, "monthlyRange.endMonth.year": { "location": "query", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "pageSize": { "description": "Optional. The number of results requested. The default page size is 100. Page size can be set to a maximum of 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token indicating the next paginated result to be returned.", "format": "byte" }, "monthlyRange.startMonth.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "location": "query", "type": "integer" }, "monthlyRange.endMonth.month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "location": "query", "type": "integer" } }, "id": "businessprofileperformance.locations.searchkeywords.impressions.monthly.list" } } } } } } } } } }, "fullyEncodeReservedExpansion": true, "batchPath": "batch", "schemas": { "TimeSeries": { "id": "TimeSeries", "properties": { "datedValues": { "description": "List of datapoints in the timeseries, where each datapoint is a date-value pair.", "items": { "$ref": "DatedValue" }, "type": "array" } }, "description": "Represents a timeseries.", "type": "object" }, "TimeOfDay": { "id": "TimeOfDay", "properties": { "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "seconds": { "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" }, "nanos": { "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32" }, "hours": { "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" } }, "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "type": "object" }, "Date": { "id": "Date", "properties": { "year": { "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32" } }, "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "type": "object" }, "SearchKeywordCount": { "description": "Represents a single search keyword and its value.", "type": "object", "id": "SearchKeywordCount", "properties": { "searchKeyword": { "type": "string", "description": "The lower-cased string that the user entered." }, "insightsValue": { "description": "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.", "$ref": "InsightsValue" } } }, "GetDailyMetricsTimeSeriesResponse": { "id": "GetDailyMetricsTimeSeriesResponse", "properties": { "timeSeries": { "description": "The daily time series.", "$ref": "TimeSeries" } }, "type": "object", "description": "Represents the response for GetDailyMetricsTimeSeries." }, "DatedValue": { "description": "Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.", "type": "object", "id": "DatedValue", "properties": { "value": { "description": "The value of the datapoint. This will not be present when the value is zero.", "format": "int64", "type": "string" }, "date": { "description": "The date that the datapoint corresponds to. This represents a month value if the day field is not set.", "$ref": "Date" } } }, "MultiDailyMetricTimeSeries": { "description": "Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.", "type": "object", "id": "MultiDailyMetricTimeSeries", "properties": { "dailyMetricTimeSeries": { "description": "List of DailyMetric-TimeSeries pairs.", "items": { "$ref": "DailyMetricTimeSeries" }, "type": "array" } } }, "DailySubEntityType": { "id": "DailySubEntityType", "properties": { "dayOfWeek": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "description": "Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE." }, "timeOfDay": { "description": "Represents the time of the day in 24 hour format. Eg: 13:34:20 Currently supported DailyMetrics = NONE.", "$ref": "TimeOfDay" } }, "type": "object", "description": "Represents all possible subentity types that are associated with DailyMetrics. Note: Currently, all metrics are returned as daily aggregates and sub-entity breakdowns are not supported." }, "DailyMetricTimeSeries": { "id": "DailyMetricTimeSeries", "properties": { "dailySubEntityType": { "description": "The DailySubEntityType that the TimeSeries represents. Will not be present when breakdown does not exist.", "$ref": "DailySubEntityType" }, "timeSeries": { "description": "List of datapoints where each datapoint is a date-value pair.", "$ref": "TimeSeries" }, "dailyMetric": { "type": "string", "enumDescriptions": [ "Represents the default unknown value.", "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 on Google Search on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", "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 impressions on Google Search on Mobile devices. Multiple impressions by a unique user within a single day are counted as a single impression.", "The number of message conversations received on the business profile.", "The number of times a direction request was requested to the business location.", "The number of times the business profile call button was clicked.", "The number of times the business profile website was clicked.", "The number of bookings made from the business profile via Reserve with Google.", "The number of food orders received from the business profile.", "The number of clicks to view or interact with the menu content on the business profile. Multiple clicks by a unique user within a single day are counted as 1." ], "description": "The DailyMetric that the TimeSeries represents.", "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, true, false ], "enum": [ "DAILY_METRIC_UNKNOWN", "BUSINESS_IMPRESSIONS_DESKTOP_MAPS", "BUSINESS_IMPRESSIONS_DESKTOP_SEARCH", "BUSINESS_IMPRESSIONS_MOBILE_MAPS", "BUSINESS_IMPRESSIONS_MOBILE_SEARCH", "BUSINESS_CONVERSATIONS", "BUSINESS_DIRECTION_REQUESTS", "CALL_CLICKS", "WEBSITE_CLICKS", "BUSINESS_BOOKINGS", "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ] } }, "type": "object", "description": "Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple." }, "InsightsValue": { "type": "object", "description": "Represents an insights value.", "id": "InsightsValue", "properties": { "value": { "description": "Represents the actual value.", "format": "int64", "type": "string" }, "threshold": { "description": "Represents the threshold below which the actual value falls.", "format": "int64", "type": "string" } } }, "FetchMultiDailyMetricsTimeSeriesResponse": { "description": "Represents the response for FetchMultiDailyMetricsTimeSeries.", "type": "object", "id": "FetchMultiDailyMetricsTimeSeriesResponse", "properties": { "multiDailyMetricTimeSeries": { "description": "DailyMetrics and their corresponding time series.", "items": { "$ref": "MultiDailyMetricTimeSeries" }, "type": "array" } } }, "ListSearchKeywordImpressionsMonthlyResponse": { "id": "ListSearchKeywordImpressionsMonthlyResponse", "properties": { "searchKeywordsCounts": { "type": "array", "description": "Search terms which have been used to find a business.", "items": { "$ref": "SearchKeywordCount" } }, "nextPageToken": { "description": "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.", "format": "byte", "type": "string" } }, "type": "object", "description": "Represents the response for ListSearchKeywordImpressionsMonthly." } }, "revision": "20260610", "kind": "discovery#restDescription", "mtlsRootUrl": "https://businessprofileperformance.mtls.googleapis.com/", "name": "businessprofileperformance", "baseUrl": "https://businessprofileperformance.googleapis.com/", "basePath": "", "id": "businessprofileperformance:v1" }