Attributes allow businesses to include additional information, such as accessibility options and amenities.
Listing attributes
To see a list of attributes for a primary category and country, request attributes.list
. Attributes are dynamic and should be retrieved often. See the example shown in the following section.
Request
To list attributes for a particular listing based on a listing's category, region code and language code, refer to the below sample request:
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes?regionCode=US&languageCode=EN&categoryName=gcid:restaurant
To list attributes for a particular listing using its location ID, refer to the below sample request:
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes?parent=locations/{locationId}
Response
The following partial response returns attributes with various AttributeValueType
values.
{ { "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" } } ] }
Set attributes for a listing
To set attributes with
locations.updateAttributes
,
set the attributeMask
parameter with the attributes you want to update.
The following example sets the accepted credit card types and delivery option attributes for a listing.
PATCH https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?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" ] } } ] }