Business Profile Performance API . locations

close()

Close httplib2 connections.

fetchMultiDailyMetricsTimeSeries(location, dailyMetrics=None, dailyRange_endDate_day=None, dailyRange_endDate_month=None, dailyRange_endDate_year=None, dailyRange_startDate_day=None, dailyRange_startDate_month=None, dailyRange_startDate_year=None, x__xgafv=None)

 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`

Args:
  location: string, Required. The location for which the time series should be fetched. Format: locations/{location_id} where location_id is an unobfuscated listing id. (required)
  dailyMetrics: string, Required. The metrics to retrieve time series for. (repeated)
    Allowed values
      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_DESKTOP_SEARCH - 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_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_IMPRESSIONS_MOBILE_SEARCH - Business impressions on Google Search 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 made from the business profile via Reserve with Google.
      BUSINESS_FOOD_ORDERS - The number of food orders received from the business profile.
      BUSINESS_FOOD_MENU_CLICKS - 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.
  dailyRange_endDate_day: integer, 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.
  dailyRange_endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  dailyRange_endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  dailyRange_startDate_day: integer, 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.
  dailyRange_startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  dailyRange_startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents the response for FetchMultiDailyMetricsTimeSeries.
  "multiDailyMetricTimeSeries": [ # DailyMetrics and their corresponding time series.
    { # Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.
      "dailyMetricTimeSeries": [ # List of DailyMetric-TimeSeries pairs.
        { # Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple.
          "dailyMetric": "A String", # The DailyMetric that the TimeSeries represents.
          "dailySubEntityType": { # Represents all possible subentity types that are associated with DailyMetrics. # The DailySubEntityType that the TimeSeries represents. Will not be present when breakdown does not exist.
            "dayOfWeek": "A String", # Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.
            "timeOfDay": { # 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`. # Represents the time of the day in 24 hour format. Eg: 13:34:20 Currently supported DailyMetrics = NONE.
              "hours": 42, # 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.
              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              "seconds": 42, # 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.
            },
          },
          "timeSeries": { # Represents a timeseries. # List of datapoints where each datapoint is a date-value pair.
            "datedValues": [ # List of datapoints in the timeseries, where each datapoint is a date-value pair.
              { # Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.
                "date": { # 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 # The date that the datapoint corresponds to. This represents a month value if the day field is not set.
                  "day": 42, # 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.
                  "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                  "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                },
                "value": "A String", # The value of the datapoint. This will not be present when the value is zero.
              },
            ],
          },
        },
      ],
    },
  ],
}

getDailyMetricsTimeSeries(name, dailyMetric=None, dailyRange_endDate_day=None, dailyRange_endDate_month=None, dailyRange_endDate_year=None, dailyRange_startDate_day=None, dailyRange_startDate_month=None, dailyRange_startDate_year=None, dailySubEntityType_dayOfWeek=None, dailySubEntityType_timeOfDay_hours=None, dailySubEntityType_timeOfDay_minutes=None, dailySubEntityType_timeOfDay_nanos=None, dailySubEntityType_timeOfDay_seconds=None, x__xgafv=None)

 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`

Args:
  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. (required)
  dailyMetric: string, Required. The metric to retrieve time series.
    Allowed values
      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_DESKTOP_SEARCH - 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_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_IMPRESSIONS_MOBILE_SEARCH - Business impressions on Google Search 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 made from the business profile via Reserve with Google.
      BUSINESS_FOOD_ORDERS - The number of food orders received from the business profile.
      BUSINESS_FOOD_MENU_CLICKS - 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.
  dailyRange_endDate_day: integer, 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.
  dailyRange_endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  dailyRange_endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  dailyRange_startDate_day: integer, 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.
  dailyRange_startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  dailyRange_startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  dailySubEntityType_dayOfWeek: string, Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.
    Allowed values
      DAY_OF_WEEK_UNSPECIFIED - The day of the week is unspecified.
      MONDAY - Monday
      TUESDAY - Tuesday
      WEDNESDAY - Wednesday
      THURSDAY - Thursday
      FRIDAY - Friday
      SATURDAY - Saturday
      SUNDAY - Sunday
  dailySubEntityType_timeOfDay_hours: integer, 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.
  dailySubEntityType_timeOfDay_minutes: integer, Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
  dailySubEntityType_timeOfDay_nanos: integer, Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
  dailySubEntityType_timeOfDay_seconds: integer, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents the response for GetDailyMetricsTimeSeries.
  "timeSeries": { # Represents a timeseries. # The daily time series.
    "datedValues": [ # List of datapoints in the timeseries, where each datapoint is a date-value pair.
      { # Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.
        "date": { # 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 # The date that the datapoint corresponds to. This represents a month value if the day field is not set.
          "day": 42, # 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.
          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
        },
        "value": "A String", # The value of the datapoint. This will not be present when the value is zero.
      },
    ],
  },
}