Package google.mybusiness.businesscalls.v1

فهرست مطالب

BusinessCallsService

این API به کسب‌وکارها اجازه می‌دهد تا تماس‌های تجاری را مدیریت کنند و اطلاعات آماری مانند تعداد تماس‌های بی‌پاسخ به مکان خود را جمع‌آوری کنند. اطلاعات بیشتر درباره تماس‌های تجاری را می‌توانید در https://support.google.com/business/answer/9688285?p=call_history بیابید

اگر نمایه کسب‌وکار Google به یک حساب Google Ads پیوند داده شود و سابقه تماس فعال باشد، تماس‌هایی که بیشتر از یک زمان خاص طول می‌کشند و می‌توانند به یک تعامل تبلیغاتی نسبت داده شوند، در حساب Google Ads مرتبط در زیر «تماس‌ها از طرف» نشان داده می‌شوند. تبدیل تبلیغات. اگر در استراتژی بهینه‌سازی از مناقصه هوشمند و تبدیل تماس استفاده شود، ممکن است تغییری در هزینه تبلیغات ایجاد شود. درباره مناقصه هوشمند بیشتر بدانید ."

برای مشاهده و انجام اقدامات روی تماس‌های یک مکان، باید OWNER ، CO_OWNER یا MANAGER مکان باشید.

GetBusinessCallsSettings

rpc GetBusinessCallsSettings( GetBusinessCallsSettingsRequest ) returns ( BusinessCallsSettings )

منبع تنظیمات تماس های تجاری را برای مکان داده شده برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListBusinessCallsInsights

rpc ListBusinessCallsInsights( ListBusinessCallsInsightsRequest ) returns ( ListBusinessCallsInsightsResponse )

اطلاعات آماری تماس‌های تجاری برای یک مکان را برمی‌گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings( UpdateBusinessCallsSettingsRequest ) returns ( BusinessCallsSettings )

تنظیمات تماس تجاری را برای مکان مشخص شده به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

AggregateMetrics

معیارها در محدوده زمانی ورودی جمع‌آوری می‌شوند.

زمینه های
missed_calls_count

Int32Value

تعداد کل تماس های از دست رفته

answered_calls_count

Int32Value

تعداد کل تماس های پاسخ داده شده

hourly_metrics[]

HourlyMetrics

فهرستی از معیارها بر حسب ساعت از روز.

weekday_metrics[]

WeekDayMetrics

فهرستی از معیارها بر اساس روز هفته.

start_date

Date

تاریخ برای این معیار. اگر متریک ماهانه باشد، فقط از سال و ماه استفاده می شود.

end_date

Date

تاریخ پایان برای این سنجه.

BusinessCallsInsights

اطلاعات آماری برای تماس های برقرار شده با یک مکان.

زمینه های
name

string

ضروری. نام منبع اطلاعات تماس ها. قالب: مکان‌ها/{location}/businesscallsinsights

metric_type

MetricType

معیاری که برای آن مقدار اعمال می شود.

aggregate_metrics

AggregateMetrics

متریک برای محدوده زمانی بر اساس start_date و end_date.

BusinessCallsSettings

تنظیمات تماس های تجاری برای یک مکان.

زمینه های
name

string

ضروری. نام منبع تنظیمات تماس. قالب: مکان‌ها/{location}/businesscallssettings

calls_state

CallsState

ضروری. وضعیت ثبت‌نام این مکان در تماس‌های تجاری.

consent_time

Timestamp

فقط ورودی زمانی که کاربر نهایی رضایت کاربر API را برای فعال کردن تماس های تجاری ارائه کرد.

CallsState

حالت های احتمالی یک مکان در تماس های تجاری. حالت ها را می توان فقط به فعال یا غیرفعال به روز کرد. هر چیز دیگری خطای PRECONDITION_FAILED را برمی‌گرداند.

Enums
CALLS_STATE_UNSPECIFIED نامشخص
ENABLED تماس های تجاری برای مکان فعال است.
DISABLED تماس‌های تجاری برای مکان غیرفعال است.

کد خطا

کدهای خطا برای خرابی های داخلی

Enums
ERROR_CODE_UNSPECIFIED کد خطای نامشخص
ERROR_CODE_UNVERIFIED_LOCATION مکان تأیید نشده است.
ERROR_CODE_CALLS_NOT_ENABLED وضعیت تماس های تجاری برای مکان فعال نیست.
ERROR_CODE_NOT_ELIGIBLE_LOCATION مکان برای تماس های کاری واجد شرایط نیست.

GetBusinessCallsSettingsRequest

درخواست پیام برای GetBusinessCallsSettings.

زمینه های
name

string

ضروری. BusinessCallsSettings را دریافت کنید.

فیلد name برای شناسایی تنظیمات تماس تجاری برای دریافت استفاده می شود. قالب: locations/{location_id}/businesscallssettings.

ساعتی متریک

متریک برای یک ساعت

زمینه های
hour

Int32Value

ساعت از روز. مقادیر مجاز 0-23 هستند.

missed_calls_count

Int32Value

تعداد کل تماس های از دست رفته برای این ساعت.

ListBusinessCallsInsightsRequest

درخواست پیام برای ListBusinessCallsInsights.

زمینه های
parent

string

ضروری. مکان والد برای واکشی اطلاعات آماری تماس‌ها. قالب: مکان‌ها/{location_id}

page_size

int32

اختیاری. حداکثر تعداد BusinessCallsInsights برای بازگشت. در صورت نامشخص حداکثر 20 عدد برگردانده می شود. برخی از metric_types (به عنوان مثال، AGGREGATE_COUNT) یک صفحه را برمی گرداند. برای این معیارها، page_size نادیده گرفته می شود.

page_token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی ListBusinessCallsInsights . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ListBusinessCallsInsights باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. برخی از metric_types (به عنوان مثال، AGGREGATE_COUNT) یک صفحه را برمی گرداند. برای این معیارها، pake_token نادیده گرفته می شود.

filter

string

اختیاری. فیلتری که بینش تماس ها را برای بازگشت محدود می کند. پاسخ فقط شامل ورودی هایی می شود که با فیلتر مطابقت دارند.

اگر MetricType ارائه نشده باشد، AGGREGATE_COUNT برگردانده می شود. اگر تاریخ پایانی ارائه نشده باشد، از آخرین تاریخی که داده‌ها برای آن موجود است استفاده می‌شود. اگر start_date ارائه نشود، به طور پیش‌فرض به اولین تاریخی که داده‌های آن در دسترس است، که در حال حاضر 6 ماه است، می‌رسیم. اگر start_date قبل از تاریخی باشد که داده‌ها در دسترس هستند، داده‌ها از تاریخی که در دسترس هستند بازگردانده می‌شوند.

در حال حاضر ما از فیلترهای زیر پشتیبانی می کنیم. 1. start_date="DATE" که در آن تاریخ در قالب YYYY-MM-DD است. 2. end_date="DATE" که در آن تاریخ در قالب YYYY-MM-DD است. 3. metric_type=XYZ که در آن XYZ یک MetricType معتبر است. 4. حروف ربط (AND) همه موارد فوق. به عنوان مثال، "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" AGGREGATE_COUNT metric_type قسمت DD تاریخ را نادیده می گیرد.

ListBusinessCallsInsightsResponse

پیام پاسخ برای ListBusinessCallsInsights.

زمینه های
business_calls_insights[]

BusinessCallsInsights

مجموعه‌ای از اطلاعات آماری برای مکان.

next_page_token

string

یک نشانه، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. برخی از metric_types (به عنوان مثال، AGGREGATE_COUNT) یک صفحه را برمی گرداند. برای این معیارها، next_page_token خالی خواهد بود.

نوع متریک

نوع متریک.

Enums
METRIC_TYPE_UNSPECIFIED نوع متریک مشخص نشده است.
AGGREGATE_COUNT معیارهای ارائه شده، شمارش‌هایی هستند که در محدوده زمانی ورودی جمع‌آوری شده‌اند.

UpdateBusinessCallsSettingsRequest

درخواست پیام برای UpdateBusinessCallsSettings.

زمینه های
business_calls_settings

BusinessCallsSettings

ضروری. BusinessCallsSettings برای به‌روزرسانی.

فیلد name برای شناسایی تنظیمات تماس تجاری برای به‌روزرسانی استفاده می‌شود. قالب: locations/{location_id}/businesscallssettings

update_mask

FieldMask

ضروری. لیست فیلدهایی که باید به روز شوند.

WeekDayMetrics

معیارهای یک روز هفته

زمینه های
day

DayOfWeek

روز هفته. مقادیر مجاز یکشنبه تا شنبه است.

missed_calls_count

Int32Value

تعداد کل تماس های از دست رفته برای این ساعت.