Package google.mybusiness.businesscalls.v1

Índice

BusinessCallsService

Esta API permite que las empresas administren las llamadas empresariales y recopilen estadísticas, como la cantidad de llamadas perdidas a su ubicación. Puedes encontrar información adicional sobre las llamadas a empresas en https://support.google.com/business/answer/9688285?p=call_history.

Si el Perfil de Negocio de Google se vincula a una cuenta de Google Ads y está activado el historial de llamadas, las llamadas que duren más de un tiempo específico y que se puedan atribuir a una interacción con el anuncio se mostrarán en la cuenta de Google Ads vinculada en la conversión "Llamadas desde anuncios". Si se utilizan las Ofertas inteligentes y las conversiones de llamada en la estrategia de optimización, podría haber un cambio en la inversión publicitaria. Obtén más información sobre las Ofertas inteligentes".

Para ver las llamadas de una ubicación y realizar acciones en ellas, debes estar en un OWNER, un CO_OWNER o un MANAGER de la ubicación.

GetBusinessCallsSettings

rpc GetBusinessCallsSettings(GetBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Muestra el recurso de configuración de llamadas a empresas para la ubicación determinada.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/business.manage

Para obtener más información, consulta la Descripción general de OAuth 2.0.
ListBusinessCallsInsights

rpc ListBusinessCallsInsights(ListBusinessCallsInsightsRequest) returns (ListBusinessCallsInsightsResponse)

Muestra estadísticas de las llamadas a empresas para una ubicación.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/business.manage

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Actualiza la configuración de llamadas de la empresa para la ubicación especificada.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/business.manage

Para obtener más información, consulta la Descripción general de OAuth 2.0.

AggregateMetrics

Métricas agregadas durante el intervalo de tiempo de entrada.

Campos
missed_calls_count

Int32Value

Recuento total de llamadas perdidas
answered_calls_count

Int32Value

Cantidad total de llamadas respondidas
hourly_metrics[]

HourlyMetrics

Una lista de métricas según la hora del día.
weekday_metrics[]

WeekDayMetrics

Una lista de métricas por día de la semana.
start_date

Date

Fecha de esta métrica. Si la métrica es mensual, solo se usan el año y el mes.
end_date

Date

Es la fecha de finalización de esta métrica.

BusinessCallsInsights

Estadísticas de las llamadas realizadas a una ubicación

Campos
name

string

Obligatorio. El nombre del recurso de las estadísticas de llamadas. Formato: ubicaciones/{location}/businesscallsinsights
metric_type

MetricType

La métrica para la que se aplica el valor.
aggregate_metrics

AggregateMetrics

Métrica para el intervalo de tiempo basada en start_date y end_date.

BusinessCallsSettings

Configuración de llamadas de empresas para una ubicación.

Campos
name

string

Obligatorio. El nombre del recurso de la configuración de las llamadas. Formato: locations/{location}/businesscallssettings
calls_state

CallsState

Obligatorio. Es el estado de la inscripción de esta ubicación en Llamadas a empresas.
consent_time

Timestamp

Solo entrada. Hora en la que el usuario final dio su consentimiento al usuario de la API para habilitar las llamadas a empresas.

CallsState

Son los posibles estados de una ubicación en las llamadas a empresas. Los estados se pueden actualizar solo a HABILITADO o INHABILITADO. Todo lo demás mostrará el error PREVERIFICATION_FAILED.

Enumeradores
CALLS_STATE_UNSPECIFIED No se especifica.
ENABLED Las llamadas a empresas están habilitadas para la ubicación.
DISABLED Las llamadas a empresas están inhabilitadas para esta ubicación.

ErrorCode

Códigos de error para fallas internas

Enumeradores
ERROR_CODE_UNSPECIFIED Código de error no especificado.
ERROR_CODE_UNVERIFIED_LOCATION La ubicación no está verificada.
ERROR_CODE_CALLS_NOT_ENABLED El estado de llamadas a empresas para la ubicación no está HABILITADO.
ERROR_CODE_NOT_ELIGIBLE_LOCATION La ubicación no es apta para llamadas a empresas.

GetBusinessCallsSettingsRequest

Mensaje de solicitud para GetBusinessCallsSettings.

Campos
name

string

Obligatorio. La BusinessCallsSettings que recibirás.

El campo name se usa para identificar la configuración de llamadas a empresas que se debe obtener. Formato: locations/{location_id}/businesscallssettings.

HourlyMetrics

Métricas durante una hora.

Campos
hour

Int32Value

Hora del día Se permiten valores incluidos en el rango del 0 al 23.
missed_calls_count

Int32Value

Recuento total de llamadas perdidas en esta hora.

ListBusinessCallsInsightsRequest

Mensaje de solicitud para ListBusinessCallsInsights.

Campos
parent

string

Obligatorio. La ubicación superior para la que se deben recuperar las estadísticas de llamadas. Formato: ubicaciones/{location_id}
page_size

int32

Opcional. Es la cantidad máxima de BusinessCallsInsights que se mostrarán. Si no se especifican, se mostrarán 20 como máximo. Algunos de los tipos de métricas(por ejemplo, AGGREGATE_COUNT) muestran una sola página. Para estas métricas, se ignora page_size.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListBusinessCallsInsights anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListBusinessCallsInsights deben coincidir con la llamada que proporcionó el token de la página. Algunos de los metric_types (p. ej., AGGREGATE_COUNT) muestran una sola página. Para estas métricas, se ignora pake_token.
filter

string

Opcional. Un filtro que restringe las estadísticas de las llamadas para que se muestren. La respuesta solo incluye entradas que coinciden con el filtro.

Si no se proporciona el MetricType, se muestra AGGREGATE_COUNT. Si no se proporciona end_date, se usa la última fecha para la que se hayan disponible datos. Si no se proporciona una fecha_de_inicio, se utilizará de forma predeterminada la primera fecha para la que estén disponibles los datos, que actualmente es de 6 meses. Si start_date es anterior a la fecha en que los datos están disponibles, los datos se muestran a partir de la fecha en que están disponibles.

En este momento, admitimos los siguientes filtros. 1. start_date="DATE", donde la fecha tiene el formato AAAA-MM-DD. 2. end_date="DATE", donde la fecha está en formato AAAA-MM-DD. 3. metric_type=XYZ, en el que XYZ es un MetricType válido 4. Conjunciones(Y) de todo lo anterior, p. ej., "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" El valor AGGREGATE_COUNT metric_type ignora la parte DD de la fecha.

ListBusinessCallsInsightsResponse

Mensaje de respuesta para ListBusinessCallsInsights.

Campos
business_calls_insights[]

BusinessCallsInsights

Un conjunto de estadísticas de llamadas a empresas relacionadas con la ubicación
next_page_token

string

Un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes. Algunos de los metric_types (p. ej., AGGREGATE_COUNT) muestran una sola página. Para estas métricas, el siguiente_page_token estará vacío.

MetricType

Es el tipo de métrica.

Enumeradores
METRIC_TYPE_UNSPECIFIED No se especificó el tipo de métrica.
AGGREGATE_COUNT Las métricas proporcionadas son recuentos agregados en el time_range de entrada.

UpdateBusinessCallsSettingsRequest

Mensaje de solicitud para UpdateBusinessCallsSettings.

Campos
business_calls_settings

BusinessCallsSettings

Obligatorio. La BusinessCallsSettings que se actualizará.

El campo name se usa para identificar la configuración de llamadas a empresas que se debe actualizar. Formato: locations/{location_id}/businesscallssettings
update_mask

FieldMask

Obligatorio. La lista de campos a actualizar.

WeekDayMetrics

Métricas para un día de la semana.

Campos
day

DayOfWeek

Día de la semana. Los valores permitidos son de domingo a sábado.
missed_calls_count

Int32Value

Recuento total de llamadas perdidas en esta hora.