Business Profile Performance API (businessprofileperformance:v1)

2023-03-09

1 new method

Additions

    Methods

  • ▼ ▲ businessprofileperformance.locations.fetchMultiDailyMetricsTimeSeries

      Parameters:

        location

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

          Type: string

          Pattern: ^locations/[^/]+$

        dailyRange.startDate.year

          Format: int32

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

          Type: integer

          Location: query

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

          Location: query

          Type: integer

          Format: int32

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

        dailyRange.endDate.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

        dailyMetrics

          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

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

          • Repeated: Yes

          Description: Required. The metrics to retrieve time series for.

          Type: string

        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.

          Location: query

          Format: int32

          Type: integer

        dailyRange.startDate.day

          Format: int32

          Type: integer

          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.

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

      Parameter Order: location

      HTTP Method: GET

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

      Path: v1/{+location}:fetchMultiDailyMetricsTimeSeries