مدیریت مشخصه‌ها

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

فهرست کردن مشخصه‌های دردسترس (فراداده)

برای اینکه بدانید کدام مشخصه‌ها برای دسته کسب‌وکار و کشور پشتیبانی می‌شود، attributes.list را درخواست کنید. مشخصه‌ها پویا هستند و باید مرتباً بازیابی شوند. نمونه نشان‌داده‌شده در بخش زیر را ببینید.

درخواست

برای فهرست کردن مشخصه‌های دردسترس برای دسته، کد منطقه، و کد زبان خاص:

HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes?regionCode=US&languageCode=EN&categoryName=gcid:restaurant

برای فهرست کردن مشخصه‌های دردسترس برای فهرستگانی خاص بااستفاده از شناسه مکان آن:

HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes?parent=locations/{locationId}

پاسخ

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

{
  "attributes": [
    {
      "attributeId": "has_live_music",
      "valueType": "BOOL",
      "displayName": "Live music",
      "groupDisplayName": "Highlights",
      "valueMetadata": [
        {
          "value": true,
          "displayName": "Live music"
        }
      ],
      "displayStrings": {
        "uiText": "Live music",
        "standaloneText": "Has live music",
        "negativeText": "No live music"
      }
    },
    {
      "attributeId": "has_wheelchair_accessible_entrance",
      "valueType": "BOOL",
      "displayName": "Wheelchair accessible entrance",
      "groupDisplayName": "Accessibility",
      "valueMetadata": [
        {
          "value": true,
          "displayName": "Wheelchair accessible entrance"
        },
        {
          "value": false,
          "displayName": "No wheelchair accessible entrance"
        }
      ],
      "displayStrings": {
        "uiText": "Wheelchair accessible entrance",
        "standaloneText": "Has wheelchair accessible entrance",
        "negativeText": "No wheelchair accessible entrance"
      }
    },
    {
      "attributeId": "has_braille_menu",
      "valueType": "BOOL",
      "displayName": "Braille menu",
      "groupDisplayName": "Offerings",
      "valueMetadata": [
        {
          "value": true,
          "displayName": "Braille menu"
        }
      ],
      "displayStrings": {
        "uiText": "Braille menu",
        "standaloneText": "Has braille menu",
        "negativeText": "No braille menu"
      }
    },
    {
      "attributeId": "has_no_contact_delivery",
      "valueType": "BOOL",
      "displayName": "No-contact delivery",
      "groupDisplayName": "Offerings",
      "valueMetadata": [
        {
          "value": true,
          "displayName": "No-contact delivery"
        }
      ],
      "displayStrings": {
        "uiText": "No-contact delivery",
        "standaloneText": "Has no-contact delivery",
        "negativeText": "No no-contact delivery"
      }
    },
    {
      "attributeId": "welcomes_lgbtq",
      "valueType": "BOOL",
      "displayName": "LGBTQ friendly",
      "groupDisplayName": "Planning",
      "valueMetadata": [
        {
          "value": true,
          "displayName": "LGBTQ friendly"
        }
      ],
      "displayStrings": {
        "uiText": "LGBTQ friendly",
        "standaloneText": "LGBTQ friendly",
        "negativeText": "Not showing LGBT friendly"
      }
    },
    {
      "attributeId": "wi_fi",
      "valueType": "ENUM",
      "displayName": "Wi-Fi",
      "groupDisplayName": "Amenities",
      "valueMetadata": [
        {
          "value": "free_wi_fi",
          "displayName": "Free"
        },
        {
          "value": "paid_wi_fi",
          "displayName": "Paid"
        }
      ],
      "displayStrings": {
        "uiText": "Wi-Fi",
        "standaloneText": "Has Wi-Fi",
        "negativeText": "No Wi-Fi"
      }
    },
    {
      "attributeId": "pay_credit_card_types_accepted",
      "valueType": "REPEATED_ENUM",
      "displayName": "Credit cards",
      "groupDisplayName": "Payments",
      "isRepeatable": true,
      "valueMetadata": [
        {
          "value": "american_express",
          "displayName": "American Express"
        },
        {
          "value": "china_union_pay",
          "displayName": "China Union Pay"
        },
        {
          "value": "diners_club",
          "displayName": "Diners Club"
        },
        {
          "value": "discover",
          "displayName": "Discover"
        },
        {
          "value": "jcb",
          "displayName": "JCB"
        },
        {
          "value": "mastercard",
          "displayName": "MasterCard"
        },
        {
          "value": "visa",
          "displayName": "VISA"
        }
      ],
      "displayStrings": {
        "uiText": "Credit cards",
        "standaloneText": "Credit cards accepted",
        "negativeText": "Credit cards not accepted"
      }
    }
  ]
}

دریافت مشخصه‌های فهرستگان

برای بازیابی مشخصه‌ها و مقادیر پیکربندی‌شده برای مکانی خاص، از locations.getAttributes استفاده کنید.

مشخصه‌های مدیریت‌شده توسط فروشنده

برای دریافت مشخصه‌ها به‌صورتی که فروشنده پیکربندی کرده است:

HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}/attributes

پاسخ مقادیر واقعی تنظیم‌شده برای مکان را برمی‌گرداند:

{
  "name": "locations/{locationId}/attributes",
  "attributes": [
    {
      "name": "attributes/has_wheelchair_accessible_seating",
      "valueType": "BOOL",
      "values": [
        false
      ]
    },
    {
      "name": "attributes/wi_fi",
      "valueType": "ENUM",
      "values": [
        "free_wi_fi"
      ]
    }
  ]
}

مشخصه‌های به‌روزرسانی‌شده توسط Google (نمای زنده)

برای بازیابی مشخصه‌ها به‌صورتی که در «جستجوی Google» و Maps به‌طور زنده نشان داده می‌شوند (که ممکن است شامل به‌روزرسانی‌های Google یا محتوای تولیدشده توسط کاربر باشد)، از locations.attributes.getGoogleUpdated استفاده کنید:

HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}/attributes:getGoogleUpdated

مشخصه‌های گسترش‌یافته با وضعیت ویرایش (v1alpha)

برای بازیابی مشخصه‌های ارائه‌شده توسط فروشنده و مشخصه‌هایی که مشتری می‌بیند به‌همراه مراحل چرخه حیات ویرایش هر مشخصه (مثل EDIT_LIFECYCLE_STAGE_PENDING یا EDIT_LIFECYCLE_STAGE_REJECTED)، منبع ویرایش (SOURCE_API یا SOURCE_UI)، و دلایل نقض خط‌مشی در یک فراخوانی، از locations.attributes.getExtended در v1alpha استفاده کنید:

HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}/attributes:getExtended

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

تنظیم مشخصه‌ها برای فهرستگان

برای تنظیم مشخصه‌ها با locations.updateAttributes، پارامتر attributeMask را با مشخصه‌هایی که می‌خواهید به‌روز کنید تنظیم کنید.

مثال زیر انواع کارت اعتباری پذیرفته‌شده و مشخصه‌های گزینه ارسال را برای فهرستگان تنظیم می‌کند.

HTTP
PATCH
https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}/attributes?attributeMask=pay_credit_card_types_accepted,has_no_contact_delivery
{
  "name": "locations/{locationId}/attributes",
  "attributes": [
    {
      "name": "has_no_contact_delivery",
      "values": [ true ]
    },
    {
      "name": "pay_credit_card_types_accepted",
      "repeatedEnumValue": {
        "setValues": [
          "american_express",
          "visa"
        ]
      }
    }
  ]
}