Auditorijas
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` un `removeContact`.
Visas metodes
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)Auditorija ir nosaukts šīs darbvietas kontaktu saraksts. Katrs kontakts no tā rašanās brīža ir iebūvētajā noklusējuma auditorijā, un builtin ir tas, kas šo rindu nosauc; pārējās jūs pats veidojat, pildāt un dzēšat. Zarojiet pēc builtin, nevis pēc nosaukuma, ko jebkurš var mainīt.
Šī versija pārvalda sarakstus un neko tiem nesūta. Nav apraides metodes, ko meklēt, un kontakta ielikšana auditorijā ir rakstīšana auditorijā, nevis kontaktā, tāpēc audiences:write ir vienīgais pārbaudītais tvērums.
addContact pieņem adresi, kas jau ir kontakts, un atsaka tādu, kas nav, ar 422 contact_not_found. Vispirms saglabājiet to ar openemail.contacts.create. Pievienojot kādu divreiz, atbilde ir jau esošā dalība ar tās sākotnējo addedAt, tāpēc izsaukumu ir droši atkārtot.
Noklusējuma auditoriju var pārdēvēt un aprakstīt tāpat kā jebkuru citu, bet to nevar izdzēst un no tās nevar neko izņemt. Abi tiek atteikti ar 409 audience_immutable. Dzēsiet kontaktu, ja jūsu nolūks ir, lai pazustu pats kontakts.
Atbilde: AudienceResource
list atrisinās par vienkāršu šādu objektu masīvu — vispirms noklusējuma auditorija, pārējās jaunākās vispirms —, un get, create un update katra atrisinās par vienu. listContacts tā vietā atrisinās par ContactResource masīvu, proti, pašiem kontaktiem, nevis dalības ierakstiem.
idstring- Noturīgais identifikators, `aud_`, kam seko 24 heksadecimālas rakstzīmes. Nosaukumi nav unikāli, tāpēc saglabātajā konfigurācijā jāglabā tieši šis.
namestring- Rakstot tiek apgriezts, 1 līdz 120 rakstzīmes. Divām auditorijām var būt viens nosaukums, jo auditoriju adresē pēc tās id.
descriptionstring | null- Brīvs teksts tam, kas sarakstu lasīs vēlāk. Null, kad neviens neko nav uzrakstījis, un skaidri norādīts null `update` izsaukumā to notīra.
builtin'default' | (string & {}) | null- `default` tieši vienā rindā katrā darbvietā — auditorijā, kurā ir katrs kontakts —, un null katrā kāda izveidotā auditorijā. Savienība paliek atvērta, lai vēlāk pievienots iebūvētais veids redaktorā sašaurinātu tipu, nesalaužot publicēto tipu.
contactCountnumber- Cik kontaktu ir auditorijā, saskaitīti lasīšanas brīdī, nevis kešoti. Divi lasījumi pirms un pēc `contacts.create` atšķirsies par vienu.
createdAtstring- ISO-8601 UTC, kad auditorija tika izveidota. Nosaka saraksta secību pēc noklusējuma auditorijas.
updatedAtstring- ISO-8601 UTC, atjaunināts pēc pārdēvēšanas vai apraksta maiņas. Dalības izmaiņas to neskar.