Přejít na dokumentaci
SDK

Publika

`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` a `removeContact`.

Všechny metody

audiences.ts
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)

Publikum je pojmenovaný seznam kontaktů v tomto pracovním prostoru. Každý kontakt je od okamžiku svého vzniku ve vestavěném výchozím publiku a právě builtin ten řádek označuje; ostatní si vytváříte, plníte a mažete sami. Větvete se podle builtin, ne podle názvu, který může kdokoli změnit.

Tato verze spravuje seznamy a nic jim neodesílá. Žádnou metodu pro hromadné rozesílání nehledejte, a zařazení kontaktu do publika je zápis do publika, ne do kontaktu, takže jediný kontrolovaný scope je audiences:write.

addContact přijímá adresu, která už kontaktem je, a tu, která jím není, odmítne s 422 contact_not_found. Nejdřív ji uložte pomocí openemail.contacts.create. Přidání téhož člověka podruhé odpoví členstvím, které už existuje, i s jeho původním addedAt, takže je volání bezpečné opakovat.

Výchozí publikum lze přejmenovat a popsat jako kterékoli jiné, ale nelze ho smazat ani z něj ubírat. Obojí se odmítá s 409 audience_immutable. Když má odejít kontakt, smažte kontakt.

Odpověď: AudienceResource

list se vyhodnotí na obyčejné pole těchto objektů, s výchozím publikem na začátku a ostatními od nejnovějšího, a get, create i update se vyhodnotí každé na jeden. listContacts se místo toho vyhodnotí na pole ContactResource, tedy na samotné kontakty, ne na záznamy o členství.

idstring
Trvalý identifikátor, `aud_` následované 24 hexadecimálními znaky. Názvy nejsou jedinečné, takže do uložené konfigurace patří tohle.
namestring
Při zápisu se ořezávají okrajové mezery, 1 až 120 znaků. Dvě publika mohou sdílet název, protože publikum se adresuje svým id.
descriptionstring | null
Volný text pro toho, kdo si seznam přečte později. Null, když nikdo žádný nenapsal, a explicitní null při `update` ho vymaže.
builtin'default' | (string & {}) | null
`default` právě u jednoho řádku na pracovní prostor, u publika, které drží všechny kontakty, a null u každého publika, které někdo vytvořil. Sjednocení zůstává otevřené, aby se později přidaná vestavěná hodnota v editoru zúžila, aniž by rozbila publikovaný typ.
contactCountnumber
Kolik kontaktů je v publiku, spočítáno v okamžiku čtení, ne z cache. Dvě čtení po obou stranách `contacts.create` se liší o jedna.
createdAtstring
ISO-8601 UTC, kdy publikum vzniklo. Určuje pořadí v seznamu za tím výchozím.
updatedAtstring
ISO-8601 UTC, posouvá se při přejmenování nebo změně popisu. Změny členství se ho nedotknou.