ブランドを作成

ブランド（Social APIの最上位オブジェクト）を作成します。ブランドは、接続したソーシャルアカウントと、それらから公開されたすべての投稿を所有します。少なくとも1つのブランドが存在するまではSocial APIのほかの呼び出しを実行できないため、これはすべてのSocial連携で最初に行うリクエストです。

ユースケース：クライアントがソーシャル投稿を始められるようにする。 顧客が自社プロダクトに登録したら、投稿対象の事業ごとに1つのブランドを作成します。返されたsocialProfile.idを、その事業を表す自社のレコードに紐付けて保存します。これは、POST /social/brands/{brandId}/connections/linkとGET /social/brands/{brandId}/postsのパス内のbrandIdトークンであり、作成するすべての投稿のボディ内のsocialProfileIdフィールドでもあります。その後、投稿先のプラットフォームごとに、ホスト型接続リンクを通じてユーザーに接続手続きを進めてもらいます。

注意事項。

• リクエストボディはinputオブジェクトでラップする必要があります。Social APIのすべての書き込みはこの形式でラップしますが、例外が1つあります。接続リンクはラップしていないボディを受け付けます。
• HTTPステータスではなく、successを確認してください。 profileNameの欠落や不明なtimezone.tzCodeなどによる検証失敗は、HTTP 200として返され、success: falseと、errorに格納された理由が含まれます。successがtrueの場合にのみ、呼び出しが成功したと判断してください。
• 必須なのはprofileNameとtimezoneのみです。 businessIntentとcategoriesのデフォルト値はそれぞれgeneralと空のリストなので、連携先にこれらのフィールドに相当するものがなければ、省略できます。
• timezone.tzCodeは表示用の値ではありません。 scheduleDate + scheduleTimeで予約された投稿の日時は、呼び出し元のタイムゾーンでもUTCでもなく、ブランドのタイムゾーンで解釈されます。後から変更しても、すでに予約されている投稿の日時は変更されません。
• ブランドは常にAPIキーに紐付くアカウントに属します。 別のアカウントにブランドを作成する方法はなく、ボディ内のアカウント識別子はすべて無視されます。
• ブランドIDは通常のUUIDです。 Locationsや拠点のPostsで使用されるBase64のRelay IDではないため、エンコードやデコードをしないでください。同じIDがパス内のbrandIdトークンとボディ内のsocialProfileIdフィールドに使われますが、brandIdは常にURLトークンとしてのみ使われ、ボディのフィールドになることはありません。
• APIプランではブランド数に上限はありません。 ブランド数は無制限で、利用量の計測対象にもならないため、この呼び出しが上限を理由に拒否されることはなく、作成前に残り枠を確認する必要もありません。計測対象は接続であり、1つのネットワーク上の1つのソーシャルアカウントを1つのブランドに紐付けると1接続になります。接続数の段階区分と接続パックの価格についてはプランとアドオンを、接続リンクを通じてユーザーに接続手続きを進めてもらう前に接続の残り枠を確認するにはGET /social/limitsを参照してください。

書き込み操作：実際のアカウントに対しては実行していません。表示されているリクエストとレスポンスは、APIスキーマから構成したものです。