- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- AttributeMetadata
- AttributeValueMetadata
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 |
Es el nombre del recurso de la ubicación para buscar atributos disponibles. Si se establece este campo, los campos categoryName, regionCode, languageCode y showAll no son obligatorios ni deben configurarse. |
categoryName |
Es el ID estable de la categoría principal para encontrar atributos disponibles. Debe tener las categorías de formato/{category_id}. |
regionCode |
Es el código de país ISO 3166-1 alpha-2 para encontrar los atributos disponibles. |
languageCode |
Es el código de idioma BCP 47 en el que se deben obtener los nombres visibles de los atributos. Si este idioma no está disponible, se ofrecerán en inglés. |
showAll |
Los metadatos de todos los atributos disponibles se muestran cuando este campo se establece en verdadero, sin tener en cuenta los campos superior y de categoryName. languageCode y regionCode son obligatorios cuando showAll se establece en verdadero. |
pageSize |
La cantidad de atributos que se deben incluir por página. El valor predeterminado es 200 y el mínimo es 1. |
pageToken |
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 ( |
Campos | |
---|---|
attributeMetadata[] |
Es una colección de metadatos de atributos para los atributos disponibles. |
nextPageToken |
Si la cantidad de atributos supera el tamaño de la página solicitado, este campo se propagará con un token para recuperar la siguiente página de atributos en una llamada posterior a |
Permisos 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
Son los metadatos de un atributo. Contiene información de visualización del atributo, como un nombre localizado y un encabezado para agrupar los atributos relacionados.
Representación JSON |
---|
{ "parent": string, "valueType": enum ( |
Campos | |
---|---|
parent |
Es el identificador único del atributo. |
valueType |
Es el tipo de valor del atributo. Se espera que los valores establecidos y recuperados sean de este tipo. |
displayName |
El nombre visible localizado del atributo, si está disponible; de lo contrario, es el nombre visible en inglés. |
groupDisplayName |
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 que se proporciona aquí. |
repeatable |
Si es verdadero, el atributo admite varios valores. Si es falso, se debe proporcionar un solo valor. |
valueMetadata[] |
Para algunos tipos de atributos (por ejemplo, enumeraciones), se proporciona una lista de los valores admitidos y los nombres visibles correspondientes a esos valores. |
deprecated |
Si es verdadero, el atributo deja de estar disponible y no debe usarse más. Si es obsoleto, la actualización de este atributo no generará errores, pero no se guardarán las actualizaciones. Después de que este deje de estar disponible, 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 |
Es el valor del atributo. |
displayName |
Es el nombre visible de este valor, localizado cuando esté disponible; de lo contrario, debe estar en inglés. El nombre visible del valor se diseñó para usarse en contexto con el nombre visible del atributo. Por ejemplo, para un atributo de enumeración "Wi-Fi", podría incluir "Pagado" para representar la red Wi-Fi pagada. |