Package google.mybusiness.businesscalls.v1

Index

BusinessCallsService

Mit dieser API können Unternehmen geschäftliche Anrufe verwalten und Informationen wie die Anzahl der verpassten Anrufe bei ihrem Standort erfassen. Weitere Informationen zu geschäftlichen Anrufen finden Sie unter https://support.google.com/business/answer/9688285?p=call_history.

Wenn das Google Unternehmensprofil mit einem Google Ads-Konto verknüpft und die Anrufliste aktiviert ist, werden Anrufe, die länger als eine bestimmte Zeit dauern und einer Anzeigeninteraktion zugeordnet werden können, im verknüpften Google Ads-Konto unter der Conversion „Anrufe über Anzeigen“ aufgeführt. Wenn in der Optimierungsstrategie Smart Bidding und Anruf-Conversions verwendet werden, können sich die Werbeausgaben ändern. Weitere Informationen zu Smart Bidding

Um die Anrufe eines Standorts aufrufen und ausführen zu können, müssen Sie ein OWNER, CO_OWNER oder MANAGER des Standorts sein.

GetBusinessCallsSettings

rpc GetBusinessCallsSettings(GetBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Gibt die Ressource für Einstellungen für Unternehmensanrufe für den angegebenen Standort zurück

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
ListBusinessCallsInsights

rpc ListBusinessCallsInsights(ListBusinessCallsInsightsRequest) returns (ListBusinessCallsInsightsResponse)

Gibt Statistiken zu geschäftlichen Anrufen für einen Standort zurück

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

Aktualisiert die Einstellungen für geschäftliche Anrufe für den angegebenen Standort.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

AggregateMetrics

Über den Eingabezeitraum aggregierte Messwerte.

Felder
missed_calls_count

Int32Value

Gesamtzahl der verpassten Anrufe.
answered_calls_count

Int32Value

Gesamtzahl der angenommenen Anrufe.
hourly_metrics[]

HourlyMetrics

Eine Liste der Messwerte nach Tageszeit.
weekday_metrics[]

WeekDayMetrics

Eine Liste der Messwerte nach Wochentag.
start_date

Date

Datum für diesen Messwert. Wenn der Messwert monatlich ist, werden nur Jahr und Monat verwendet.
end_date

Date

Enddatum für diesen Messwert.

BusinessCallsInsights

Statistiken zu Anrufen an einem Standort

Felder
name

string

Erforderlich. Der Ressourcenname der Anrufstatistiken. Format: locations/{location}/businesscallsinsights
metric_type

MetricType

Der Messwert, für den der Wert gilt.
aggregate_metrics

AggregateMetrics

Messwert für den Zeitraum, der auf „start_date“ und „end_date“ basiert.

BusinessCallsSettings

Einstellungen für geschäftliche Anrufe für einen Standort.

Felder
name

string

Erforderlich. Der Ressourcenname der Aufrufeinstellungen. Format: locations/{location}/businesscallssettings
calls_state

CallsState

Erforderlich. Der Status der Registrierung dieses Standorts für geschäftliche Anrufe.
consent_time

Timestamp

Nur Eingabe. Zeitpunkt, zu dem der Endnutzer dem API-Nutzer seine Einwilligung erteilt hat, Geschäftsaufrufe zu ermöglichen.

CallsState

Die möglichen Status eines Standorts in Unternehmensanrufen. Die Status können nur auf AKTIVIERT oder DEAKTIVIERT aktualisiert werden. Ansonsten wird der Fehler PRECONDITION_FAILED zurückgegeben.

Enums
CALLS_STATE_UNSPECIFIED Nicht angegeben
ENABLED Geschäftliche Anrufe sind für den Standort aktiviert.
DISABLED Geschäftliche Anrufe sind für diesen Standort deaktiviert.

ErrorCode

Fehlercodes für interne Fehler.

Enums
ERROR_CODE_UNSPECIFIED Unbekannter Fehlercode.
ERROR_CODE_UNVERIFIED_LOCATION Der Standort ist nicht bestätigt.
ERROR_CODE_CALLS_NOT_ENABLED Der Status der Unternehmensaufrufe ist für den Standort nicht AKTIVIERT.
ERROR_CODE_NOT_ELIGIBLE_LOCATION Der Standort ist nicht für geschäftliche Anrufe geeignet.

GetBusinessCallsSettingsRequest

Anfragenachricht für GetBusinessCallsSettings

Felder
name

string

Erforderlich. Die abzurufenden BusinessCallsSettings.

Im Feld „name“ werden die Einstellungen für geschäftliche Anrufe festgelegt, die abgerufen werden sollen. Format: locations/{location_id}/businesscallssettings.

HourlyMetrics

Messwerte für eine Stunde.

Felder
hour

Int32Value

Tageszeit. Zulässige Werte sind 0–23.
missed_calls_count

Int32Value

Gesamtzahl der verpassten Anrufe für diese Stunde.

ListBusinessCallsInsightsRequest

Anfragenachricht für ListBusinessCallsInsights

Felder
parent

string

Erforderlich. Der übergeordnete Standort, für den Anrufstatistiken abgerufen werden sollen. Format: locations/{location_id}
page_size

int32

Optional. Die maximale Anzahl von BusinessCallsInsights, die zurückgegeben werden sollen. Wenn keine Vorgabe erfolgt, werden höchstens 20 zurückgegeben. Einige „metric_types“ (z. B. AGGREGATE_COUNT) geben eine einzelne Seite zurück. Bei diesen Messwerten wird „page_size“ ignoriert.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListBusinessCallsInsights-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListBusinessCallsInsights bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Einige „metric_types“ (z. B. AGGREGATE_COUNT) geben eine einzelne Seite zurück. Bei diesen Messwerten wird „pake_token“ ignoriert.
filter

string

Optional. Ein Filter, der die zurückzugebenden Statistiken zu Aufrufen einschränkt. Die Antwort enthält nur Einträge, die dem Filter entsprechen.

Wenn kein MetricType angegeben ist, wird AGGREGATE_COUNT zurückgegeben. Wenn kein Enddatum angegeben ist, wird das letzte Datum verwendet, für das Daten verfügbar sind. Wenn kein start_date angegeben wird, wird standardmäßig das erste Datum verwendet, für das Daten verfügbar sind, also derzeit sechs Monate. Wenn das Startdatum vor dem Datum liegt, an dem Daten verfügbar sind, werden die Daten ab dem Datum zurückgegeben, an dem sie verfügbar sind.

Derzeit werden folgende Filter unterstützt. 1. start_date="DATE", wobei das Datum im Format JJJJ-MM-TT angegeben wird 2. end_date="DATE", wobei das Datum im Format JJJJ-MM-TT angegeben wird. 3. "metric_type=XYZ", wobei XYZ für "MetricType" steht. 4. Konjunktionen(AND) der oben genannten Punkte, z. B. "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" Der Messwert AGGREGATE_COUNT metric_type ignoriert den TT-Teil des Datums.

ListBusinessCallsInsightsResponse

Antwortnachricht für ListBusinessCallsInsights

Felder
business_calls_insights[]

BusinessCallsInsights

Eine Sammlung von Statistiken zu Unternehmensanrufen für den Standort
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten. Einige „metric_types“ (z. B. AGGREGATE_COUNT) geben eine einzelne Seite zurück. Bei diesen Messwerten ist das Token „next_page_token“ leer.

MetricType

Der Typ des Messwerts.

Enums
METRIC_TYPE_UNSPECIFIED Der Typ des Messwerts ist nicht angegeben.
AGGREGATE_COUNT Die angegebenen Messwerte sind Zählungen, die über den Eingabezeitraum (time_range) aggregiert wurden.

UpdateBusinessCallsSettingsRequest

Anfragenachricht für UpdateBusinessCallsSettings

Felder
business_calls_settings

BusinessCallsSettings

Erforderlich. Die zu aktualisierenden BusinessCallsSettings.

Mit dem Feld „name“ werden die Einstellungen für geschäftliche Anrufe festgelegt, die aktualisiert werden sollen. Format: locations/{location_id}/businesscallssettings
update_mask

FieldMask

Erforderlich. Die Liste der zu aktualisierenden Felder.

WeekDayMetrics

Messwerte für einen Wochentag

Felder
day

DayOfWeek

Wochentag. Zulässige Werte sind Sonntag bis Samstag.
missed_calls_count

Int32Value

Gesamtzahl der verpassten Anrufe für diese Stunde.