Package google.mybusiness.businesscalls.v1

Índice

BusinessCallsService

Essa API permite que as empresas gerenciem chamadas de negócios e coletem insights, como o número de chamadas perdidas. Outras informações sobre chamadas empresariais podem ser encontradas em https://support.google.com/business/answer/9688285?p=call_history

Se o Perfil da Empresa no Google estiver vinculado a uma conta do Google Ads, e o histórico de ligações estiver ativado, as chamadas com duração superior a um tempo específico e que puderem ser atribuídas a uma interação com o anúncio vão aparecer na conta do Google Ads vinculada em "Chamadas a partir de anúncios". Se os Lances inteligentes e as conversões de chamada forem usados na estratégia de otimização, pode haver uma mudança nos gastos com publicidade. Saiba mais sobre os Lances inteligentes.

Para conferir e realizar ações nas chamadas de um local, você precisa ser OWNER, CO_OWNER ou MANAGER do local.

GetBusinessCallsSettings

rpc GetBusinessCallsSettings(GetBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Retorna o recurso de configurações de chamadas de negócios para o local especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListBusinessCallsInsights

rpc ListBusinessCallsInsights(ListBusinessCallsInsightsRequest) returns (ListBusinessCallsInsightsResponse)

Retorna insights sobre chamadas comerciais de um local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.
UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Atualiza as configurações de chamada de negócios para o local especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

AggregateMetrics

Métricas agregadas no período de entrada.

Campos
missed_calls_count

Int32Value

Contagem total de ligações perdidas.
answered_calls_count

Int32Value

Contagem total de chamadas atendidas.
hourly_metrics[]

HourlyMetrics

Uma lista de métricas por hora do dia.
weekday_metrics[]

WeekDayMetrics

Uma lista de métricas por dia da semana.
start_date

Date

Data desta métrica. Se a métrica for mensal, apenas o ano e o mês serão usados.
end_date

Date

Data de término dessa métrica.

BusinessCallsInsights

Insights de chamadas feitas para um local.

Campos
name

string

Obrigatório. O nome do recurso dos insights de chamadas. Formato: locations/{location}/businesscallsinsights
metric_type

MetricType

A métrica à qual o valor se aplica.
aggregate_metrics

AggregateMetrics

Métrica para o período com base em start_date e end_date.

BusinessCallsSettings

Configurações de chamadas comerciais para um local.

Campos
name

string

Obrigatório. O nome do recurso das configurações de chamadas. Formato: locations/{location}/businesscallssettings
calls_state

CallsState

Obrigatório. O estado da inscrição deste local em chamadas de negócios.
consent_time

Timestamp

Apenas entrada. Horário em que o usuário final deu consentimento para que o usuário da API ative chamadas comerciais.

CallsState

Os estados possíveis de um local em chamadas comerciais. Os estados podem ser atualizados para apenas ATIVADO ou DESATIVADO. Qualquer outra ação retornará o erro PRECONDIÇÃO_FAILED.

Enums
CALLS_STATE_UNSPECIFIED Não especificado.
ENABLED As chamadas para negócios estão ativadas para o local.
DISABLED As chamadas de negócios estão desativadas para o local.

ErrorCode

Códigos de erro de falhas internas.

Enums
ERROR_CODE_UNSPECIFIED Código de erro não especificado.
ERROR_CODE_UNVERIFIED_LOCATION O local não foi verificado.
ERROR_CODE_CALLS_NOT_ENABLED O estado de chamadas da empresa para o local não está ATIVADO.
ERROR_CODE_NOT_ELIGIBLE_LOCATION O local não está qualificado para chamadas comerciais.

GetBusinessCallsSettingsRequest

Mensagem de solicitação para GetBusinessCallsSettings.

Campos
name

string

Obrigatório. As BusinessCallsSettings a serem recebidas.

O campo name é usado para identificar as configurações de chamada de negócios a serem definidas. Formato: locations/{location_id}/businesscallssettings.

HourlyMetrics

Métricas por uma hora.

Campos
hour

Int32Value

Hora do dia. Os valores permitidos são de 0 a 23.
missed_calls_count

Int32Value

Contagem total de ligações perdidas para esta hora.

ListBusinessCallsInsightsRequest

Mensagem de solicitação para ListBusinessCallsInsights.

Campos
parent

string

Obrigatório. O local pai em que os insights de chamadas vão ser buscados. Formato: locations/{location_id}
page_size

int32

Opcional. O número máximo de BusinessCallsInsights a serem retornados. Se não for especificado, será retornado no máximo 20. Alguns dos metric_types(por exemplo, AGGREGATE_COUNT) retornam uma única página. Para essas métricas, o page_size é ignorado.
page_token

string

Opcional. Um token de página recebido de uma chamada ListBusinessCallsInsights anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListBusinessCallsInsights precisam corresponder à chamada que forneceu o token da página. Alguns dos metric_types (por exemplo, AGGREGATE_COUNT) retornam uma única página. Nessas métricas, o pake_token é ignorado.
filter

string

Opcional. Um filtro que restringe os insights de chamadas a retornar. A resposta inclui apenas entradas que correspondem ao filtro.

Se MetricType não for fornecido, AGGREGATE_COUNT será retornado. Se nenhum end_date for fornecido, será usada a última data em que os dados estiverem disponíveis. Se nenhuma data_de_inicio for fornecida, usaremos como padrão a primeira data em que os dados estiverem disponíveis, que atualmente é de 6 meses. Se start_date for anterior à data em que os dados estiverem disponíveis, eles serão retornados a partir da data em que estiverem disponíveis.

No momento, oferecemos suporte aos filtros a seguir. 1. start_date="DATE" em que a data está no formato AAAA-MM-DD. 2. end_date="DATE", em que a data está no formato AAAA-MM-DD. 3. metric_type=XYZ, em que XYZ é um MetricType válido. 4. Conjunções(E) de todas as opções acima. Por exemplo: "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" O tipo de métrica AGGREGATE_COUNT ignora a parte DD da data.

ListBusinessCallsInsightsResponse

Mensagem de resposta para ListBusinessCallsInsights.

Campos
business_calls_insights[]

BusinessCallsInsights

Uma coleção de insights de chamadas de negócios para o local.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. Alguns dos metric_types (por exemplo, AGGREGATE_COUNT) retornam uma única página. Para essas métricas, o next_page_token estará vazio.

MetricType

O tipo de métrica.

Enums
METRIC_TYPE_UNSPECIFIED O tipo de métrica não foi especificado.
AGGREGATE_COUNT As métricas fornecidas são contagens agregadas no time_range de entrada.

UpdateBusinessCallsSettingsRequest

Mensagem de solicitação para UpdateBusinessCallsSettings.

Campos
business_calls_settings

BusinessCallsSettings

Obrigatório. O BusinessCallsSettings a ser atualizado.

O campo name é usado para identificar as configurações de chamada de negócios a serem atualizadas. Formato: locations/{location_id}/businesscallssettings
update_mask

FieldMask

Obrigatório. Lista de campos a serem atualizados.

WeekDayMetrics

Métricas para um dia da semana.

Campos
day

DayOfWeek

Dia da semana Os valores permitidos são domingo - sábado.
missed_calls_count

Int32Value

Contagem total de ligações perdidas para esta hora.