Method: attributes.list

Restituisce l'elenco degli attributi che sarebbero disponibili per una sede con la categoria principale e il paese specificati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
parent

string

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

Formato: locations/{locationId} (ad es. locations/1234567890).
categoryName

string

Facoltativo. L'ID stabile della categoria principale per trovare gli attributi disponibili. Deve essere nel formato categories/{category_id} (ad es. categories/gcid:restaurant). Obbligatorio se parent non è impostato e showAll è false.
regionCode

string

Facoltativo. Il codice paese ISO 3166-1 alpha-2 per trovare gli attributi disponibili. Obbligatorio se parent non è impostato.
languageCode

string

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

boolean

Facoltativo. Se impostato su true, vengono restituiti i metadati per tutti gli attributi disponibili, ignorando i campi parent e categoryName. languageCode e regionCode sono obbligatori quando 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 della pagina richiesta, 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 saperne di più, consulta la OAuth 2.0 Overview.

AttributeMetadata

Metadati per un attributo. Contiene 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 devono essere di questo tipo.
displayName

string

Il nome visualizzato localizzato dell'attributo, se disponibile; in caso contrario, il nome visualizzato in inglese.
groupDisplayName

string

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

boolean

Se true, l'attributo supporta più valori. Se false, deve essere fornito un solo valore.
valueMetadata[]

object (AttributeValueMetadata)

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

boolean

Se true, l'attributo è deprecato e non deve più essere utilizzato. Se l'attributo è deprecato, l'aggiornamento non genererà un errore, ma gli aggiornamenti non verranno salvati. A un certo punto, dopo essere stato ritirato, 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 per questo valore, localizzato se disponibile, altrimenti in inglese. Il nome visualizzato del valore deve essere utilizzato nel contesto del nome visualizzato dell'attributo.

Ad esempio, per un attributo enum "Wi-Fi", potrebbe contenere "A pagamento" per rappresentare il Wi-Fi a pagamento.