アクセスできるアカウントをフィルタする

Merchant Accounts API を使用すると、フィルタリングされたアカウントのリストを表示できます。 サブアカウントも含まれます。表示名でフィルタできます。 関連付けます。 たとえば、表示名に「 文字列 "store"(同じく PENDING リンク ステータス) アカウントのリンク リクエストをまだ承認していないショップ。

すべてのサブアカウントを表示するには、呼び出します。 accounts.v1beta.accounts.listSubAccounts

以下を含む、アクセス可能なすべてのアカウントをフィルタしたリストを表示するには、 サブアカウントと、ご自身が User、呼び出し accounts.v1beta.accounts.list [filter] フィールドにフィルタ条件を指定します。

filter フィールドの構文の詳細については、フィルタ構文をご覧ください。 リファレンスをご覧ください。

使用できるフィルタの種類は次のとおりです。

アカウント フィルタ

次のフィールドを使用して、account レベルでフィルタリングできます。

  • accountName: account リソースの accountName でフィルタします。
  • relationship(...): アカウントの関係のタイプでフィルタします。 別のアカウントで使用します。複数の relationship(...) フィルタを含めることができます。 1 つのリクエストで出力できます

関係フィルタ

relationship(...) 関数を使用すると、以下に基づいてフィルタできます。 条件:

  • providerId: サービス プロバイダの販売者 ID。たとえば、 フィルタでは、サービス アカウントによって account/123providerId = 123 を使用します。
  • callerHasAccessToProviderFilter(): サービス プロバイダとの間に契約を結ぶ必要があります。
  • externalAccountId: サービス プロバイダの外部アカウント ID。 割り当てることができます。
  • accountIdAlias:: リクエストに設定されているアカウント ID のエイリアス あります。
  • service(...): 関係の一部として提供されるサービス。 1 つの relationship(...) に複数の service(...) 関数を含めることができます。 使用します。

サービス フィルタ

service(...) 関数を使用すると、 その関係の状態、その関係のサービスの種類 提供:

  • handshakeState: 2 つのアカウント間のサービス契約の状態。 指定できる値は次のとおりです。 <ph type="x-smartling-placeholder">
      </ph>
    • PENDING
    • APPROVED
  • type:: プロバイダが提供するサービスのタイプ。以下を受け入れます。 values: <ph type="x-smartling-placeholder">
      </ph>
    • ACCOUNT_MANAGEMENT: プロバイダがアカウントを管理します。
    • ACCOUNT_AGGREGATION プロバイダはアカウントのアグリゲータです。

フィルタの例をいくつか示します。

表示名に「store」を含むアカウントをフィルタしますGoogle Cloud で利用できる ID "123":

accountName = "*store*" AND relationship(providerId = 123)

アカウント「123」のすべてのサブアカウントをフィルタします。

relationship(providerId = 123 AND service(type = "ACCOUNT_AGGREGATION"))

アカウント管理サービスが承認されているアカウントをフィルタします。

relationship(service(handshakeState = "APPROVED" AND type = "ACCOUNT_MANAGEMENT"))

特定のエイリアスと ID を持ち、プロバイダにアクセスできるアカウントをフィルタします。 また、このリクエストのプロバイダにアクセスできる必要があります。

relationship(callerHasAccessToProviderFilter() AND externalAccountId = "extAcctId" AND accountIdAlias = "alias")

次のステップ

  • アカウントのフィルタについて詳しくは、フィルタ 構文をご覧ください。