Listings APIListings API
Se connecter

Fiches

Gérez les fiches premium et vocales ainsi que les doublons dans les annuaires via client.listings.

Toutes les méthodes relatives aux fiches se trouvent sous client.listings. Les méthodes qui prennent un location_id acceptent des identifiants numériques ou encodés en base64, voir Identifiants des établissements.

listings.premium

Récupérez les fiches des annuaires premium (Google, Yelp, Facebook, etc.) pour un établissement.

Python
client.listings.premium(location_id: str | int) -> list[APIObject]
Python
listings = client.listings.premium(16808)for listing in listings:  site = listing.get("site", "N/A")  status = listing.get("syncStatus", "N/A")  print(f"{site}: {status}")

Valeurs courantes de syncStatus : SYNCED, PENDING, NOT_SYNCED, ERROR.

listings.voice

Récupérez les fiches des assistants vocaux (Google Assistant, Alexa, Siri).

Python
client.listings.voice(location_id: str | int) -> list[APIObject]
Python
voice = client.listings.voice(16808)print(f"{len(voice)} voice assistant listings")

listings.duplicates

Récupérez les fiches en doublon pour un seul établissement.

Python
client.listings.duplicates(location_id: str | int) -> list[APIObject]
Python
dupes = client.listings.duplicates(16808)print(f"Found {len(dupes)} duplicate listings")

listings.all_duplicates

Récupérez les fiches en doublon pour tous les établissements, avec un filtre facultatif par étiquette.

Python
client.listings.all_duplicates(    *,    tag: str | None = None,    page: int | None = None,) -> APIObject
ParamètreTypeDescription
tagstrLimitez l’agrégation à une seule étiquette. Omettez ce paramètre pour inclure tous les établissements auxquels la clé donne accès.
pageintNuméro de page commençant à 1.
Python
rollup = client.listings.all_duplicates(page=1)print(rollup.to_dict()) # Scope to one tagrollup = client.listings.all_duplicates(tag="northeast", page=1)

Aucun des deux arguments n’est obligatoire. Lorsque vous les omettez, les valeurs par défaut sont status: POTENTIAL et tag: all, de sorte que l’appel sans arguments renvoie les doublons potentiels non résolus du compte. Les données renvoyées constituent une page obtenue par pagination par décalage : records[] plus pageInfo avec totalRecords / totalPages.

listings.mark_duplicate

Marquez des éléments de fiche comme doublons pour un établissement.

Python
client.listings.mark_duplicate(    location_id: str | int,    listing_item_ids: list[str],) -> APIObject
Python
result = client.listings.mark_duplicate(  location_id=16808,  listing_item_ids=["item-uuid-1", "item-uuid-2"],)print(result.to_dict())

listings.mark_not_duplicate

Supprimez le statut de doublon des éléments de fiche.

Python
client.listings.mark_not_duplicate(    location_id: str | int,    listing_item_ids: list[str],) -> APIObject
Python
client.listings.mark_not_duplicate(16808, ["item-uuid-1"])

listings.connect

Associez un établissement à une fiche provenant d’un compte connecté.

Python
client.listings.connect(    location_id: str | int,    connected_account_listing_id: str,    connected_account_id: str,) -> APIObject
Python
result = client.listings.connect(  location_id=16808,  connected_account_listing_id="ca-listing-uuid",  connected_account_id="ca-uuid",)

listings.disconnect

Dissociez un établissement de sa fiche Google ou Facebook.

Python
client.listings.disconnect(    location_id: str | int,    site: str,) -> APIObject

site ne tient pas compte de la casse ; le SDK convertit cette valeur en majuscules avant l’envoi.

Python
client.listings.disconnect(16808, site="google")client.listings.disconnect(16808, site="facebook")

listings.create_gmb

Créez une fiche Google Business Profile pour un établissement existant dans Listings API.

Python
client.listings.create_gmb(    location_id: str | int,    connected_account_id: str,    *,    folder_id: str | None = None,) -> APIObject
Python
result = client.listings.create_gmb(  location_id=16808,  connected_account_id="ca-uuid",)

Voir aussi