Method: attributes.list

Muestra la lista de atributos que estarían disponibles para una ubicación con la categoría principal y el país indicados.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
parent

string

Opcional. Es el nombre del recurso de la ubicación para buscar los atributos disponibles. Si se establece este campo, categoryName, regionCode, languageCode y showAll no son obligatorios y no se deben establecer.

Formato: locations/{locationId} (p.ej., locations/1234567890).
categoryName

string

Opcional. Es el ID estable de la categoría principal para encontrar los atributos disponibles. Debe tener el formato categories/{category_id} (p.ej., categories/gcid:restaurant). Es obligatorio si no se establece parent y showAll es falso.
regionCode

string

Opcional. Es el código de país ISO 3166-1 alfa-2 para encontrar los atributos disponibles. Es obligatorio si no se configura parent.
languageCode

string

Opcional. Es el código BCP 47 del idioma en el que se obtendrán los nombres visibles de los atributos. Si este idioma no está disponible, se proporcionarán en inglés.
showAll

boolean

Opcional. Si se establece como verdadero, se devuelven los metadatos de todos los atributos disponibles, sin tener en cuenta los campos parent y categoryName. languageCode y regionCode son obligatorios cuando showAll se establece como verdadero.
pageSize

integer

Es la cantidad de atributos que se incluirán por página. El valor predeterminado es 200 y el mínimo es 1.
pageToken

string

Si se especifica, se recupera la siguiente página de metadatos de atributos.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta para AttributesService.ListAttributeMetadata.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Campos
attributeMetadata[]

object (AttributeMetadata)

Es una colección de metadatos de atributos para los atributos disponibles.
nextPageToken

string

Si la cantidad de atributos supera el tamaño de página solicitado, este campo se completará con un token para recuperar la siguiente página de atributos en una llamada posterior a attributes.list. Si no hay más atributos, este campo no estará presente en la respuesta.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

AttributeMetadata

Son los metadatos de un atributo. Contiene información de visualización del atributo, incluido un nombre localizado y un encabezado para agrupar los atributos relacionados.

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

string

Es el identificador único del atributo.
valueType

enum (AttributeValueType)

Es el tipo de valor del atributo. Se espera que los valores establecidos y recuperados sean de este tipo.
displayName

string

Es el nombre visible localizado del atributo, si está disponible; de lo contrario, es el nombre visible en inglés.
groupDisplayName

string

Es el nombre visible localizado del grupo que contiene este atributo, si está disponible. De lo contrario, es el nombre del grupo en inglés. Los atributos relacionados se recopilan en un grupo y se deben mostrar juntos bajo el encabezado que se indica aquí.
repeatable

boolean

Si es verdadero, el atributo admite varios valores. Si es falso, solo se debe proporcionar un valor.
valueMetadata[]

object (AttributeValueMetadata)

En el caso de algunos tipos de atributos (por ejemplo, enumeraciones), se proporciona una lista de valores admitidos y los nombres visibles correspondientes para esos valores.
deprecated

boolean

Si es verdadero, el atributo está obsoleto y ya no se debe usar. Si se descontinúa, la actualización de este atributo no generará un error, pero no se guardarán las actualizaciones. En algún momento después de que se deje de usar, el atributo se quitará por completo y se convertirá en un error.

AttributeValueMetadata

Metadatos de los valores de atributos admitidos.

Representación JSON 
{
  "value": value,
  "displayName": string
}
Campos
value

value (Value format)

Es el valor del atributo.
displayName

string

Es el nombre visible de este valor, localizado cuando está disponible; de lo contrario, en inglés. El nombre visible del valor se debe usar en contexto con el nombre visible del atributo.

Por ejemplo, para un atributo de tipo enum "WiFi", este podría contener "Paid" para representar el Wi-Fi pagado.