Package google.mybusiness.businesscalls.v1

Index

BusinessCallsService

Cette API permet aux entreprises de gérer les appels aux établissements et de recueillir des insights tels que le nombre d'appels manqués vers leur établissement. Pour en savoir plus sur les appels aux entreprises, consultez https://support.google.com/business/answer/9688285?p=call_history.

Si la fiche d'établissement Google est associée à un compte Google Ads et que l'historique des appels est activé, les appels qui durent plus longtemps qu'une durée spécifique et qui peuvent être attribués à une interaction avec une annonce s'affichent dans le compte Google Ads associé sous la conversion "Appels à partir d'annonces". Si vous utilisez des stratégies d'enchères intelligentes et des conversions par appel dans la stratégie d'optimisation, le budget publicitaire risque d'être modifié. En savoir plus sur les stratégies d'enchères intelligentes

Pour afficher les appels passés à un établissement et effectuer des actions les concernant, vous devez être un OWNER, un CO_OWNER ou un MANAGER de l'établissement.

GetBusinessCallsSettings

rpc GetBusinessCallsSettings(GetBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Affiche la ressource de paramètres des appels Business pour l'établissement donné.

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.
ListBusinessCallsInsights

rpc ListBusinessCallsInsights(ListBusinessCallsInsightsRequest) returns (ListBusinessCallsInsightsResponse)

Affiche des insights sur les appels d'établissements pour un établissement.

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.
UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Met à jour les paramètres d'appel des établissements pour l'établissement spécifié.

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.

AggregateMetrics

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

Champs
missed_calls_count

Int32Value

Nombre total d'appels manqués.
answered_calls_count

Int32Value

Nombre total d'appels pris.
hourly_metrics[]

HourlyMetrics

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

WeekDayMetrics

Liste des métriques par jour de la semaine.
start_date

Date

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

Date

Date de fin de cette métrique.

BusinessCallsInsights

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

Champs
name

string

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

MetricType

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

AggregateMetrics

Métrique pour la période basée sur start_date et end_date.

BusinessCallsSettings

Paramètres des appels professionnels pour un établissement.

Champs
name

string

Obligatoire. Nom de ressource des paramètres d'appel. Format: locations/{location}/businesscallssettings
calls_state

CallsState

Obligatoire. État de l'inscription de cet établissement au service d'appels aux entreprises.
consent_time

Timestamp

Uniquement en entrée. Heure à laquelle l'utilisateur final a donné son consentement à l'utilisateur de l'API pour activer les appels d'entreprise.

CallsState

Les différents états possibles d'un établissement lors des appels passés à une entreprise. Les états peuvent uniquement être ACTIVÉ ou DÉSACTIVÉS. Tout le reste générera une erreur PRECONDITION_FAILED.

Enums
CALLS_STATE_UNSPECIFIED URL indéterminée.
ENABLED Les appels aux entreprises sont activés pour l'établissement.
DISABLED Les appels aux entreprises sont désactivés pour l'établissement.

ErrorCode

Codes d'erreur pour les échecs internes.

Enums
ERROR_CODE_UNSPECIFIED Code d'erreur non spécifié.
ERROR_CODE_UNVERIFIED_LOCATION L'établissement n'a pas été validé.
ERROR_CODE_CALLS_NOT_ENABLED L'état des appels Business pour l'établissement n'est pas ACTIVÉ.
ERROR_CODE_NOT_ELIGIBLE_LOCATION L'établissement ne permet pas de passer des appels d'entreprises.

GetBusinessCallsSettingsRequest

Message de requête pour GetBusinessCallsSettings.

Champs
name

string

Obligatoire. BusinessCallsSettings à obtenir.

Le champ name permet d'identifier les paramètres d'appel à l'entreprise à obtenir. Format: locations/{location_id}/businesscallssettings.

HourlyMetrics

Métriques pour une heure.

Champs
hour

Int32Value

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

Int32Value

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

ListBusinessCallsInsightsRequest

Message de requête pour ListBusinessCallsInsights.

Champs
parent

string

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

int32

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, le paramètre "page_size" est ignoré.
page_token

string

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

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

string

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 valeur end_date n'est définie, la dernière date pour laquelle des données sont disponibles est utilisée. Si aucune valeur start_date n'est définie, la première date pour laquelle des données sont disponibles sera utilisée par défaut, soit six mois actuellement. Si start_date 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. start_date="DATE" où la date est au format AAAA-MM-JJ. 2. end_date="DATE" où la date est au format AAAA-MM-JJ. 3. metric_type=XYZ où XYZ est un MetricType valide. 4. Conjonctions(AND) de tous les éléments ci-dessus. Par exemple, "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" Le champ "metric_type" sur AGGREGATE_COUNT ignore la partie DD de la date.

ListBusinessCallsInsightsResponse

Message de réponse pour ListBusinessCallsInsights.

Champs
business_calls_insights[]

BusinessCallsInsights

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

string

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

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".

UpdateBusinessCallsSettingsRequest

Message de requête pour UpdateBusinessCallsSettings.

Champs
business_calls_settings

BusinessCallsSettings

Obligatoire. BusinessCallsSettings à mettre à jour.

Le champ name permet d'identifier les paramètres d'appel Business à mettre à jour. Format: locations/{location_id}/businesscallssettings
update_mask

FieldMask

Obligatoire. Liste des champs à mettre à jour.

WeekDayMetrics

Métriques pour un jour de la semaine.

Champs
day

DayOfWeek

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

Int32Value

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