REST Resource: attributes

    • AttributeMetadataprovides display information for attributes, such as localized names and grouping headings, including details like value type, whether it's repeatable, and supported values.

    • AttributeValueMetadataoffers metadata for supported attribute values, including the value itself and its localized display name, meant to be used in conjunction with the attribute display name.

    • The attributes resource allows you to list available attributes based on a location's primary category and country using the list method.

    Resource: AttributeMetadata

    Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.

    JSON representation 
     { 
 "attributeId" 
 : 
 string 
 , 
 "valueType" 
 : 
 enum (  AttributeValueType 
 
) 
 , 
 "displayName" 
 : 
 string 
 , 
 "groupDisplayName" 
 : 
 string 
 , 
 "isRepeatable" 
 : 
 boolean 
 , 
 "valueMetadata" 
 : 
 [ 
 { 
 object (  AttributeValueMetadata 
 
) 
 } 
 ] 
 , 
 "isDeprecated" 
 : 
 boolean 
 }
    Fields
    attributeId

    string

    The ID of the attribute.
    valueType

    enum ( AttributeValueType )

    The value type for the attribute. Values set and retrieved should be expected to be of this type.
    displayName

    string

    The localized display name for the attribute, if available; otherwise, the English display name.
    groupDisplayName

    string

    The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.
    isRepeatable

    boolean

    If true, the attribute supports multiple values. If false, only a single value should be provided.
    valueMetadata[]

    object ( AttributeValueMetadata )

    For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.
    isDeprecated

    boolean

    If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.

    AttributeValueMetadata

    Metadata for supported attribute values.

    JSON representation 
     { 
 "value" 
 : 
 value 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    value

    value ( Value format)

    The attribute value.
    displayName

    string

    The display name for this value, localized where available; otherwise, in English. The value display name is intended to be used in context with the attribute display name.

    For example, for a "WiFi" enum attribute, this could contain "Paid" to represent paid Wi-Fi.

    Methods

    list

    		Returns the list of available attributes that would be available for a location with the given primary category and country.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: