- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- Date
Affiche des insights sur les appels d'établissements pour un établissement.
Requête HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
parent |
Obligatoire. Emplacement parent pour lequel extraire des insights sur les appels. Format: locations/{locationId} |
Paramètres de requête
Paramètres | |
---|---|
pageSize |
Facultatif. Nombre maximal de BusinessCallsInsights à renvoyer. Si aucune valeur n'est spécifiée, la valeur renvoyée est 20 au maximum. Certains des types de métrique(metric_types, par exemple, AGGREGATE_COUNT) renvoient une seule page. Pour ces métriques, la valeur pageSize est ignorée. |
pageToken |
Facultatif. Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
filter |
Facultatif. Filtre limitant les appels d'insights à renvoyer. La réponse n'inclut que les entrées qui correspondent au filtre. Si MetricType n'est pas fourni, AGGREGATE_COUNT est renvoyé. Si aucune date de fin n'est spécifiée, la dernière date pour laquelle des données sont disponibles est utilisée. Si aucune date de début n'est spécifiée, nous utiliserons par défaut la première date pour laquelle des données sont disponibles, soit six mois actuellement. Si startDate est antérieure à la date à laquelle des données sont disponibles, les données sont renvoyées à partir de la date à laquelle elles sont disponibles. Pour le moment, nous prenons en charge les filtres suivants. 1. startDate="DATE" où la date est au format AAAA-MM-JJ. 2. endDate="DATE" où la date est au format AAAA-MM-JJ. 3. metricType=XYZ où XYZ est un MetricType valide. 4. Conjonctions(AND) de tous les éléments ci-dessus. Par exemple, "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" Le paramètre AGGREGATE_COUNT metricType ignore la partie JJ de la date. |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Message de réponse pour businesscallsinsights.list.
Représentation JSON |
---|
{
"businessCallsInsights": [
{
object ( |
Champs | |
---|---|
businessCallsInsights[] |
Ensemble d'insights sur les appels passés à l'établissement. |
nextPageToken |
Jeton pouvant être envoyé en tant que |
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/business.manage
Pour en savoir plus, consultez la présentation d'OAuth 2.0.
BusinessCallsInsights
Statistiques sur les appels passés vers un établissement.
Représentation JSON |
---|
{ "name": string, "metricType": enum ( |
Champs | |
---|---|
name |
Obligatoire. Nom de ressource des insights sur les appels. Format: locations/{location}/businesscallsinsights |
metricType |
Métrique à laquelle la valeur s'applique. |
aggregateMetrics |
Métrique pour la période basée sur la date de début et la date de fin. |
MetricType
Type de métrique.
Enums | |
---|---|
METRIC_TYPE_UNSPECIFIED |
Le type de métrique n'est pas spécifié. |
AGGREGATE_COUNT |
Les métriques fournies sont des décomptes agrégés sur la période d'entrée "time_range". |
AggregateMetrics
Métriques agrégées sur la période d'entrée.
Représentation JSON |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
Champs | |
---|---|
missedCallsCount |
Nombre total d'appels manqués. |
answeredCallsCount |
Nombre total d'appels pris. |
hourlyMetrics[] |
Liste des métriques par heure de la journée. |
weekdayMetrics[] |
Liste des métriques par jour de la semaine. |
startDate |
Date pour cette métrique. Si la métrique est mensuelle, seuls l'année et le mois sont utilisés. |
endDate |
Date de fin de cette métrique. |
HourlyMetrics
Métriques pour une heure.
Représentation JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
Champs | |
---|---|
hour |
Heure de la journée. Les valeurs autorisées sont comprises entre 0 et 23. |
missedCallsCount |
Nombre total d'appels manqués pour cette heure. |
WeekDayMetrics
Métriques pour un jour de la semaine.
Représentation JSON |
---|
{
"day": enum ( |
Champs | |
---|---|
day |
Jour de la semaine. Les valeurs autorisées sont du dimanche au samedi. |
missedCallsCount |
Nombre total d'appels manqués pour cette heure. |
DayOfWeek
Représente un jour de la semaine.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Le jour de la semaine n'est pas spécifié. |
MONDAY |
Lundi |
TUESDAY |
Mardi |
WEDNESDAY |
Mercredi |
THURSDAY |
Jeudi |
FRIDAY |
Vendredi |
SATURDAY |
Samedi |
SUNDAY |
Dimanche |
Date
Représente une date calendaire complète ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs ou ne sont pas significatifs. La date est relative au calendrier grégorien. Il peut s'agir de l'un des éléments suivants:
- Une date complète, avec des valeurs d'année, de mois et de jour non nulles
- Un mois et un jour, avec une année nulle (par exemple, un anniversaire)
- Une année seule, avec un mois et un jour zéro
- Une année et un mois, sans jour (par exemple, la date d'expiration d'une carte de crédit)
Types associés: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
Représentation JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Champs | |
---|---|
year |
Année de la date. La valeur doit être comprise entre 1 et 9999, ou égale à 0 pour indiquer une date sans année. |
month |
Mois de l'année. La valeur doit être comprise entre 1 et 12, ou 0 pour indiquer une année sans mois ni jour. |
day |
Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou la valeur 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif. |