Google Business Performance API یک روش API جدید دارد که امکان واکشی چندین «DailyMetrics» را در یک درخواست API فراهم می‌کند.
زمان‌بندی منسوخ شدن و دستورالعمل‌های انتقال از روش API reportInsights v4 به API عملکرد نمایه کسب‌وکار Google را مرور کنید.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Package google.mybusiness.placeactions.v1

فهرست مطالب

PlaceActions (رابط)
CreatePlaceActionLinkRequest (پیام)
DeletePlaceActionLinkRequest (پیام)
ErrorCode (enum)
GetPlaceActionLinkRequest (پیام)
ListPlaceActionLinksRequest (پیام)
ListPlaceActionLinksResponse (پیام)
ListPlaceActionTypeMetadataRequest (پیام)
ListPlaceActionTypeMetadataResponse (پیام)
PlaceActionLink (پیام)
PlaceActionLink.ProviderType (enum)
PlaceActionType (enum)
PlaceActionTypeMetadata (پیام)
UpdatePlaceActionLinkRequest (پیام)

PlaceActions

این API مدیریت پیوندهای PlaceAction مکان های تجاری را امکان پذیر می کند.

CreatePlaceActionLink

CreatePlaceActionLink
`rpc CreatePlaceActionLink( CreatePlaceActionLinkRequest ) returns ( PlaceActionLink )` یک پیوند اقدام مکان مرتبط با مکان مشخص شده ایجاد می کند و آن را برمی گرداند. اگر `parent` ، `place_action_link.uri` و `place_action_link.place_action_type` مانند درخواست قبلی باشد، درخواست تکراری در نظر گرفته می‌شود. محدوده مجوز به محدوده OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/business.manage` برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

rpc CreatePlaceActionLink( CreatePlaceActionLinkRequest ) returns ( PlaceActionLink )

یک پیوند اقدام مکان مرتبط با مکان مشخص شده ایجاد می کند و آن را برمی گرداند. اگر parent ، place_action_link.uri و place_action_link.place_action_type مانند درخواست قبلی باشد، درخواست تکراری در نظر گرفته می‌شود.

محدوده مجوز

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

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

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

حذف PlaceActionLink

حذف PlaceActionLink
`rpc DeletePlaceActionLink( DeletePlaceActionLinkRequest ) returns ( Empty )` پیوند اقدام مکان را از مکان مشخص شده حذف می کند. محدوده مجوز به محدوده OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/business.manage` برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

rpc DeletePlaceActionLink( DeletePlaceActionLinkRequest ) returns ( Empty )

پیوند اقدام مکان را از مکان مشخص شده حذف می کند.

محدوده مجوز

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

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

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

GetPlaceActionLink

GetPlaceActionLink
`rpc GetPlaceActionLink( GetPlaceActionLinkRequest ) returns ( PlaceActionLink )` پیوند اقدام مکان مشخص شده را دریافت می کند. محدوده مجوز به محدوده OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/business.manage` برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

rpc GetPlaceActionLink( GetPlaceActionLinkRequest ) returns ( PlaceActionLink )

پیوند اقدام مکان مشخص شده را دریافت می کند.

محدوده مجوز

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

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

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

ListPlaceActionLinks

ListPlaceActionLinks
`rpc ListPlaceActionLinks( ListPlaceActionLinksRequest ) returns ( ListPlaceActionLinksResponse )` پیوندهای عمل مکان را برای مکان مشخص شده فهرست می کند. محدوده مجوز به محدوده OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/business.manage` برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

rpc ListPlaceActionLinks( ListPlaceActionLinksRequest ) returns ( ListPlaceActionLinksResponse )

پیوندهای عمل مکان را برای مکان مشخص شده فهرست می کند.

محدوده مجوز

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

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

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

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata( ListPlaceActionTypeMetadataRequest ) returns ( ListPlaceActionTypeMetadataResponse )

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

محدوده مجوز

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

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

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

UpdatePlaceActionLink

UpdatePlaceActionLink
`rpc UpdatePlaceActionLink( UpdatePlaceActionLinkRequest ) returns ( PlaceActionLink )` پیوند عمل مکان مشخص شده را به روز می کند و آن را برمی گرداند. محدوده مجوز به محدوده OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/business.manage` برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

rpc UpdatePlaceActionLink( UpdatePlaceActionLinkRequest ) returns ( PlaceActionLink )

پیوند عمل مکان مشخص شده را به روز می کند و آن را برمی گرداند.

محدوده مجوز

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

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

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

CreatePlaceActionLinkRequest

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

زمینه های

زمینه های
`parent`	`string` ضروری. نام منبع مکانی که در آن پیوند اقدام این مکان ایجاد شود. `locations/{location_id}` .
`place_action_link`	`PlaceActionLink` ضروری. پیوند اکشن مکانی که باید ایجاد شود.

parent

string

ضروری. نام منبع مکانی که در آن پیوند اقدام این مکان ایجاد شود. locations/{location_id} .

place_action_link

PlaceActionLink

ضروری. پیوند اکشن مکانی که باید ایجاد شود.

DeletePlaceActionLinkRequest

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

زمینه های

زمینه های
`name`	`string` ضروری. نام منبع پیوند اقدام مکان برای حذف از مکان.

name

string

ضروری. نام منبع پیوند اقدام مکان برای حذف از مکان.

کد خطا

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

Enums
`ERROR_CODE_UNSPECIFIED`	کد خطای نامشخص
`UNVERIFIED_LOCATION`	مکان تأیید نشده است.
`INVALID_LOCATION_CATEGORY`	دسته مکان برای نوع اقدام مکان واجد شرایط نیست. نوع عمل مکان که باعث ایجاد خطا می‌شود، با رشته «place_action_type» به‌عنوان کلید و رشته مقدار `PlaceActionType` enum به‌عنوان مقدار، در ابرداده برگردانده می‌شود.
`INVALID_URL`	آدرس اینترنتی ناقص/نامعتبر است. نشانی وب اقدام مکان نامعتبر با رشته "url" به عنوان کلید و آدرس اینترنتی به عنوان مقدار در ابرداده برگردانده می شود.
`URL_PROVIDER_NOT_ALLOWED`	آدرس اینترنتی ارائه دهنده ای دارد که مجاز نیست. نشانی اینترنتی اقدام مکان که غیرمجاز است، با رشته "url" به عنوان کلید و آدرس اینترنتی به عنوان مقدار، در ابرداده برگردانده می شود.
`TOO_MANY_VALUES`	مقادیر بسیار زیادی برای نوع اقدام مکان تنظیم شده است. نوعی که به آن حد رسیده است در ابرداده بازگردانده می شود، با رشته "place_action_type" به عنوان کلید و رشته مقدار `PlaceActionType` enum به عنوان مقدار.
`DELETED_LINK`	پیوند اقدام مکان درخواستی حذف شده است. url مربوطه با رشته "url" به عنوان کلید و url به عنوان مقدار در ابرداده برگردانده می شود.
`LINK_ALREADY_EXISTS`	یک به‌روزرسانی برای تبدیل پیوند اقدام مکان به پیوندی که از قبل وجود دارد، با همان uri و نوع در مکان مشخص شده درخواست می‌شود.
`SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY`	دامنه ای که پیوند حاوی آن است قبلاً استفاده شده است و برای هر PlaceActionType محدودیت یک پیوند در هر دامنه وجود دارد.
`LINK_DOES_NOT_EXIST`	پیوندی مشخص شده است که در پایگاه داده یافت نمی شود.

GetPlaceActionLinkRequest

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

زمینه های

زمینه های
`name`	`string` ضروری. نام مکان پیوند اقدام برای واکشی.

name

string

ضروری. نام مکان پیوند اقدام برای واکشی.

ListPlaceActionLinksRequest

درخواست پیام برای PlaceActions.ListPlaceActionLinks. این لینک‌های عمل مکان را برای یک مکان، بدون ترتیب خاصی فهرست می‌کند. این ممکن است پیوندهایی را که اخیراً (در 24 ساعت گذشته) از طریق سطوح دیگر ایجاد شده اند، مانند وب سایت Google MyBusiness، بازگرداند. هر پیوندی که بیش از 24 ساعت پیش ایجاد شود از طریق این API نشان داده می شود.

زمینه های
`parent`	`string` ضروری. نام مکانی که پیوندهای اقدام مکان آن فهرست می شود. `locations/{location_id}` .
`filter`	`string` اختیاری. فیلتری که پیوندهای عمل مکان را برای بازگشت محدود می کند. پاسخ شامل ورودی هایی است که با فیلتر مطابقت دارند. ما فقط از فیلتر زیر پشتیبانی می کنیم: 1. place_action_type=XYZ که در آن XYZ یک PlaceActionType معتبر است.
`page_size`	`int32` اختیاری. تعداد پیوندهای عمل مکان برای بازگرداندن در هر صفحه. پیش فرض 10. حداقل 1 است.
`page_token`	`string` اختیاری. اگر مشخص شده باشد، صفحه بعدی پیوندهای اقدام مکان را برمی گرداند.

ListPlaceActionLinksResponse

پیام پاسخ برای PlaceActions.ListPlaceActionLinks.

زمینه های

زمینه های
`place_action_links[]`	`PlaceActionLink` فهرست بازگشتی پیوندهای اقدام مکان.
`next_page_token`	`string` اگر تعداد لینک‌های عمل مکانی بیش از اندازه صفحه درخواستی باشد، این فیلد با یک نشانه برای واکشی صفحه بعدی نتایج پر می‌شود.

place_action_links[]

PlaceActionLink

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

next_page_token

string

اگر تعداد لینک‌های عمل مکانی بیش از اندازه صفحه درخواستی باشد، این فیلد با یک نشانه برای واکشی صفحه بعدی نتایج پر می‌شود.

ListPlaceActionTypeMetadataRequest

درخواست پیام برای PlaceActions.ListPlaceActionTypeMetadata. نتایج بدون ترتیب خاصی برگردانده خواهند شد.

زمینه های
`language_code`	`string` اختیاری. کد زبان IETF BCP-47 برای دریافت نام‌های نمایشی. اگر این زبان در دسترس نباشد، آنها به زبان انگلیسی ارائه می‌شوند.
`page_size`	`int32` اختیاری. چند نوع عمل در هر صفحه گنجانده شود. پیش فرض 10، حداقل 1 است.
`page_token`	`string` اختیاری. در صورت مشخص شدن، صفحه بعدی فراداده نوع عمل مکان بازیابی می شود. هنگامی که فراخوانی به `placeActionTypeMetadata.list` نتایج بیشتری را نسبت به اندازه صفحه درخواستی نشان می دهد `pageToken` برمی گردد.
`filter`	`string` اختیاری. فیلتری که انواع عملکرد مکان را برای برگرداندن ابرداده محدود می کند. پاسخ شامل ورودی هایی است که با فیلتر مطابقت دارند. ما فقط از فیلترهای زیر پشتیبانی می‌کنیم: 1. location=XYZ که در آن XYZ رشته‌ای است که نام منبع یک مکان را در قالب `locations/{location_id}` نشان می‌دهد. 2. region_code=XYZ که در آن XYZ یک کد منطقه یونیکد CLDR برای یافتن انواع عملکرد موجود است. اگر فیلتری ارائه نشود، همه انواع عملکرد مکان برگردانده می شوند.

ListPlaceActionTypeMetadataResponse

پیام پاسخ برای PlaceActions.ListPlaceActionTypeMetadata.

زمینه های

place_action_type_metadata[]

PlaceActionTypeMetadata

مجموعه‌ای از ابرداده‌ها برای انواع عملکرد مکان موجود.

next_page_token

string

اگر تعداد انواع کنش‌ها از اندازه صفحه درخواستی بیشتر باشد، این فیلد با یک نشانه برای واکشی صفحه بعدی در تماس بعدی به placeActionTypeMetadata.list پر می‌شود. در صورت عدم نتیجه بیشتر، این فیلد در پاسخگویی وجود نخواهد داشت.

PlaceActionLink

نشان دهنده پیوند عمل مکان و ویژگی های آن است.

زمینه های
`name`	`string` اختیاری. نام منبع، در قالب `locations/{location_id}/placeActionLinks/{place_action_link_id}` . فیلد نام فقط در درخواست‌های UpdatePlaceActionLink و DeletePlaceActionLink برای به‌روزرسانی و حذف پیوندها در نظر گرفته می‌شود. با این حال، در درخواست CreatePlaceActionLink نادیده گرفته می شود، جایی که `place_action_link_id` توسط سرور با ایجاد موفقیت آمیز پیوند جدید اختصاص داده می شود و به عنوان بخشی از پاسخ بازگردانده می شود.
`provider_type`	`ProviderType` فقط خروجی نوع ارائه دهنده را مشخص می کند.
`is_editable`	`bool` فقط خروجی نشان می دهد که آیا این پیوند توسط مشتری قابل ویرایش است یا خیر.
`uri`	`string` ضروری. لینک uri. یک uri یکسان را می توان برای انواع عملکردهای مختلف در مکان های مختلف مورد استفاده مجدد قرار داد. با این حال، تنها یک پیوند اقدام مکان برای هر ترکیب منحصربه‌فرد از (اوری، نوع عمل مکان، مکان) مجاز است.
`place_action_type`	`PlaceActionType` ضروری. نوع عمل مکان که می توان با استفاده از این لینک انجام داد.
`is_preferred`	`bool` اختیاری. آیا این پیوند توسط تاجر ترجیح داده می شود. فقط یک پیوند را می‌توان به‌عنوان ترجیحی در هر نوع اقدام مکان در یک مکان علامت‌گذاری کرد. اگر یک درخواست آینده پیوند دیگری را به عنوان ترجیحی برای همان نوع اقدام مکان علامت‌گذاری کند، پیوند ترجیحی فعلی (در صورت وجود) اولویت خود را از دست خواهد داد.
`create_time`	`Timestamp` فقط خروجی زمانی که لینک اکشن مکان ایجاد شد.
`update_time`	`Timestamp` فقط خروجی زمانی که پیوند اکشن مکان آخرین بار اصلاح شد.

نوع ارائه دهنده

نوع ارائه دهنده پیوند، فقط قابل خواندن است.

Enums
`PROVIDER_TYPE_UNSPECIFIED`	مشخص نشده است.
`MERCHANT`	یک ارائه دهنده 1P مانند یک تاجر یا یک آژانس از طرف یک تاجر.
`AGGREGATOR_3P`	یک جمع‌کننده 3P، مانند یک شریک `Reserve with Google` .

PlaceActionType

نوع عمل مکانی که می توان با استفاده از پیوند انجام داد.

Enums
`PLACE_ACTION_TYPE_UNSPECIFIED`	مشخص نشده است.
`APPOINTMENT`	نوع اقدام، رزرو قرار است.
`ONLINE_APPOINTMENT`	نوع اقدام رزرو یک قرار آنلاین است.
`DINING_RESERVATION`	نوع عمل رزرو ناهار خوری است.
`FOOD_ORDERING`	نوع اقدام، سفارش غذا برای تحویل و/یا بیرون بردن است.
`FOOD_DELIVERY`	نوع عمل سفارش غذا برای تحویل است.
`FOOD_TAKEOUT`	نوع اقدام، سفارش غذا برای بیرون بردن است.
`SHOP_ONLINE`	نوع اقدام خرید است که می تواند تحویل و/یا تحویل گرفتن باشد.

PlaceActionTypeMetadata

فراداده برای انواع عملکرد مکان پشتیبانی شده.

زمینه های

place_action_type

PlaceActionType

نوع عمل مکان

display_name

string

نام نمایشی محلی برای ویژگی، در صورت موجود بودن؛ در غیر این صورت، نام نمایشی انگلیسی.

UpdatePlaceActionLinkRequest

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

زمینه های

زمینه های
`place_action_link`	`PlaceActionLink` ضروری. پیوند اقدام مکان به روز شده.
`update_mask`	`FieldMask` ضروری. فیلدهای خاص برای به روز رسانی تنها فیلدهای قابل ویرایش `uri` ، `place_action_type` و `is_preferred` هستند. اگر پیوند به روز شده از قبل در همان مکان با همان `place_action_type` و `uri` وجود داشته باشد، با یک خطای `ALREADY_EXISTS` خراب می شود.

place_action_link

PlaceActionLink

ضروری. پیوند اقدام مکان به روز شده.

update_mask

FieldMask

ضروری. فیلدهای خاص برای به روز رسانی تنها فیلدهای قابل ویرایش uri ، place_action_type و is_preferred هستند. اگر پیوند به روز شده از قبل در همان مکان با همان place_action_type و uri وجود داشته باشد، با یک خطای ALREADY_EXISTS خراب می شود.