Rapports

Les rapports vous permettent de récupérer des informations sur les performances des annonces et les prospects de vos comptes associés.

Rapports de compte

Les rapports sur les comptes affichent les performances et les métriques associées aux comptes Services de proximité associés d'un compte administrateur. Vous pouvez afficher ces données sur une période spécifiée. Les données peuvent être obsolètes jusqu'à 30 minutes.

Pour obtenir le rapport, envoyez une requête HTTP GET à https://localservices.googleapis.com/v1/accountReports:search avec les paramètres d'URL configurables suivants :

Paramètres d'URL
query

Obligatoire

Contient une ou plusieurs valeurs d'ID, dont l'une doit être l'ID du compte administrateur pour la requête. query peut accepter plusieurs valeurs séparées par un point-virgule :

  • Obligatoire : manager_customer_id:<manager_cid>
  • Facultatif : customer_id:<linked_cid>

Exemple : query=manager_customer_id:123;customer_id:456

startDate.day

Facultatif

Jour du mois où commence la période de référence. Peut prendre des valeurs comprises entre 1 et 31 inclus. La valeur par défaut est 1.

startDate.month

Facultatif

Mois de début de la période de référence. Peut prendre des valeurs comprises entre 1 et 12 inclus. Par défaut, le mois en cours.

startDate.year

Facultatif

Année de début de la période de référence, au format YYYY. La valeur par défaut est l'année en cours.

endDate.day

Facultatif

Jour du mois où se termine la période de référence. Les valeurs possibles sont comprises entre 1 et 31 inclus. La valeur par défaut est le jour actuel.

endDate.month

Facultatif

Mois de fin de la période du rapport. Peut prendre des valeurs comprises entre 1 et 12 inclus. Par défaut, le mois en cours.

endDate.year

Facultatif

Année de fin de la période du rapport, au format YYYY. La valeur par défaut est l'année en cours.

pageSize

Facultatif

Entier positif indiquant le nombre d'entrées à renvoyer. La valeur par défaut est 1000 et la valeur maximale est 10000.

pageToken

Facultatif

Chaîne. Saisissez le next_page_token de la réponse précédente dans ce champ.

Les champs du tableau précédent permettent de construire un SearchAccountReportsRequest. Pour chaque numéro client de la requête, un AccountReports correspondant est inclus dans SearchAccountReportsResponse. Chaque rapport sur le compte correspond à un compte client associé qui diffuse des annonces Local Services.

Le tableau suivant présente les champs de AccountReports :

Champs
accountId ID client associé à un compte Local Services.
businessName Nom de l'entreprise du client.
averageWeeklyBudget Budget hebdomadaire moyen actuel du client.
averageFiveStarRating Note moyenne sur cinq étoiles, calculée à partir de tous les avis disponibles du client.
totalReview Nombre total d'avis disponibles pour le client.
impressionsLastTwoDays Nombre total d'impressions enregistrées par le compte au cours des deux derniers jours.
phoneLeadResponsiveness Réactivité du compte aux prospects téléphoniques au cours des 90 derniers jours. Pour calculer ce pourcentage, le nombre total d'appels connectés provenant de prospects ayant un numéro de téléphone facturé est divisé par le nombre total d'appels reçus.
currentPeriodChargedLeads Nombre de prospects facturés au cours de la période spécifiée.
previousPeriodChargedLeads Nombre de prospects facturés au cours de la période précédente. Par exemple, si la plage de dates est définie du 21 au 30 janvier, la période précédente s'étend du 11 au 20 janvier.
currentPeriodTotalCost Somme du coût des prospects facturés au cours de la période spécifiée.
previousPeriodTotalCost Somme des coûts des prospects facturés au cours de la période précédente. Par exemple, si la plage de dates est définie du 21 au 30 janvier, la période précédente s'étend du 11 au 20 janvier.
currencyCode Code de devise du compte client.
currentPeriodPhoneCalls Nombre d'appels téléphoniques (aboutis et non aboutis) au cours de la période spécifiée.
previousPeriodPhoneCalls Nombre d'appels téléphoniques passés au cours de la période précédente, qu'ils aient abouti ou non.
currentPeriodConnectedPhoneCalls Nombre d'appels téléphoniques établis au cours de la période spécifiée, d'une durée supérieure à 30 secondes.
previousPeriodConnectedPhoneCalls Nombre d'appels téléphoniques connectés au cours de la période précédente, d'une durée supérieure à 30 secondes.

Exemples

URL de la requête HTTP

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

Exemple de requête HTTP complète

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]

Rapports détaillés sur les prospects

Les rapports détaillés sur les prospects offrent une vue approfondie des prospects associés aux comptes Annonces Local Services associés d'un compte administrateur. Vous pouvez afficher ces données sur une période spécifiée. Pour une plage de dates donnée, le rapport inclut les prospects créés ou ceux dont l'état de litige a été modifié. Les données peuvent être obsolètes (jusqu'à 30 minutes).

Pour obtenir le rapport, envoyez une requête HTTP GET à https://localservices.googleapis.com/v1/detailedLeadReports:search avec les paramètres d'URL configurables suivants :

Paramètres d'URL
query

Obligatoire

Contient une ou plusieurs valeurs d'ID, dont l'une doit être l'ID du compte administrateur pour la requête. query peut accepter plusieurs valeurs séparées par un point-virgule :

  • Obligatoire : manager_customer_id:<manager_cid>
  • Facultatif : customer_id:<linked_cid>

Exemple : query=manager_customer_id:123;customer_id:456

startDate.day

Facultatif

Jour du mois où commence la période de référence. Peut prendre des valeurs comprises entre 1 et 31 inclus. La valeur par défaut est 1.

startDate.month

Facultatif

Mois de début de la période de référence. Peut prendre des valeurs comprises entre 1 et 12 inclus. Par défaut, le mois en cours.

startDate.year

Facultatif

Année de début de la période de référence, au format YYYY. La valeur par défaut est l'année en cours.

endDate.day

Facultatif

Jour du mois où se termine la période de référence. Les valeurs possibles sont comprises entre 1 et 31 inclus. La valeur par défaut est le jour actuel.

endDate.month

Facultatif

Mois de fin de la période du rapport. Peut prendre des valeurs comprises entre 1 et 12 inclus. Par défaut, le mois en cours.

endDate.year

Facultatif

Année de fin de la période du rapport, au format YYYY. La valeur par défaut est l'année en cours.

pageSize

Facultatif

Entier positif indiquant le nombre d'entrées à renvoyer. La valeur par défaut est 1000 et la valeur maximale est 10000.

pageToken

Facultatif

Chaîne. Saisissez le next_page_token de la réponse précédente dans ce champ.

Les champs précédents permettent de construire un SearchDetailedLeadReportsRequest. Pour chaque ID client de la requête, un DetailedLeadReports correspondant est inclus dans SearchDetailedLeadReportsResponse. Chaque rapport détaillé sur les prospects correspond à un prospect spécifique associé à un compte client associé qui diffuse des annonces Local Services.

Le tableau suivant présente les champs de DetailedLeadReports :

Champs
leadId Identifiant unique d'un prospect.
accountId Identifie le compte qui a reçu le prospect.
businessName Nom de l'entreprise associé au compte.
leadCreationTimestamp

Code temporel de la création du prospect. Inclut la date au format M/D/YYYY et l'heure au format HH:MM:SS.

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

leadType Type de prospect : MESSAGE ou PHONE_CALL.
leadCategory

Catégorie de service associée au prospect.

Exemple : housecleaner

geo

Emplacements de la ville de résidence du compte associé.

Exemple : San Francisco, California, United States

messageLead Informations associées uniquement aux prospects de message : customerName, jobType, postalCode et consumerPhoneNumber.
phoneLead Informations associées uniquement aux prospects téléphoniques : chargedCallTimestamp, chargedConnectedCallDurationSeconds et consumerPhoneNumber.
bookingLead Informations associées uniquement aux prospects pour une réservation : customerName, consumerPhoneNumber, jobType, consumerEmail et bookingAppointmentTimestamp.
chargeStatus Indique si le prospect a été facturé. Il peut s'agir de true ou false.
currencyCode Code de devise du compte pour lequel le prospect a été créé.
disputeStatus État de la contestation du prospect.
aggregatorInfo

Informations spécifiques aux agrégateurs partenaires tiers. Ce champ n'est renseigné que pour les clients API associés à des agrégateurs partenaires tiers.

timezone Fuseau horaire du compte associé au prospect. Indiqué au format de la base de données des fuseaux horaires IANA.

Exemples

URL de la requête HTTP

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

Exemple de requête HTTP complète

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]