Method: attributes.list

Restituisce l'elenco di attributi che sarebbero disponibili per una località con il paese e la categoria principali specificati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
parent

string

Nome della risorsa della località per cercare gli attributi disponibili. Se questo campo è impostato, categoriaName, RegionCode, languageCode e showAll non sono obbligatori e non devono essere impostati.
categoryName

string

L'ID stabile della categoria principale per trovare gli attributi disponibili. Deve essere del formato categorie/{category_id}.
regionCode

string

Il codice paese ISO 3166-1 alpha-2 per trovare gli attributi disponibili.
languageCode

string

Il codice della lingua BCP 47 in cui inserire i nomi visualizzati degli attributi. Se questa lingua non è disponibile, verranno fornite in inglese.
showAll

boolean

I metadati per tutti gli attributi disponibili vengono restituiti quando questo campo è impostato su true, senza considerare i campi padre e categoriaNome. languageCode e RegionCode sono obbligatori se showAll è impostato su true.
pageSize

integer

Il numero di attributi da includere per pagina. Il valore predefinito è 200, il minimo è 1.
pageToken

string

Se specificato, viene recuperata la pagina successiva dei metadati degli attributi.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per AttributesService.ListAttributeMetadata.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Campi
attributeMetadata[]

object (AttributeMetadata)

Una raccolta di metadati degli attributi per gli attributi disponibili.
nextPageToken

string

Se il numero di attributi supera le dimensioni di pagina richieste, questo campo verrà compilato con un token per recuperare la pagina successiva di attributi in una chiamata successiva a attributes.list. Se non sono presenti altri attributi, questo campo non sarà presente nella risposta.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.

AttributeMetadata

Metadati relativi a un attributo. Contiene le informazioni di visualizzazione per l'attributo, tra cui un nome localizzato e un'intestazione per raggruppare gli attributi correlati.

Rappresentazione JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Campi
parent

string

L'identificatore univoco dell'attributo.
valueType

enum (AttributeValueType)

Il tipo di valore dell'attributo. I valori impostati e recuperati dovrebbero essere di questo tipo.
displayName

string

Il nome visualizzato localizzato dell'attributo, se disponibile. altrimenti il nome visualizzato in inglese.
groupDisplayName

string

Il nome visualizzato localizzato del gruppo che contiene questo attributo, se disponibile. altrimenti il nome del gruppo in inglese. Gli attributi correlati vengono raccolti in un gruppo e devono essere visualizzati insieme sotto l'intestazione qui fornita.
repeatable

boolean

Se true, l'attributo supporta più valori. Se false, è necessario fornire un solo valore.
valueMetadata[]

object (AttributeValueMetadata)

Per alcuni tipi di attributi (ad esempio le enum), viene fornito un elenco di valori supportati e dei relativi nomi visualizzati.
deprecated

boolean

Se impostato su true, l'attributo è obsoleto e non deve più essere utilizzato. Se deprecato, l'aggiornamento di questo attributo non genererà un errore, ma gli aggiornamenti non verranno salvati. A un certo punto, dopo essere stato deprecato, l'attributo verrà rimosso completamente e diventerà un errore.

AttributeValueMetadata

Metadati per i valori degli attributi supportati.

Rappresentazione JSON 
{
  "value": value,
  "displayName": string
}
Campi
value

value (Value format)

Il valore dell'attributo.
displayName

string

Il nome visualizzato di questo valore, localizzato dove disponibile; altrimenti in inglese. Il nome visualizzato del valore deve essere utilizzato nel contesto del nome visualizzato dell'attributo.

Ad esempio, per una connessione "Wi-Fi" attributo enum, potrebbe contenere "Pagato" per rappresentare le reti Wi-Fi a pagamento.