Administra atributos

Nota: Los atributos disponibles para las fichas varían según la categoría y el país. Son dinámicos y pueden cambiar en cualquier momento.

Los atributos permiten que las empresas incluyan información adicional, como opciones de accesibilidad y comodidades.

Nota: Para agregar o modificar vínculos de la acción del lugar, usa la API de Place Actions. Para los atributos específicos del alojamiento, usa la API de Lodging.

Enumera los atributos disponibles (metadatos)

Para descubrir qué atributos se admiten para una categoría de empresa y un país, solicita attributes.list. Los atributos son dinámicos y deben recuperarse con frecuencia. Consulta el ejemplo que se muestra en la siguiente sección.

Nota: attributes.list devuelve metadatos que describen los atributos que se pueden aplicar a una ubicación junto con sus opciones admitidas (valueMetadata). No devuelve los valores de los atributos configurados en una ficha específica. Para ver los valores establecidos en una ficha, consulta Obtén atributos para una ficha.

Solicitud

Para enumerar los atributos disponibles de una categoría, un código de región y un código de idioma específicos, haz lo siguiente:

HTTP

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

Para enumerar los atributos disponibles de una ficha en particular con su ID de ubicación, haz lo siguiente:

HTTP

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

Respuesta

La siguiente respuesta parcial devuelve definiciones de atributos con varios valores de AttributeValueType. Ten en cuenta que valueMetadata describe los valores permitidos y sus nombres visibles, no los valores seleccionados de la ubicación.

{
  "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"
      }
    }
  ]
}

Obtén atributos para una ficha

Para recuperar los atributos y valores configurados para una ubicación específica, usa locations.getAttributes.

Atributos administrados por el comercio

Para obtener los atributos según la configuración del comercio, haz lo siguiente:

HTTP

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

La respuesta devuelve los valores reales establecidos para la ubicación:

{
  "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"
      ]
    }
  ]
}

Atributos actualizados por Google (vista en vivo)

Para recuperar los atributos tal como aparecen publicados en la Búsqueda de Google y Maps (que pueden incluir actualizaciones de Google o contenido generado por usuarios), usa locations.attributes.getGoogleUpdated:

HTTP

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

Atributos extendidos con estado de edición (v1alpha)

Para recuperar los atributos proporcionados por el comercio y los atributos orientados al consumidor, junto con las etapas del ciclo de vida de edición por atributo (como EDIT_LIFECYCLE_STAGE_PENDING o EDIT_LIFECYCLE_STAGE_REJECTED), la fuente de edición (SOURCE_API o SOURCE_UI) y los motivos de incumplimiento de política en una sola llamada, usa locations.attributes.getExtended en v1alpha:

HTTP

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

Para ver ejemplos de respuestas completas y detalles sobre cómo interpretar el estado de edición de los atributos y los incumplimientos de política, consulta Verifica el estado de edición de las ubicaciones y los atributos.

Establece atributos para una ficha

Nota: Para agregar una URL del menú a una ficha, primero confirma que la ficha tenga el siguiente atributo admitido: attributes/url_menu con attributes.list y, luego, establece el atributo para la ficha con el siguiente método.

Para establecer atributos con locations.updateAttributes, establece el parámetro attributeMask con los atributos que quieras actualizar.

En el siguiente ejemplo, se establecen los tipos de tarjetas de crédito aceptadas y los atributos de las opciones de entrega para una ficha.

Importante: Solo usa atributos admitidos en attributes.list.

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"
        ]
      }
    }
  ]
}