Package google.mybusiness.businesscalls.v1

Indeks

BusinessCallsService

Ten interfejs API pozwala firmom zarządzać połączeniami z firmą i gromadzić statystyki takie jak liczba nieodebranych połączeń z firmą. Dodatkowe informacje o połączeniach służbowych znajdziesz na https://support.google.com/business/answer/9688285?p=call_history

Jeśli profil firmy w Google jest połączony z kontem Google Ads i masz włączoną historię połączeń, połączenia, które trwają dłużej niż określony czas i które można przypisać do interakcji z reklamą, będą widoczne na połączonym koncie Google Ads w kolumnie „Połączenia z reklam”. Jeśli w strategii optymalizacji używasz inteligentnego określania stawek i konwersji telefonicznych, wydatki na reklamę mogą się zmienić. Więcej informacji o inteligentnym określaniu stawek”.

Aby wyświetlać połączenia z danej lokalizacji i wykonywać związane z nimi działania, musisz mieć uprawnienia OWNER, CO_OWNER lub MANAGER.

GetBusinessCallsSettings

rpc GetBusinessCallsSettings(GetBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Zwraca zasób ustawień połączeń z firmy dla danej lokalizacji.

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.
ListBusinessCallsInsights

rpc ListBusinessCallsInsights(ListBusinessCallsInsightsRequest) returns (ListBusinessCallsInsightsResponse)

Zwraca statystyki połączeń z firmy dla danej lokalizacji.

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.
UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Aktualizuje ustawienia połączeń biznesowych dla określonej lokalizacji.

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.

AggregateMetrics

Dane zagregowane w podanym zakresie czasu.

Pola
missed_calls_count

Int32Value

Łączna liczba nieodebranych połączeń.
answered_calls_count

Int32Value

Łączna liczba odebranych połączeń.
hourly_metrics[]

HourlyMetrics

Lista danych według pory dnia.
weekday_metrics[]

WeekDayMetrics

Lista danych według dnia tygodnia.
start_date

Date

Data dla tych danych. Jeśli dane są miesięczne, używane są tylko rok i miesiąc.
end_date

Date

Data zakończenia dla tych danych.

BusinessCallsInsights

Statystyki połączeń z określoną lokalizacją.

Pola
name

string

To pole jest wymagane. Nazwa zasobu statystyk połączeń. Format: locations/{location}/businesscallsinsights
metric_type

MetricType

Dane, których dotyczy dana wartość.
aggregate_metrics

AggregateMetrics

Dane dla zakresu czasu na podstawie daty rozpoczęcia i zakończenia.

BusinessCallsSettings

Ustawienia połączeń biznesowych dla danej lokalizacji.

Pola
name

string

To pole jest wymagane. Nazwa zasobu ustawień połączeń. Format: lokalizacje/{lokalizacja}/ustawienia połączeń biznesowych
calls_state

CallsState

To pole jest wymagane. Stan rejestracji w usłudze Połączenia służbowe w danej lokalizacji.
consent_time

Timestamp

Tylko dane wejściowe. Czas, w którym użytkownik interfejsu API wyraził zgodę na połączenia biznesowe.

CallsState

Możliwe stany lokalizacji w rozmowach służbowych. Stany można zmienić na tylko ENABLED lub DISABLED. Wszystkie inne elementy spowodują zwrócenie PREPOLICY_FAILED błędu.

Wartości w polu enum
CALLS_STATE_UNSPECIFIED Nie określono.
ENABLED Połączenia służbowe są włączone dla tej lokalizacji.
DISABLED Połączenia służbowe z tą lokalizacją są wyłączone.

ErrorCode

Kody błędów wewnętrznych.

Wartości w polu enum
ERROR_CODE_UNSPECIFIED Nieokreślony kod błędu.
ERROR_CODE_UNVERIFIED_LOCATION Lokalizacja nie jest zweryfikowana.
ERROR_CODE_CALLS_NOT_ENABLED Stan połączeń biznesowych dla tej lokalizacji nie jest WŁĄCZONY.
ERROR_CODE_NOT_ELIGIBLE_LOCATION W tej lokalizacji nie można wykonywać połączeń biznesowych.

GetBusinessCallsSettingsRequest

Prośba o wiadomość dotyczącą GetBusinessCallsSettings.

Pola
name

string

To pole jest wymagane. BusinessCallsSettings.

Pole name służy do określania ustawień połączeń biznesowych, które chcesz uzyskać. Format: locations/{identyfikator_lokalizacji}/ustawienia_połączeń_firmowych.

HourlyMetrics

Dane dotyczące godziny.

Pola
hour

Int32Value

Godzina. Dozwolone są wartości z przedziału 0–23.
missed_calls_count

Int32Value

Łączna liczba nieodebranych połączeń w tej godzinie.

ListBusinessCallsInsightsRequest

Prośba o wiadomość dotyczącą ListBusinessCallsInsights.

Pola
parent

string

To pole jest wymagane. Lokalizacja nadrzędna, dla której mają być pobierane statystyki połączeń. Format: lokalizacje/{identyfikator_lokalizacji}
page_size

int32

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 page_size jest ignorowany.
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania ListBusinessCallsInsights. Podaj tę wartość, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie pozostałe parametry przekazywane w metodzie ListBusinessCallsInsights muszą odpowiadać wywołaniu, które przekazało token strony. Niektóre typy danych (np.AGGREGATE_COUNT) zwracają pojedynczą stronę. W przypadku tych wskaźników parametr pake_token jest ignorowany.
filter

string

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 zostanie podana data_końcowa, 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 są dostępne dane, czyli obecnie 6 miesięcy. Jeśli data_początkowa jest wcześniejsza niż data dostępności danych, dane są zwracane od dnia, w którym są dostępne.

Obecnie obsługujemy następujące filtry. 1. start_date="DATE", gdzie data jest w formacie RRRR-MM-DD. 2. end_date="DATE", gdzie data jest w formacie RRRR-MM-DD. 3. metric_type=XYZ, gdzie XYZ to prawidłowa wartość w polu MetricType. 4. spójniki(ORAZ) ze wszystkich powyższych, np. "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" Argument typ wskaźnika AGGREGATE_COUNT ignoruje część DD w dacie.

ListBusinessCallsInsightsResponse

Odpowiedź na pytanie dotyczące ListBusinessCallsInsights.

Pola
business_calls_insights[]

BusinessCallsInsights

Zbiór statystyk połączeń telefonicznych z firmą z danej lokalizacji.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron. Niektóre typy danych (np.AGGREGATE_COUNT) zwracają pojedynczą stronę. W przypadku tych danych parametr next_page_token będzie pusty.

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.

UpdateBusinessCallsSettingsRequest

Prośba o wiadomość dotyczącą UpdateBusinessCallsSettings.

Pola
business_calls_settings

BusinessCallsSettings

To pole jest wymagane. BusinessCallsSettings (Ustawienia połączeń firmy), aby je zaktualizować.

Pole name służy do określania ustawień połączeń biznesowych, które należy zaktualizować. Format: lokalizacje/{identyfikator_lokalizacji}/ustawienia połączeń biznesowych
update_mask

FieldMask

To pole jest wymagane. Lista pól do zaktualizowania.

WeekDayMetrics

Dane na dzień tygodnia.

Pola
day

DayOfWeek

Dzień tygodnia. Dozwolone są wartości od niedzieli do soboty.
missed_calls_count

Int32Value

Łączna liczba nieodebranych połączeń w tej godzinie.