Socialプランの上限と使用量を取得する

Socialプランで利用できる容量と、その使用量を示します。接続リンクを発行する前にこの情報を取得すると、書き込みの失敗によるSY95042を表示する代わりに、空き容量がないことを顧客に伝えられます。

usage.connectionsはusage.connectionsActive + usage.connectionsReleasedと完全に一致します。

解除済みのスロットは期間終了まで確保されます

チャネルを切断すると即座にオフラインになりますが、スロットは返却されません。請求期間中は、現在も接続されているかどうかにかかわらず、使用した重複のない接続数に対して上限が適用されるため、サブスクリプションが更新されるまでスロットは使用済みのままです。実装で考慮すべき影響は次の3つです。

• 空き容量はmaxConnections - usage.connectionsであり、maxConnections - usage.connectionsActiveではありません。 アクティブな接続数を使うと、実際には空きがないのに空きがあると顧客に伝えることになり、次の接続リンクではSY95042が返されます。
• 同じアカウントを同じブランドに再リンクしても追加の容量は消費しません。 顧客が同じ期間内にそのブランドから切断したページを再接続すると、すでに確保されているスロットが再利用され、connectionsActiveが増加し、connectionsReleasedが減少し、connectionsは変わりません。同じページを別のブランドに関連付けると別のスロットが使われ、元のスロットは更新時まで確保されたままです。
• connectionsReleasedは更新時の見通しを示します。 この値は次の請求サイクルに入るとプールに戻るスロット数そのものであり、更新を待つか今すぐパックを購入するかを判断する顧客に示すべき情報です。

これは課金モデルの他の部分と同じ仕組みで、購入した容量はすぐに利用可能になり、手放した容量は請求サイクルの終了時に利用できなくなります。プランとアドオンを参照してください。

ユースケース：オンボーディングフローでの事前確認。 顧客に「アカウントを接続」ボタンを表示する前に、connectionsActiveではなく課金対象の接続数であるusage.connectionsをmaxConnectionsと比較してください。空き容量がない場合は、POST /social/brands/{brandId}/connections/linkを失敗させる代わりに、アドオンの購入やアップグレードの方法を案内してください。ブランドに対する同様の確認はありません。POST /social/brandsでブランドを作成する際に、空き容量がなくなることはありません。

ユースケース：次に購入するアドオンの数量の算出。 接続パックは5接続単位で販売されるため、maxConnections - usage.connectionsはあといくつのネットワークに接続できるかを直接示し、ceil((needed - headroom) / 5)は購入すべきパック数を示します。

注記。

• ブランド数は無制限で、使用量に応じた課金もありません。 listingsAPIアカウントでは、brandsはnullとして返されます。この値を整数の上限として扱っていたクライアントコードでは、nullを処理できるようにする必要があり、「残り0ブランド」と表示すべきではありません。
• 接続はアカウント全体で共有するプールであり、ブランドごとの割り当てではありません。 プールに空きがある限り、1つのブランドには、そのブランドがサポートする5つのネットワークを上限として、必要な数の接続を保持できます。プランとアドオンを参照してください。
• このエンドポイントの対象はSocialサブスクリプションのみです。拠点数の上限はListingsサブスクリプションに属し、POST /locationsで個別に適用されます。アカウントにListingsプランがまったくない場合、このエンドポイントはSY10155を返します。
• セルフサービスのアカウントでは、購入したパック数にかかわらず、接続数の上限は250です。それを超える場合は、アカウントをEnterpriseに移行する必要があります。
• 空き容量があっても、Instagramに接続できるとは限りません。 Instagramで接続できるのはFacebook PageにリンクされたBusinessアカウントまたはCreatorアカウントのみです。個人アカウントは、この上限によってではなく、Metaの同意画面で拒否されます。ここで空き容量があるにもかかわらずInstagramの接続リンクが失敗する場合は、容量を増やすのではなく、アカウントの種類を変更する必要があります。
• 数値は最新の状態を反映しますが、解除しても返金はされません。 disconnectによる切断、またはブランドのアーカイブは、次回の取得時に、usage.connectionsActiveの減少と、それと同じ数のusage.connectionsReleasedの増加としてここに反映されます。期間終了までスロットが確保されるため、usage.connectionsは変わりません。どちらの解除方法でも動作は同じです。