Grupy odbiorców
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` i `removeContact`.
Wszystkie metody
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)Grupa odbiorców to nazwana lista kontaktów w tej przestrzeni roboczej. Każdy kontakt należy do wbudowanej domyślnej grupy od chwili swojego istnienia, a builtin jest tym, co nazywa ten wiersz; resztę tworzysz, wypełniasz i usuwasz sam. Rozgałęziaj się na builtin, a nie na nazwie, którą każdy może zmienić.
Ta wersja zarządza listami i niczego do nich nie wysyła. Nie ma metody wysyłki masowej, której warto by szukać, a umieszczenie kontaktu w grupie odbiorców jest zapisem do grupy, a nie do kontaktu, więc audiences:write to jedyny sprawdzany zakres.
addContact przyjmuje adres, który jest już kontaktem, i odrzuca taki, który nim nie jest, z 422 contact_not_found. Zapisz go najpierw przez openemail.contacts.create. Dodanie kogoś dwa razy odpowiada członkostwem, które już istnieje, wraz z jego pierwotnym addedAt, więc wywołanie można bezpiecznie ponowić.
Domyślnej grupie odbiorców można zmienić nazwę i opis jak każdej innej, ale nie można jej usunąć ani przerzedzić. Oba są odrzucane z 409 audience_immutable. Usuń kontakt, gdy chodzi Ci o usunięcie kontaktu.
Odpowiedź: AudienceResource
list rozwiązuje się do zwykłej tablicy takich obiektów, z domyślną grupą odbiorców na początku i resztą od najnowszej, a get, create i update rozwiązują się każde do jednego. listContacts rozwiązuje się zamiast tego do tablicy ContactResource, czyli do samych kontaktów, a nie do rekordów członkostwa.
idstring- Trwały uchwyt: `aud_` i 24 znaki szesnastkowe. Nazwy nie są unikalne, więc to właśnie ta wartość należy do zapisanej konfiguracji.
namestring- Przycinane przy zapisie, od 1 do 120 znaków. Dwie grupy odbiorców mogą mieć tę samą nazwę, bo grupę adresuje się jej identyfikatorem.
descriptionstring | null- Dowolny tekst dla tego, kto później przeczyta listę. Null, gdy nikt nic nie napisał; jawny null w `update` go czyści.
builtin'default' | (string & {}) | null- `default` na dokładnie jednym wierszu w przestrzeni roboczej, tej grupie, która trzyma każdy kontakt, i null na każdej grupie utworzonej przez kogoś. Unia pozostaje otwarta, żeby wbudowana wartość dodana później zawężała się w edytorze, nie psując opublikowanego typu.
contactCountnumber- Ile kontaktów jest w grupie, policzone w momencie odczytu, a nie z pamięci podręcznej. Dwa odczyty po obu stronach `contacts.create` różnią się o jeden.
createdAtstring- ISO-8601 UTC, kiedy grupę utworzono. Ustala kolejność listy po domyślnej grupie.
updatedAtstring- ISO-8601 UTC, podbijane przez zmianę nazwy lub opisu. Zmiany członkostwa go nie dotykają.