Skip to content

Commit 7f0a171

Browse files
feat(businessprofileperformance): update the api
#### businessprofileperformance:v1 The following keys were added: - resources.locations.methods.fetchMultiDailyMetricsTimeSeries (Total Keys: 31) - schemas.DailyMetricTimeSeries (Total Keys: 5) - schemas.DailySubEntityType (Total Keys: 4) - schemas.FetchMultiDailyMetricsTimeSeriesResponse (Total Keys: 4) - schemas.MultiDailyMetricTimeSeries (Total Keys: 4) - schemas.TimeOfDay (Total Keys: 10)
1 parent 59b232f commit 7f0a171

File tree

2 files changed

+301
-1
lines changed

2 files changed

+301
-1
lines changed

docs/dyn/businessprofileperformance_v1.locations.html

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ <h2>Instance Methods</h2>
8282
<p class="toc_element">
8383
<code><a href="#close">close()</a></code></p>
8484
<p class="firstline">Close httplib2 connections.</p>
85+
<p class="toc_element">
86+
<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>
87+
<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>
8588
<p class="toc_element">
8689
<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>
8790
<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>
@@ -91,6 +94,74 @@ <h3>Method Details</h3>
9194
<pre>Close httplib2 connections.</pre>
9295
</div>
9396

97+
<div class="method">
98+
<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>
99+
<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`
100+
101+
Args:
102+
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)
103+
dailyMetrics: string, Required. The metrics to retrieve time series for. (repeated)
104+
Allowed values
105+
DAILY_METRIC_UNKNOWN - Represents the default unknown value.
106+
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.
107+
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.
108+
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.
109+
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.
110+
BUSINESS_CONVERSATIONS - The number of message conversations received on the business profile.
111+
BUSINESS_DIRECTION_REQUESTS - The number of times a direction request was requested to the business location.
112+
CALL_CLICKS - The number of times the business profile call button was clicked.
113+
WEBSITE_CLICKS - The number of times the business profile website was clicked.
114+
BUSINESS_BOOKINGS - The number of bookings received from the business profile.
115+
BUSINESS_FOOD_ORDERS - The number of food orders received from the business profile.
116+
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.
117+
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.
118+
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.
119+
dailyRange_endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
120+
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.
121+
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.
122+
dailyRange_startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
123+
x__xgafv: string, V1 error format.
124+
Allowed values
125+
1 - v1 error format
126+
2 - v2 error format
127+
128+
Returns:
129+
An object of the form:
130+
131+
{ # Represents the response for FetchMultiDailyMetricsTimeSeries.
132+
&quot;multiDailyMetricTimeSeries&quot;: [ # DailyMetrics and their corresponding time series.
133+
{ # Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.
134+
&quot;dailyMetricTimeSeries&quot;: [ # List of DailyMetric-TimeSeries pairs.
135+
{ # Represents a single datapoint, where each datapoint is a DailyMetric-DailySubEntityType-TimeSeries tuple.
136+
&quot;dailyMetric&quot;: &quot;A String&quot;, # The DailyMetric that the TimeSeries represents.
137+
&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.
138+
&quot;dayOfWeek&quot;: &quot;A String&quot;, # Represents the day of the week. Eg: MONDAY.
139+
&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
140+
&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.
141+
&quot;minutes&quot;: 42, # Minutes of hour of day. Must be from 0 to 59.
142+
&quot;nanos&quot;: 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
143+
&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.
144+
},
145+
},
146+
&quot;timeSeries&quot;: { # Represents a timeseries. # List of datapoints where each datapoint is a date-value pair.
147+
&quot;datedValues&quot;: [ # List of datapoints in the timeseries, where each datapoint is a date-value pair.
148+
{ # Represents a single datapoint in the timeseries, where each datapoint is a date-value pair.
149+
&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.
150+
&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.
151+
&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.
152+
&quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
153+
},
154+
&quot;value&quot;: &quot;A String&quot;, # The value of the datapoint.
155+
},
156+
],
157+
},
158+
},
159+
],
160+
},
161+
],
162+
}</pre>
163+
</div>
164+
94165
<div class="method">
95166
<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>
96167
<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`

0 commit comments

Comments
 (0)