Relatórios

Com os relatórios, você pode recuperar informações sobre o desempenho dos anúncios e os leads das suas contas vinculadas.

Relatórios da conta

Os relatórios da conta mostram a performance e as métricas associadas às contas vinculadas de Serviços locais de uma conta de administrador. É possível conferir esses dados em um período especificado. Os dados podem estar desatualizados em até 30 minutos.

Para adquirir o relatório, envie uma solicitação HTTP GET para https://localservices.googleapis.com/v1/accountReports:search com os seguintes parâmetros de URL configuráveis:

Parâmetros de URL
query

Obrigatório

Contém um ou mais valores de ID, um dos quais precisa ser o ID da conta de administrador da consulta. query pode aceitar vários valores separados por ponto e vírgula:

  • Obrigatório: manager_customer_id:<manager_cid>
  • Opcional: customer_id:<linked_cid>

Exemplo: query=manager_customer_id:123;customer_id:456

startDate.day

Opcional

O dia do mês em que o período do relatório começa. Pode assumir valores entre 1 e 31, inclusive. O padrão é 1.

startDate.month

Opcional

O mês de início do período do relatório. Pode assumir valores entre 1 e 12, inclusive. O padrão é o mês atual.

startDate.year

Opcional

O ano em que o período do relatório começa, no formato YYYY. O padrão é o ano atual.

endDate.day

Opcional

O dia do mês em que o período do relatório termina. Pode assumir valores entre 1 e 31, inclusive. O padrão é o dia atual.

endDate.month

Opcional

O mês em que o período do relatório termina. Pode assumir valores entre 1 e 12, inclusive. O padrão é o mês atual.

endDate.year

Opcional

O ano em que o período de relatórios termina, no formato YYYY. O padrão é o ano atual.

pageSize

Opcional

Um número inteiro positivo que indica o número de entradas a serem retornadas. O padrão é 1000, e o máximo é 10000.

pageToken

Opcional

Uma string. Insira o next_page_token da resposta anterior neste campo.

Os campos na tabela anterior são usados para construir um SearchAccountReportsRequest. Para cada ID do cliente na solicitação, um AccountReports correspondente é incluído em SearchAccountReportsResponse. Cada relatório da conta é mapeado individualmente com uma conta de cliente vinculada que mostra anúncios dos Serviços locais.

A tabela a seguir mostra os campos em AccountReports:

Campos
accountId ID de cliente vinculado a uma conta do Serviços Locais.
businessName Nome da empresa do cliente.
averageWeeklyBudget Orçamento semanal médio atual do cliente.
averageFiveStarRating A classificação média de cinco estrelas, calculada com base em todas as avaliações disponíveis do cliente.
totalReview Número total de avaliações disponíveis para o cliente.
impressionsLastTwoDays Número total de impressões que a conta teve nos últimos dois dias.
phoneLeadResponsiveness Capacidade de resposta de leads por telefone da conta nos últimos 90 dias. Para calcular isso, o número total de chamadas conectadas de leads de telefone cobrados é dividido pelo número total de chamadas recebidas.
currentPeriodChargedLeads Número de leads cobrados no período especificado.
previousPeriodChargedLeads Número de leads cobrados no período anterior. Por exemplo, se o período for de 21 a 30 de janeiro, o período anterior será de 11 a 20 de janeiro.
currentPeriodTotalCost Soma do custo dos leads cobrados no período especificado.
previousPeriodTotalCost Soma do custo dos leads cobrados no período anterior. Por exemplo, se o período for de 21 a 30 de janeiro, o período anterior será de 11 a 20 de janeiro.
currencyCode Código da moeda da conta do cliente.
currentPeriodPhoneCalls Número de ligações no período especificado, conectadas e não conectadas.
previousPeriodPhoneCalls Número de chamadas no período anterior, conectadas e não conectadas.
currentPeriodConnectedPhoneCalls Número de ligações conectadas no período especificado com duração superior a 30 segundos.
previousPeriodConnectedPhoneCalls Número de ligações conectadas no período anterior com duração superior a 30 segundos.

Exemplos

URL da solicitação HTTP

https://localservices.googleapis.com/v1/accountReports:search?query=manager_customer_id:{manager_customer_id}

Exemplo de solicitação HTTP completa

GET /v1/accountReports:search?query=manager_customer_id:{manager_customer_id} HTTP/1.1
Host: localservices.googleapis.com
User-Agent: curl
Content-Type: application/json
Accept: application/json
Authorization: Bearer [Enter OAuth 2.0 access token here]

Relatórios detalhados de lead

Os relatórios detalhados de lead mostram uma visão aprofundada dos leads associados às contas de Serviços Locais vinculadas de uma conta de administrador. É possível conferir esses dados em um período especificado. Para um determinado período, o relatório inclui leads criados ou que tiveram o status de disputa atualizado. Os dados podem estar desatualizados em até 30 minutos.

Para adquirir o relatório, envie uma solicitação HTTP GET para https://localservices.googleapis.com/v1/detailedLeadReports:search com os seguintes parâmetros de URL configuráveis:

Parâmetros de URL
query

Obrigatório

Contém um ou mais valores de ID, um dos quais precisa ser o ID da conta de administrador da consulta. query pode aceitar vários valores separados por ponto e vírgula:

  • Obrigatório: manager_customer_id:<manager_cid>
  • Opcional: customer_id:<linked_cid>

Exemplo: query=manager_customer_id:123;customer_id:456

startDate.day

Opcional

O dia do mês em que o período do relatório começa. Pode assumir valores entre 1 e 31, inclusive. O padrão é 1.

startDate.month

Opcional

O mês de início do período do relatório. Pode assumir valores entre 1 e 12, inclusive. O padrão é o mês atual.

startDate.year

Opcional

O ano em que o período do relatório começa, no formato YYYY. O padrão é o ano atual.

endDate.day

Opcional

O dia do mês em que o período do relatório termina. Pode assumir valores entre 1 e 31, inclusive. O padrão é o dia atual.

endDate.month

Opcional

O mês em que o período do relatório termina. Pode assumir valores entre 1 e 12, inclusive. O padrão é o mês atual.

endDate.year

Opcional

O ano em que o período de relatórios termina, no formato YYYY. O padrão é o ano atual.

pageSize

Opcional

Um número inteiro positivo que indica o número de entradas a serem retornadas. O padrão é 1000, e o máximo é 10000.

pageToken

Opcional

Uma string. Insira o next_page_token da resposta anterior neste campo.

Os campos anteriores são usados para criar um SearchDetailedLeadReportsRequest. Para cada ID do cliente na solicitação, um DetailedLeadReports correspondente é incluído em SearchDetailedLeadReportsResponse. Cada relatório detalhado de lead é mapeado individualmente com um lead específico associado a uma conta de cliente vinculada que mostra anúncios de Serviços Locais.

A tabela a seguir mostra os campos em DetailedLeadReports:

Campos
leadId Identificador exclusivo de um lead.
accountId Identifica a conta que recebeu o lead.
businessName Nome da empresa associado à conta.
leadCreationTimestamp

Carimbo de data/hora da criação do lead. Inclui a data no formato M/D/YYYY e a hora no formato HH:MM:SS.

Exemplo: 11/1/2019 12:13:20

leadType Tipo de lead: MESSAGE ou PHONE_CALL.
leadCategory

Categoria de serviço associada ao lead.

Exemplo: housecleaner

geo

Locais da cidade natal da conta associada.

Exemplo: San Francisco, California, United States

messageLead Informações associadas apenas a leads de mensagem: customerName, jobType, postalCode e consumerPhoneNumber.
phoneLead Informações associadas apenas a leads por telefone: chargedCallTimestamp, chargedConnectedCallDurationSeconds e consumerPhoneNumber.
bookingLead Informações associadas apenas a leads de agendamento: customerName, consumerPhoneNumber, jobType, consumerEmail e bookingAppointmentTimestamp.
chargeStatus Se o lead foi cobrado. Pode ser true ou false.
currencyCode Código da moeda da conta para que o lead foi criado.
disputeStatus Status da disputa do lead.
aggregatorInfo

Informações específicas para parceiros agregadores terceirizados. Esse campo é preenchido apenas para clientes da API associados a parceiros agregadores terceirizados.

timezone Fuso horário da conta associada ao lead. Fornecido no formato do banco de dados de fuso horário da IANA.

Exemplos

URL da solicitação HTTP

https://localservices.googleapis.com/v1/detailedLeadReports:search?query=manager_customer_id:{manager_customer_id}

Exemplo de solicitação HTTP completa

GET /v1/detailedReports:search?query=manager_customer_id:{manager_customer_id} HTTP/1.1
Host: localservices.googleapis.com
User-Agent: curl
Content-Type: application/json
Accept: application/json
Authorization: Bearer [Enter OAuth 2.0 access token here]