- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- Data
Zwraca statystyki połączeń z firmy dla danej lokalizacji.
Żądanie HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
To pole jest wymagane. Lokalizacja nadrzędna, dla której mają być pobierane statystyki połączeń. Format: lokalizacje/{locationId} |
Parametry zapytania
Parametry | |
---|---|
pageSize |
Opcjonalnie. Maksymalna liczba BusinessCallsInsights do zwrócenia. Jeśli wartość nie zostanie określona, zwróconych zostanie maksymalnie 20. Niektóre z tych typów danych(np.AGGREGATE_COUNT) zwracają pojedynczą stronę. W przypadku tych danych parametr pageSize jest ignorowany. |
pageToken |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania Podczas podziału na strony wszystkie pozostałe parametry przekazywane w metodzie |
filter |
Opcjonalnie. Filtr ograniczający statystyki połączeń do zwrócenia. Odpowiedź zawiera tylko wpisy pasujące do filtra. Jeśli wartość MetricType nie zostanie podana, zwracana jest wartość AGGREGATE_COUNT. Jeśli nie podasz daty zakończenia, używana jest ostatnia data, dla której są dostępne dane. Jeśli nie podasz daty rozpoczęcia, domyślnie ustawimy pierwszy dzień, dla którego są dostępne dane, czyli obecnie 6 miesięcy. Jeśli data początkowa przypada przed datą udostępnienia danych, dane są zwracane od dnia, w którym są dostępne. Obecnie obsługujemy następujące filtry. 1. startDate="DATE", gdzie data jest w formacie RRRR-MM-DD. 2. endDate="DATE", gdzie data jest w formacie RRRR-MM-DD. 3. metricType=XYZ, gdzie XYZ to prawidłowy typ MetricType. 4. spójniki(ORAZ) ze wszystkich powyższych, np. "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" Parametr AGGREGATE_COUNT metricType ignoruje część DD w dacie. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Wiadomość z odpowiedzią na businesscallsinsights.list.
Zapis JSON |
---|
{
"businessCallsInsights": [
{
object ( |
Pola | |
---|---|
businessCallsInsights[] |
Zbiór statystyk połączeń telefonicznych z firmą z danej lokalizacji. |
nextPageToken |
Token, który można wysłać jako |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/business.manage
Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.
BusinessCallsInsights
Statystyki połączeń z określoną lokalizacją.
Zapis JSON |
---|
{ "name": string, "metricType": enum ( |
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa zasobu statystyk połączeń. Format: locations/{location}/businesscallsinsights |
metricType |
Dane, których dotyczy dana wartość. |
aggregateMetrics |
Dane dotyczące zakresu czasu na podstawie daty rozpoczęcia i zakończenia. |
MetricType
Typ danych.
Wartości w polu enum | |
---|---|
METRIC_TYPE_UNSPECIFIED |
Typ danych jest nieokreślony. |
AGGREGATE_COUNT |
Podane wskaźniki to liczby agregowane z wejściowego zakresu czasowego. |
AggregateMetrics
Dane zagregowane w podanym zakresie czasu.
Zapis JSON |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
Pola | |
---|---|
missedCallsCount |
Łączna liczba nieodebranych połączeń. |
answeredCallsCount |
Łączna liczba odebranych połączeń. |
hourlyMetrics[] |
Lista danych według pory dnia. |
weekdayMetrics[] |
Lista danych według dnia tygodnia. |
startDate |
Data dla tych danych. Jeśli dane są miesięczne, używane są tylko rok i miesiąc. |
endDate |
Data zakończenia dla tych danych. |
HourlyMetrics
Dane dotyczące godziny.
Zapis JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
Pola | |
---|---|
hour |
Godzina. Dozwolone są wartości z przedziału 0–23. |
missedCallsCount |
Łączna liczba nieodebranych połączeń w tej godzinie. |
WeekDayMetrics
Dane na dzień tygodnia.
Zapis JSON |
---|
{
"day": enum ( |
Pola | |
---|---|
day |
Dzień tygodnia. Dozwolone są wartości od niedzieli do soboty. |
missedCallsCount |
Łączna liczba nieodebranych połączeń w tej godzinie. |
DayOfWeek
Reprezentuje dzień tygodnia.
Wartości w polu enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Dzień tygodnia nie jest określony. |
MONDAY |
poniedziałek |
TUESDAY |
Wtorek |
WEDNESDAY |
Środa |
THURSDAY |
Thursday (czwartek) |
FRIDAY |
piątek |
SATURDAY |
Saturday (sobota) |
SUNDAY |
niedziela |
Data
Reprezentuje całą datę kalendarzową lub jej część, na przykład datę urodzin. Pora dnia i strefa czasowa są podane w innym miejscu lub są nieistotne. Data odnosi się do kalendarza gregoriańskiego. Może to być:
- Pełna data oraz wartości inne niż zero roku, miesiąca i dnia
- Miesiąc i dzień z zerowym rokiem (np. rocznica)
- Jeden rok z zerowym miesiącem i dniem zerowym.
- Rok i miesiąc z zerowym dniem (np.data ważności karty kredytowej).
Powiązane typy: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
Zapis JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Pola | |
---|---|
year |
Rok daty. Należy podać wartość z zakresu od 1 do 9999 lub 0, aby określić datę bez roku. |
month |
Miesiąc w roku. Należy podać wartość z zakresu od 1 do 12 lub 0, aby określić rok bez miesiąca i dnia. |
day |
Dzień miesiąca. Należy podać wartość z zakresu od 1 do 31 i ważną dla roku i miesiąca lub 0, aby określić sam rok lub rok i miesiąc, w którym dzień nie jest istotny. |