- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- Data
Zwraca statystyki połączeń biznesowych z lokalizacją.
Żądanie HTTP
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
parent |
Wymagane. Lokalizacja nadrzędna, dla której mają być pobierane statystyki połączeń. Format: lokalizacje/{locationId} |
Parametry zapytania
Parametry | |
---|---|
pageSize |
Opcjonalnie: Maksymalna liczba statystyk BusinessCallsInsights do zwrócenia. Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 20. Niektóre z rodzajów danych(np.AGGREGATE_COUNT) zwracają jedną stronę. W przypadku tych danych wartość pageSize jest ignorowana. |
pageToken |
Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu |
filter |
Opcjonalnie: Filtr ograniczający statystyki połączeń, które mają zostać zwrócone. Odpowiedź zawiera tylko wpisy pasujące do filtra. Jeśli typ wskaźnika nie jest podany, zwracana jest wartość AGGREGATE_COUNT. Jeśli nie podano endDate, używana jest ostatnia data, dla której są dostępne dane. Jeśli nie podasz daty początkowej, domyślnie zostanie użyta pierwsza data, dla której dostępne są dane, czyli obecnie 6 miesięcy. Jeśli data początkowa przypada przed datą dostępności danych, to dane są zwracane od daty ich udostępnienia. Obecnie obsługujemy następujące filtry. 1. startDate="DATA" gdzie data jest w formacie RRRR-MM-DD. 2. endDate="DATA" gdzie data jest w formacie RRRR-MM-DD. 3. metricType=XYZ, gdzie XYZ to prawidłowy typ wskaźnika. 4. Spójniki(ORAZ) wszystkich powyższych. np. "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" Typ danych AGGREGATE_COUNT ignoruje część daty DD. |
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 temat businesscallsinsights.list.
Zapis JSON |
---|
{
"businessCallsInsights": [
{
object ( |
Pola | |
---|---|
businessCallsInsights[] |
Zbiór statystyk dotyczących połączeń biznesowych w danej lokalizacji. |
nextPageToken |
Token, który może zostać wysłany 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 lokalizacją.
Zapis JSON |
---|
{ "name": string, "metricType": enum ( |
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu statystyk połączeń. Format: lokalizacje/{lokalizacja}/businesscallsinsights |
metricType |
Dane, do których ma zastosowanie wartość. |
aggregateMetrics |
Dane dotyczące zakresu czasu na podstawie data rozpoczęcia i data zakończenia. |
MetricType
Typ danych.
Wartości w polu enum | |
---|---|
METRIC_TYPE_UNSPECIFIED |
Typ wskaźnika nie jest określony. |
AGGREGATE_COUNT |
Podane wskaźniki to liczby zbiorcze w zakresie wejściowego zakresu czasu. |
AggregateMetrics
Wskaźniki zagregowane w wejściowym zakresie czasowym.
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 rodzaj danych jest miesięczny, używane są tylko rok i miesiąc. |
endDate |
Data zakończenia dla tych danych. |
HourlyMetrics
Dane na godzinę.
Zapis JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
Pola | |
---|---|
hour |
Pora dnia. Dozwolone są wartości z przedziału 0–23. |
missedCallsCount |
Łączna liczba nieodebranych połączeń w tej godzinie. |
WeekDayMetrics
Dane dla dnia tygodnia.
Zapis JSON |
---|
{
"day": enum ( |
Pola | |
---|---|
day |
Dzień tygodnia. Dozwolone wartości to od niedzieli do soboty. |
missedCallsCount |
Łączna liczba nieodebranych połączeń w tej godzinie. |
DzieńTygodnia
Przedstawia dzień tygodnia.
Wartości w polu enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Dzień tygodnia nie jest określony. |
MONDAY |
Poniedziałek |
TUESDAY |
Tuesday (wtorek) |
WEDNESDAY |
Wednesday (środa) |
THURSDAY |
Thursday (czwartek) |
FRIDAY |
Friday (piątek) |
SATURDAY |
Saturday (sobota) |
SUNDAY |
niedziela |
Data
Reprezentuje całą datę lub jej część, na przykład datę urodzin. Pora dnia i strefa czasowa zostały określone w innym miejscu lub są nieistotne. Data zależy od kalendarza gregoriańskiego. Może to być jedna z tych wartości:
- pełną datę, zawierającą rok, miesiąc i dzień o wartości większej niż 0;
- Miesiąc i dzień bez roku (np. rocznica)
- Samotny rok z zerowym miesiącem i zerowym dniem
- Rok i miesiąc z zerową datą ważności (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. Wartość musi mieścić się w zakresie od 1 do 9999 lub od 0 do określenia daty bez roku. |
month |
Miesiąc w roku. Musi mieścić się w zakresie od 1 do 12 lub 0, jeśli chcesz określić rok bez miesiąca i dnia. |
day |
Dzień miesiąca. Wartość musi należeć do zakresu od 1 do 31 i jest ważna dla roku i miesiąca. Wartość 0 pozwala określić pojedynczy rok lub rok i miesiąc, w którym dzień nie jest istotny. |