Method: attributes.list

Renvoie la liste des attributs qui seraient disponibles pour un établissement avec la catégorie principale et le pays indiqués.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
parent

string

Facultatif. Nom de ressource de l'établissement pour rechercher les attributs disponibles. Si ce champ est défini, categoryName, regionCode, languageCode et showAll ne sont pas obligatoires et ne doivent pas être définis.

Format : locations/{locationId} (par exemple, locations/1234567890).
categoryName

string

Facultatif. ID stable de la catégorie principale pour trouver les attributs disponibles. Doit être au format categories/{category_id} (par exemple, categories/gcid:restaurant). Obligatoire si parent n'est pas défini et que showAll est défini sur "false".
regionCode

string

Facultatif. Code pays ISO 3166-1 alpha-2 pour trouver les attributs disponibles. Obligatoire si parent n'est pas défini.
languageCode

string

Facultatif. Code de langue BCP 47 pour obtenir les noms à afficher des attributs. Si cette langue n'est pas disponible, ils seront fournis en anglais.
showAll

boolean

Facultatif. Si la valeur est "true", les métadonnées de tous les attributs disponibles sont renvoyées, sans tenir compte des champs parent et categoryName. languageCode et regionCode sont obligatoires lorsque showAll est défini sur "true".
pageSize

integer

Nombre d'attributs à inclure par page. La valeur par défaut est 200, la minimale est 1.
pageToken

string

Si une valeur est spécifiée, la page suivante des métadonnées d'attribut est récupérée.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour AttributesService.ListAttributeMetadata.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Champs
attributeMetadata[]

object (AttributeMetadata)

Ensemble de métadonnées associées aux attributs disponibles.
nextPageToken

string

Si le nombre d'attributs dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant d'extraire la page suivante d'attributs lors d'un prochain appel à attributes.list. S'il n'y a plus d'attributs, ce champ ne sera pas inclus dans la réponse.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

AttributeMetadata

Métadonnées d'un attribut. Contient des informations à afficher pour l'attribut, y compris un nom localisé et un en-tête pour regrouper des attributs associés.

Représentation JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Champs
parent

string

Identifiant unique de l'attribut.
valueType

enum (AttributeValueType)

Type de valeur de l'attribut. Les valeurs définies et récupérées doivent être de ce type.
displayName

string

Nom à afficher localisé de l'attribut, s'il est disponible. Sinon, il s'agit du nom à afficher en anglais.
groupDisplayName

string

Nom à afficher localisé du groupe qui contient cet attribut, s'il est disponible. Sinon, il s'agit du nom à afficher en anglais du groupe. Les attributs associés sont rassemblés dans le groupe et doivent être affichés ensemble sous le titre indiqué ici.
repeatable

boolean

Si la valeur est "true", l'attribut accepte plusieurs valeurs. Si elle est "false", une seule valeur doit être renseignée.
valueMetadata[]

object (AttributeValueMetadata)

Pour certains types d'attributs (par exemple, les énumérations), une liste des valeurs acceptées et des noms à afficher correspondants pour ces valeurs est fournie.
deprecated

boolean

Si la valeur est "true", l'attribut est obsolète et ne doit plus être utilisé. Dans ce cas, mettre à jour cet attribut n'entraînera pas d'erreur, mais les mises à jour ne seront pas enregistrées. Après avoir été marqué comme obsolète, l'attribut sera entièrement supprimé et deviendra une erreur.

AttributeValueMetadata

Métadonnées des valeurs d'attribut acceptées.

Représentation JSON 
{
  "value": value,
  "displayName": string
}
Champs
value

value (Value format)

Valeur de l'attribut.
displayName

string

Nom à afficher pour cette valeur, localisé si possible (sinon, il apparaît en anglais). Le nom à afficher de la valeur est destiné à être utilisé dans le contexte du nom à afficher de l'attribut.

Par exemple, pour un attribut d'énumération "Wi-Fi", il peut contenir "Payant" pour représenter le Wi-Fi payant.