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 especificados.

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

Es el nombre del recurso de la ubicación para buscar los atributos disponibles. Si se configura este campo, los parámetros categoryName, regionCode, languageCode y showAll no son obligatorios y no se deben configurar.
categoryName

string

Es el ID estable de la categoría principal para encontrar los atributos disponibles. Debe tener el formato categories/{category_id}.
regionCode

string

Es el código de país ISO 3166-1 alfa-2 para encontrar atributos disponibles.
languageCode

string

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

boolean

Cuando este campo se configura como verdadero, se muestran los metadatos de todos los atributos disponibles, sin tener en cuenta los campos parent y categoryName. languageCode y regionCode son obligatorios cuando showAll está configurado como true.
pageSize

integer

Cantidad de atributos que se deben incluir por página El valor predeterminado es 200 y el mínimo es 1.
pageToken

string

Si se especifica, se recupera la página siguiente 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)

Una colección de metadatos de atributos para los atributos disponibles.
nextPageToken

string

Si la cantidad de atributos superó 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.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

AttributeMetadata

Metadatos de un atributo. Contiene información de visualización para el 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. Los valores establecidos y recuperados deben ser de este tipo.
displayName

string

El nombre visible localizado del atributo, si está disponible. De lo contrario, el nombre visible en inglés.
groupDisplayName

string

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

boolean

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

object (AttributeValueMetadata)

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

boolean

Si es verdadero, el atributo deja de estar disponible y no se debe usar más. Si es obsoleto, actualizar este atributo no generará un error, pero no se guardarán las actualizaciones. Después de que deje de estar disponible, se quitará por completo y se convertirá en un error.

AttributeValueMetadata

Metadatos para valores de atributos admitidos.

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

value (Value format)

Es el valor del atributo.
displayName

string

El nombre visible de este valor, localizado cuando está disponible. de lo contrario, en inglés. El nombre visible del valor está diseñado para usarse en contexto con el nombre visible del atributo.

Por ejemplo, para un router "Wi-Fi" enum, puede incluir el estado "Pagado" para representar la red Wi-Fi pagada.