Célközönségek
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` és `removeContact`.
Az összes metódus
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)A célközönség a munkaterületen lévő névjegyek elnevezett listája. Minden névjegy a létezése pillanatától benne van a beépített alapértelmezett célközönségben, és ezt a sort a builtin nevezi meg; a többit te hozod létre, töltöd fel és törlöd. A builtin mezőre ágazz el, ne a névre, amelyet bárki megváltoztathat.
Ez a verzió listákat kezel, és semmit nem küld nekik. Nincs olyan broadcast metódus, amelyet keresni lehetne, és egy névjegy célközönségbe tétele a célközönség írása, nem a névjegyé, így az audiences:write az egyetlen ellenőrzött hatókör.
Az addContact olyan címet vár, amely már névjegy, és elutasítja azt, amelyik nem, 422 contact_not_found hibával. Előbb mentsd el az openemail.contacts.create hívással. Ha valakit kétszer adsz hozzá, a válasz a már meglévő tagság lesz az eredeti addedAt értékével, így a hívás nyugodtan újrapróbálható.
Az alapértelmezett célközönség ugyanúgy átnevezhető és leírható, mint bármelyik másik, de nem törölhető, és nem lehet belőle tagokat kivenni. Mindkettőt 409 audience_immutable hibával utasítjuk el. Ha azt akarod, hogy a névjegy eltűnjön, a névjegyet töröld.
Válasz: AudienceResource
A list ezek sima tömbjével tér vissza, elöl az alapértelmezett célközönséggel, utána a többivel a legújabbtól kezdve, a get, a create és az update pedig egyetlen ilyennel. A listContacts ehelyett ContactResource elemek tömbjével tér vissza: magukkal a névjegyekkel, nem tagsági rekordokkal.
idstring- Az állandó azonosító, `aud_` és utána 24 hexadecimális karakter. A nevek nem egyediek, így a tárolt konfigurációba ez való.
namestring- Íráskor levágjuk a szóközöket, 1–120 karakter. Két célközönség viselheti ugyanazt a nevet, mert a célközönséget az azonosítója címzi.
descriptionstring | null- Szabad szöveg annak, aki később elolvassa a listát. Null, ha senki nem írt ilyet, és az `update` hívásban megadott explicit null törli.
builtin'default' | (string & {}) | null- Munkaterületenként pontosan egy soron `default`, azon a célközönségen, amely minden névjegyet tartalmaz, és null minden olyanon, amelyet valaki létrehozott. Az unió nyitva marad, hogy egy később hozzáadott beépített érték egy szerkesztőben szűkíthető legyen anélkül, hogy a publikált típus elromlana.
contactCountnumber- Hány névjegy van a célközönségben, az olvasás pillanatában megszámolva, nem gyorsítótárazva. Egy `contacts.create` két oldalán végzett olvasás eggyel eltér egymástól.
createdAtstring- ISO-8601 UTC, a célközönség létrehozásának ideje. Az alapértelmezett után ez rögzíti a lista sorrendjét.
updatedAtstring- ISO-8601 UTC, amelyet az átnevezés vagy a leírás módosítása frissít. A tagság változása nem érinti.