Method: locations.businesscallsinsights.list

Affiche des insights concernant les appels professionnels vers 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

string

Obligatoire. Emplacement parent pour lequel extraire les insights sur les appels. Format: locations/{locationId}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal d'insights BusinessCallsInsights à renvoyer. Si aucune valeur n'est spécifiée, 20 valeurs au maximum sont renvoyées. Certains métriques_types(par exemple, AGGREGATE_COUNT) renvoient une seule page. Pour ces métriques, la valeur "pageSize" est ignorée.
pageToken

string

Facultatif. Jeton de page reçu d'un appel businesscallsinsights.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à businesscallsinsights.list doivent correspondre à l'appel ayant fourni le jeton de page. Certains types de métriques (par exemple, AGGREGATE_COUNT) renvoient une seule page. Pour ces métriques, le jeton pake_token est ignoré.
filter

string

Facultatif. Filtre contraignant les insights sur les appels à renvoyer. La réponse n'inclut que les entrées correspondant au filtre.

Si la valeur MetricType n'est pas fournie, AGGREGATE_COUNT est renvoyé. Si aucune date de fin n'est spécifiée, la date pour laquelle les données sont disponibles pour la dernière fois est utilisée. Si aucune date de début n'est spécifiée, nous utilisons par défaut la première date pour laquelle les données sont disponibles, qui est actuellement de six mois. Si la date de début est antérieure à la date à laquelle les données sont disponibles, les données sont renvoyées à partir de cette date.

Pour le moment, nous acceptons 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 type de métrique valide. 4. Conjonctions(ET) de tous les éléments ci-dessus. Ex. : "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" Le paramètre AGGREGATE_COUNT metricType ignore la partie DD 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 (BusinessCallsInsights)
    }
  ],
  "nextPageToken": string
}
Champs
businessCallsInsights[]

object (BusinessCallsInsights)

Ensemble d'insights sur les appels passés à l'établissement pour l'établissement.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages. Certains types de métriques (par exemple, AGGREGATE_COUNT) renvoient une seule page. Pour ces métriques, le champ nextPageToken sera vide.

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

Insights sur les appels passés vers un établissement.

Représentation JSON 
{
  "name": string,
  "metricType": enum (MetricType),
  "aggregateMetrics": {
    object (AggregateMetrics)
  }
}
Champs
name

string

Obligatoire. Nom de ressource des insights sur les appels. Format: locations/{location}/businesscallsinsights
metricType

enum (MetricType)

Métrique à laquelle la valeur s'applique.
aggregateMetrics

object (AggregateMetrics)

Métrique pour la période basée sur startDate et endDate.

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 correspondent aux nombres agrégés sur la plage "time_range" d'entrée.

AggregateMetrics

Métriques agrégées sur la période d'entrée.

Représentation JSON 
{
  "missedCallsCount": integer,
  "answeredCallsCount": integer,
  "hourlyMetrics": [
    {
      object (HourlyMetrics)
    }
  ],
  "weekdayMetrics": [
    {
      object (WeekDayMetrics)
    }
  ],
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Champs
missedCallsCount

integer

Nombre total d'appels manqués.
answeredCallsCount

integer

Nombre total d'appels pris.
hourlyMetrics[]

object (HourlyMetrics)

Liste des métriques par heure de la journée.
weekdayMetrics[]

object (WeekDayMetrics)

Liste de métriques par jour de la semaine.
startDate

object (Date)

Date de cette métrique. Si la métrique est mensuelle, seuls l'année et le mois sont utilisés.
endDate

object (Date)

Date de fin de cette métrique.

HourlyMetrics

Métriques pendant une heure.

Représentation JSON 
{
  "hour": integer,
  "missedCallsCount": integer
}
Champs
hour

integer

Heure de la journée. Les valeurs autorisées sont comprises entre 0 et 23.
missedCallsCount

integer

Nombre total d'appels manqués pour cette heure.

WeekDayMetrics

Métriques pour un jour de la semaine.

Représentation JSON 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
Champs
day

enum (DayOfWeek)

Jour de la semaine. Les valeurs autorisées sont du dimanche au samedi.
missedCallsCount

integer

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 du calendrier entière 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 donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • 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, avec un jour zéro (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

integer

Année de la date. Doit être comprise entre 1 et 9999, ou 0 pour indiquer une date sans année.
month

integer

Mois de l'année. La valeur doit être comprise entre 1 et 12, ou égale à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif.