特定の顧客に関する情報を見つける必要がある場合は、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 論理演算子を使用できます。 1 つのフィルタで、かっこを使用したステートメントを使用して両方の演算子を使用できます。
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*