Table des matières
Récupérer toutes les catégories disponibles Récupérer les attributs disponibles Affecter des attributs à un emplacementLes attributs Google Business Profile (GBP) peuvent être ajoutés et modifiés à un établissement via l'interface graphique de la plateforme Uberall. Un établissement doit avoir une catégorie pour que les attributs soient modifiables via une liste déroulante. Lors de la gestion des établissements avec l'API, la gestion des attributs GBP est possible.
*Notez que les attributs sont directement liés à la catégorie principale de l'établissement sélectionné.
Ceci peut être réalisé en trois étapes.
Récupérer les catégories disponibles
La liste complète des catégories Uberall disponibles peut être récupérée avec l'appel d'API suivant. Les catégories Uberall sont liées aux catégories GBP et à d'autres catégories d'annuaires. Cette liste de catégories peut être filtrée en utilisant les paramètres décrits dans la documentation complète des appels d'API . Le paramètre de langue (language) est requis pour réussir un appel d'API.
GET https://uberall.com/api/categories?language=en parameters = { "language": $YOUR_PREFERRED_LANGUAGE } headers = { "privateKey": $API_KEY } reponse = { { "status": "SUCCESS", "response": { "results": [ { "id": 2, "name": "Towing Service", "fullName": "Automotive and Transportation > Transportation Company and Services > Towing Service", "selectable": true, "parent": 4126 }, { "id": 3, "name": "Auto Glass Shop", "fullName": "Automotive and Transportation > Garage, Parts and Accessories > Auto Glass Shop", "selectable": true, "parent": 4127 }, }
Récupérer les attributs disponibles
Une fois que les ID de catégories ont été récupérés avec l'API, ils peuvent être utilisés pour obtenir la liste des attributs Google disponibles par catégorie. Le paramètre de pays (country) est requis pour réussir un appel d'API. Vous pouvez trouver plus d'information dans la documentation complète des appels d'API .
GET https://uberall.com/API/categories/$CATEGORY_ID/attributes?language=en&country=CA parameters = { "country": $COUNTRY } headers = { "privateKey": $API_KEY } response = { "status": "SUCCESS", "response": { "Attributes": [ { "externalId": "url_appointment", "displayName": "Appointment links", "valueType": "URL", "valueMetadata": null }, { "externalId": "is_owned_by_women", "displayName": "Identifies as women-led", "valueType": "BOOL", "valueMetadata": [ { "value": "true", "displayName": "Identifies as women-led" } ] } ] } }
Assigner des attributs à un établissement
Des attributs peuvent être assignés à un nouvel établissement ou un qui existe déjà. Les attributs doivent être disponibles à la catégorie principale associée à l'établissement. Les attributs doivent être définis dans la partie élément Attributes de l'objet location en tant qu'un objet attributeWrapper. L'objet attributeWrapper est défini ici.
Attention
Si l'attribut que vous essayer de mettre-à-jour est un attribut lié aux modes de paiement, vous devez aussi mettre-à-jour le champ paymentOptions en même temps. Si uniquement l'un des champs est mis-à-jour, cette mise-à-jour ne sera pas appliquée.
Compte tenu des données d'attribut récupérées dans les exemples précédents, notre établissement avec catégorie principale Towing Service (ID 2) peut avoir à la fois les attributs url_appointment et is_owned_by_women. Pour associer ces attributs, l'élément Attributes doit être configuré comme suit:
"attributes": [
{
"displayName": "Appointment links",
"externalId": "url_appointment",
"value": "https://yourURLhere.com",
"valueType": "URL",
},
{
"displayName": "Identifies as women-led",
"externalId": "is_owned_by_women",
"value": "true",
"valueType": "BOOL"
}
]
Info
Référez-vous à la documentation de l'API pour savoir comment créer et mettre à jour des établissements pour intégrer les attributs dans le flux de l'API.