Audiences
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` et `removeContact`.
Toutes les méthodes
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)Une audience est une liste nommée de contacts dans cet espace de travail. Chaque contact appartient à l'audience par défaut intégrée dès l'instant où il existe, et c'est builtin qui désigne cette ligne ; les autres sont à vous de créer, remplir et supprimer. Branchez sur builtin plutôt que sur le nom, que n'importe qui peut changer.
Cette version gère des listes et ne leur envoie rien. Il n'y a pas de méthode de diffusion à chercher, et mettre un contact dans une audience est une écriture sur l'audience et non sur le contact : audiences:write est donc la seule portée vérifiée.
addContact prend une adresse qui est déjà un contact et refuse celle qui ne l'est pas, avec un 422 contact_not_found. Enregistrez-la d'abord avec openemail.contacts.create. Ajouter quelqu'un deux fois renvoie l'appartenance déjà présente, avec son addedAt d'origine : l'appel peut donc être retenté sans risque.
L'audience par défaut peut être renommée et décrite comme une autre, mais elle ne peut être ni supprimée ni allégée. Les deux sont refusés par un 409 audience_immutable. Supprimez le contact quand c'est le contact que vous voulez voir partir.
Réponse : AudienceResource
list se résout en un tableau simple de ces objets, l'audience par défaut d'abord et les autres du plus récent au plus ancien, et get, create et update se résolvent chacun en un seul. listContacts se résout plutôt en un tableau de ContactResource, c'est-à-dire les contacts eux-mêmes plutôt que des enregistrements d'appartenance.
idstring- La référence durable, `aud_` suivi de 24 caractères hexadécimaux. Les noms ne sont pas uniques : c'est donc elle qui a sa place dans une configuration stockée.
namestring- Nettoyé des espaces à l'écriture, de 1 à 120 caractères. Deux audiences peuvent porter le même nom, puisqu'une audience s'adresse par son id.
descriptionstring | null- Texte libre pour qui lira la liste plus tard. Null quand personne n'en a écrit, et un null explicite sur `update` l'efface.
builtin'default' | (string & {}) | null- `default` sur exactement une ligne par espace de travail, l'audience qui contient tous les contacts, et null sur chaque audience créée par quelqu'un. L'union reste ouverte pour qu'une valeur intégrée ajoutée plus tard se restreigne dans un éditeur sans casser le type publié.
contactCountnumber- Combien de contacts compte l'audience, calculé au moment de la lecture plutôt que mis en cache. Deux lectures de part et d'autre d'un `contacts.create` diffèrent de un.
createdAtstring- ISO-8601 UTC, quand l'audience a été créée. Fixe l'ordre de la liste après l'audience par défaut.
updatedAtstring- ISO-8601 UTC, avancé par un renommage ou un changement de description. Les changements d'appartenance n'y touchent pas.