オーディエンス
`audiences.list`、`get`、`create`、`update`、`delete`、`listContacts`、`addContact`、`removeContact`。
すべてのメソッド
const audiences = await openemail.audiences.list()const everyone = audiences.find((audience) => audience.builtin === 'default') const list = await openemail.audiences.create({ name: 'Product updates', description: 'Customers who asked to hear about releases',}) await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper' })await openemail.audiences.addContact(list.id, { email: '[email protected]' }) const members = await openemail.audiences.listContacts(list.id, { limit: 200 }) await openemail.audiences.update(list.id, { name: 'Release notes' })await openemail.audiences.removeContact(list.id, '[email protected]')await openemail.audiences.delete(list.id) console.log(everyone?.contactCount, members.length)オーディエンスとは、このワークスペース内の連絡先に名前を付けたリストです。すべての連絡先は、存在した瞬間から組み込みの既定オーディエンスに含まれ、その行を指すのが builtin です。それ以外は、あなたが作り、埋め、削除するものです。誰でも変更できる名前ではなく、builtin で分岐してください。
このバージョンはリストを管理するだけで、そこへ何も送信しません。探しても配信メソッドはありませんし、連絡先をオーディエンスに入れることは連絡先ではなくオーディエンスへの書き込みなので、確認されるスコープは audiences:write だけです。
addContact はすでに連絡先になっているアドレスを受け取り、そうでないものは 422 contact_not_found で拒否します。先に openemail.contacts.create で保存してください。同じ相手を二度追加すると、すでに存在するメンバーシップが元の addedAt とともに返るので、この呼び出しは安全に再試行できます。
既定オーディエンスも他と同じように名前と説明を変更できますが、削除することも中身を減らすこともできません。どちらも 409 audience_immutable で拒否されます。連絡先そのものを消したいときは、連絡先を削除してください。
レスポンス: AudienceResource
list はこれらのプレーンな配列に解決され、既定オーディエンスが先頭、残りは新しい順です。get、create、update はそれぞれ 1 件に解決されます。listContacts は代わりに ContactResource の配列に解決され、メンバーシップの記録ではなく連絡先そのものを返します。
idstring- 永続的なハンドル。`aud_` に続く 24 文字の 16 進数です。名前は一意ではないので、設定に保存すべきなのはこちらです。
namestring- 書き込み時にトリムされ、1〜120 文字です。オーディエンスは id で指定されるため、2 つのオーディエンスが同じ名前を持っても構いません。
descriptionstring | null- 後でこのリストを読む人のための自由記述です。誰も書いていなければ null で、`update` で明示的に null を渡すとクリアされます。
builtin'default' | (string & {}) | null- ワークスペースごとにちょうど 1 行だけが `default` で、それがすべての連絡先を保持するオーディエンスです。誰かが作成したオーディエンスでは null になります。ユニオンは開いたままにしてあるので、後から組み込みが追加されてもエディター上で候補が絞られるだけで、公開された型は壊れません。
contactCountnumber- そのオーディエンスに何件の連絡先があるか。キャッシュではなく読み取りの瞬間に数えます。`contacts.create` を挟んだ 2 回の読み取りは 1 件ずれます。
createdAtstring- ISO-8601 の UTC で、オーディエンスが作られた時刻です。既定オーディエンス以降の並び順を決めます。
updatedAtstring- ISO-8601 の UTC で、名前や説明の変更で更新されます。メンバーシップの変更では動きません。