docs/dyn/businessprofileperformance_v1.locations.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="businessprofileperformance_v1.html">Business Profile Performance API</a> . <a href="businessprofileperformance_v1.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="businessprofileperformance_v1.locations.searchkeywords.html">searchkeywords()</a></code>
</p>
<p class="firstline">Returns the searchkeywords Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#fetchMultiDailyMetricsTimeSeries">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)</a></code></p>
<p class="firstline"> 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`</p>
<p class="toc_element">
  <code><a href="#getDailyMetricsTimeSeries">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)</a></code></p>
<p class="firstline"> 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`</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="fetchMultiDailyMetricsTimeSeries">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)</code>
  <pre> 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&amp;dailyMetrics=CALL_CLICKS&amp;daily_range.start_date.year=2022&amp;daily_range.start_date.month=1&amp;daily_range.start_date.day=1&amp;daily_range.end_date.year=2022&amp;daily_range.end_date.month=3&amp;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&#x27;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&#x27;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.
  &quot;multiDailyMetricTimeSeries&quot;: [ # DailyMetrics and their corresponding time series.
    { # Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.
      &quot;dailyMetricTimeSeries&quot;: [ # List of DailyMetric-TimeSeries pairs.
        { # Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple.
          &quot;dailyMetric&quot;: &quot;A String&quot;, # The DailyMetric that the TimeSeries represents.
          &quot;dailySubEntityType&quot;: { # 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.
            &quot;dayOfWeek&quot;: &quot;A String&quot;, # Represents the day of the week. Eg: MONDAY. Currently supported DailyMetrics = NONE.
            &quot;timeOfDay&quot;: { # 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.
              &quot;hours&quot;: 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of hour of day. Must be from 0 to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
              &quot;seconds&quot;: 42, # 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.
            },
          },
          &quot;timeSeries&quot;: { # Represents a timeseries. # List of datapoints where each datapoint is a date-value pair.
            &quot;datedValues&quot;: [ # 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.
                &quot;date&quot;: { # 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.
                  &quot;day&quot;: 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&#x27;t significant.
                  &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                  &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                },
                &quot;value&quot;: &quot;A String&quot;, # The value of the datapoint. This will not be present when the value is zero.
              },
            ],
          },
        },
      ],
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="getDailyMetricsTimeSeries">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)</code>
  <pre> 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&amp;daily_range.start_date.year=2022&amp;daily_range.start_date.month=1&amp;daily_range.start_date.day=1&amp;daily_range.end_date.year=2022&amp;daily_range.end_date.month=3&amp;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&#x27;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&#x27;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 day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value &quot;24:00:00&quot; for scenarios like business closing time.
  dailySubEntityType_timeOfDay_minutes: integer, Minutes of hour of day. Must be from 0 to 59.
  dailySubEntityType_timeOfDay_nanos: integer, Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
  dailySubEntityType_timeOfDay_seconds: integer, 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.
  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.
  &quot;timeSeries&quot;: { # Represents a timeseries. # The daily time series.
    &quot;datedValues&quot;: [ # 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.
        &quot;date&quot;: { # 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.
          &quot;day&quot;: 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&#x27;t significant.
          &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
          &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
        },
        &quot;value&quot;: &quot;A String&quot;, # The value of the datapoint. This will not be present when the value is zero.
      },
    ],
  },
}</pre>
</div>

</body></html>