掲載情報

client.listingsを使用して、プレミアム掲載情報、音声向け掲載情報、ディレクトリ内の重複掲載情報を管理します。

掲載情報に関するすべてのメソッドは client.listings 配下にあります。location_id を受け取るメソッドでは、数値または base64 エンコードされた ID を使用できます。拠点 IDを参照してください。


listings.premium

拠点のプレミアムディレクトリ(Google、Yelp、Facebook など)の掲載情報を取得します。

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}")

syncStatus の一般的な値: SYNCED、PENDING、NOT_SYNCED、ERROR。


listings.voice

音声アシスタント(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

1 つの拠点の重複した掲載情報を取得します。

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

すべての拠点の重複した掲載情報を取得します。任意でタグによる絞り込みができます。

Python
client.listings.all_duplicates(    *,    tag: str | None = None,    page: int | None = None,) -> APIObject
パラメータ型説明
tagstr集計対象を 1 つのタグに絞り込みます。省略すると、キーで参照できるすべての拠点が対象になります。
pageint1 から始まるページ番号です。
Python
rollup = client.listings.all_duplicates(page=1)print(rollup.to_dict()) # Scope to one tagrollup = client.listings.all_duplicates(tag="northeast", page=1)

どちらの引数も必須ではありません。省略するとデフォルト値の status: POTENTIAL と tag: all が使用されるため、引数なしで呼び出すと、アカウント内の未解決の重複候補が返されます。ペイロードはオフセット方式のページで、records[] に加えて、totalRecords / totalPages を含む pageInfo で構成されます。


listings.mark_duplicate

拠点の掲載情報の項目を重複としてマークします。

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

掲載情報の項目の重複ステータスを解除します。

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

接続済みアカウントの掲載情報を拠点に関連付けます。

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

拠点と Google または Facebook の掲載情報との接続を解除します。

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

site は大文字と小文字を区別しません。SDK は送信前に大文字に変換します。

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

listings.create_gmb

Listings API の既存の拠点に対して、Google Business Profile の掲載情報を作成します。

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",)

関連項目