آخرین به‌روزرسانی‌های API پروفایل کسب‌وکار

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

‫Google برای ترجمه محتوا به زبان ترجیحی شما از فناوری هوشواره استفاده می‌کند. ترجمه‌های هوشواره‌ای ممکن است اشتباه داشته باشند.

Method: attributes.list

درخواست اچ‌تی‌تی‌پی
پارامترهای پُرسمان
متن درخواست
متن پاسخ
- نمایش JSON
دامنه‌های مجوز
AttributeMetadata
- نمایش JSON
AttributeValueMetadata
- نمایش JSON

فهرست مشخصه‌هایی را که برای مکان با دسته اصلی و کشور ارائه‌شده دردسترس است برمی‌گرداند.

درخواست HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

پارامترهای پُرسمان

پارامترها
`parent`	`string` اختیاری. نام منبع مکان برای جستجوی مشخصه‌های دردسترس. اگر این فیلد تنظیم شده باشد، `categoryName`، `regionCode`، `languageCode`، و `showAll` الزامی نیستند و نباید تنظیم شوند. قالب: `locations/{locationId}` (مثلاً `locations/1234567890`).
`categoryName`	`string` اختیاری. شناسه ثابت دسته اصلی برای پیدا کردن مشخصه‌های دردسترس. باید در قالب `categories/{category_id}` باشد (برای نمونه، `categories/gcid:restaurant`). اگر `parent` تنظیم نشده باشد و `showAll` نادرست باشد، الزامی است.
`regionCode`	`string` اختیاری. کد کشور ISO 3166-1 alpha-2 برای یافتن مشخصه‌های دردسترس. اگر `parent` تنظیم نشده باشد، الزامی است.
`languageCode`	`string` اختیاری. کد BCP 47 زبان برای دریافت نام‌های نمایشی مشخصه. اگر این زبان دردسترس نباشد، به زبان انگلیسی ارائه خواهد شد.
`showAll`	`boolean` اختیاری. اگر روی «درست» تنظیم شود، فراداده همه مشخصه‌های دردسترس برگردانده می‌شود و فیلدهای `parent` و `categoryName` نادیده گرفته می‌شود. وقتی `showAll` روی درست تنظیم شده باشد، `languageCode` و `regionCode` لازم است.
`pageSize`	`integer` تعداد مشخصه‌هایی که باید در هر صفحه گنجانده شود. پیش‌فرض ۲۰۰ و حداقل ۱ است.
`pageToken`	`string` اگر مشخص شده باشد، صفحه بعدی فراداده مشخصه بازیابی می‌شود.

متن درخواست

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پاسخ برای AttributesService.ListAttributeMetadata.

درصورت موفقیت‌آمیز بودن، بدنه پاسخ حاوی داده‌هایی با ساختار زیر است:

نمایش JSON
{ "attributeMetadata": [ { object (`AttributeMetadata`) } ], "nextPageToken": string }

فیلدها

attributeMetadata[]

object (AttributeMetadata)

مجموعه‌ای از فراداده‌های مشخصه برای مشخصه‌های دردسترس.

nextPageToken

string

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

دامنه‌های مجوز

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

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

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

AttributeMetadata

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

نمایش JSON

نمایش JSON
{ "parent": string, "valueType": enum (`AttributeValueType`), "displayName": string, "groupDisplayName": string, "repeatable": boolean, "valueMetadata": [ { object (`AttributeValueMetadata`) } ], "deprecated": boolean }

{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}

فیلدها
`parent`	`string` شناسه یکتای مشخصه.
`valueType`	`enum (AttributeValueType)` نوع مقدار برای مشخصه. مقادیر تنظیم‌شده و بازیابی‌شده باید از این نوع باشند.
`displayName`	`string` نام نمایشی بومی‌سازی‌شده برای مشخصه، درصورت دردسترس بودن؛ درغیراین‌صورت، نام نمایشی انگلیسی.
`groupDisplayName`	`string` نام نمایشی بومی‌سازی‌شده گروهی که این مشخصه را دارد، درصورت وجود؛ درغیراین‌صورت، نام انگلیسی گروه. مشخصه‌های مرتبط در یک گروه جمع‌آوری شده‌اند و باید باهم تحت عنوان ارائه‌شده در اینجا نمایش داده شوند.
`repeatable`	`boolean` اگر درست باشد، مشخصه از چند مقدار پشتیبانی می‌کند. اگر نادرست باشد، فقط یک مقدار باید ارائه شود.
`valueMetadata[]`	`object (AttributeValueMetadata)` برای برخی‌از انواع مشخصه‌ها (برای مثال، شمارشی‌ها)، فهرستی از مقادیر پشتیبانی‌شده و نام‌های نمایشی متناظر برای آن مقادیر ارائه می‌شود.
`deprecated`	`boolean` اگر درست باشد، مشخصه منسوخ شده است و دیگر نباید استفاده شود. اگر منسوخ شده باشد، به‌روزرسانی این مشخصه منجر به خطا نخواهد شد، اما به‌روزرسانی‌ها ذخیره نخواهند شد. مدتی پس‌از منسوخ شدن، مشخصه به‌طور کامل برداشته می‌شود و خطا ایجاد می‌کند.

AttributeValueMetadata

فراداده برای مقادیر مشخصه پشتیبانی‌شده.

نمایش JSON
{ "value": value, "displayName": string }

فیلدها

value

value (Value format)

مقدار مشخصه.

displayName