Business Profile Performance API (businessprofileperformance:v1)

Additions

Methods


• ▼ ▲ businessprofileperformance.locations.getDailyMetricsTimeSeries

  Description: 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

  Path: v1/{+name}:getDailyMetricsTimeSeries

  HTTP Method: GET

  Flat Path: v1/locations/{locationsId}:getDailyMetricsTimeSeries

  Parameter Order: name

  Parameters:

  dailyRange.endDate.day

  Location: query

  Format: int32

  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.

  dailySubEntityType.timeOfDay.minutes

  Description: Minutes of hour of day. Must be from 0 to 59.

  Location: query

  Format: int32

  Type: integer

  dailyMetric

  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

  Location: query

  Description: Required. The metric to retrieve time series.

  Type: string

  Enum Descriptions:

  • 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 received from the business profile.
  • The number of food orders received from the business profile.

  dailyRange.endDate.year

  Location: query

  Type: integer

  Format: int32

  Description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  dailyRange.startDate.year

  Location: query

  Format: int32

  Type: integer

  Description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  dailyRange.startDate.month

  Format: int32

  Location: query

  Description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  Type: integer

  dailySubEntityType.timeOfDay.nanos

  Format: int32

  Description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

  Type: integer

  Location: query

  dailyRange.endDate.month

  Format: int32

  Description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  Location: query

  Type: integer

  name

  Required: Yes

  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.

  Pattern: ^locations/[^/]+$

  Location: path

  dailySubEntityType.timeOfDay.hours

  Type: integer

  Format: int32

  Description: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

  Location: query

  dailyRange.startDate.day

  Format: int32

  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.

  Type: integer

  Location: query

  dailySubEntityType.dayOfWeek

  Description: Represents the day of the week. Eg: MONDAY.

  Type: string

  Enum:

  • DAY_OF_WEEK_UNSPECIFIED
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY

  Location: query

  Enum Descriptions:

  • The day of the week is unspecified.
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

  dailySubEntityType.timeOfDay.seconds

  Location: query

  Format: int32

  Description: Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

  Type: integer

• ▼ ▲ businessprofileperformance.locations.searchkeywords.impressions.monthly.list

  Path: v1/{+parent}/searchkeywords/impressions/monthly

  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

  Parameters:

  monthlyRange.startMonth.day

  Format: int32

  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.

  Location: query

  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.

  Type: integer

  Location: query

  Format: int32

  monthlyRange.endMonth.year

  Type: integer

  Location: query

  Description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  Format: int32

  pageToken

  Format: byte

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

  Location: query

  Type: string

  monthlyRange.endMonth.month

  Type: integer

  Format: int32

  Location: query

  Description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  pageSize

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

  Type: integer

  Format: int32

  Location: query

  monthlyRange.endMonth.day

  Location: query

  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

  parent

  Type: string

  Location: path

  Required: Yes

  Pattern: ^locations/[^/]+$

  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.year

  Format: int32

  Location: query

  Description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  Type: integer

  Flat Path: v1/locations/{locationsId}/searchkeywords/impressions/monthly

  HTTP Method: GET

  Parameter Order: parent