使用 ListCustomers API 設定顧客篩選器

如要查詢特定客戶的相關資訊,您可以透過 customers.list 方法使用 Cloud Channel API filter 參數。

如果您使用篩選器,在建立客戶時,系統會稍微延遲 (通常為幾秒)。如果您需要在建立後立即存取客戶,建議您使用 customers.list 而非篩選器或 customers.get

可用的篩選器

篩選器參數的字串支援完全比對,或完全比對加上前置字元篩選。篩選器不會區分大小寫。

下表說明可搜尋的可用欄位,以及這些欄位支援的方法。

外部搜尋索引鍵 支援完全比對 前置字串支援
網域
org_display_name
cloud_identity_id
channel_partner_id

如需完整的篩選器語法,請參閱 API 篩選指南

完全比對語法

完全比對篩選器只會找出包含與提交字串相同欄位的客戶。

語法: <domain | org_display_name | cloud_identity_id | channel_partner_id> = <value>

範例:domain = "domain.com" AND channel_partner_id = "12345"

前置字串語法

前置符號篩選器可讓您使用星號做為萬用字元符號。這個篩選器會找出含有前置字串的欄位,不論後續內容為何。

語法:<domain | org_display_name> : <value>*

範例:domain : "uw.com*" AND org_display_name : "prefix*"

使用邏輯運算子的篩選器範例

Cloud Channel API 篩選器支援使用 AND 和 OR 邏輯運算子。您可以使用括號陳述式,在單一篩選條件中使用兩個運算子。

AND 範例

domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name : "display*"

OR 範例

domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name : "display*"

AND + OR 範例

domain = "domain.com" OR (channel_partner_id = "12345" AND org_display_name : "display*" )

如果篩選器包含 AND 和 OR 陳述式,就必須使用括號。以下範例不是有效的篩選字串。

domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name : "display*