Kitleler
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` ve `removeContact`.
Tüm metotlar
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)Kitle, bu çalışma alanındaki kişilerden oluşan adlandırılmış bir listedir. Her kişi var olduğu andan itibaren yerleşik varsayılan kitlenin içindedir ve o satırı adlandıran şey builtin alanıdır; geri kalanları oluşturmak, doldurmak ve silmek size kalmıştır. Herkesin değiştirebildiği ada göre değil, builtin alanına göre dallanın.
Bu sürüm listeleri yönetir, onlara hiçbir şey göndermez. Aranacak bir toplu gönderim metodu yoktur ve bir kişiyi kitleye eklemek, kişiye değil kitleye yazmak demektir; bu yüzden denetlenen tek kapsam audiences:write'tır.
addContact, halihazırda kişi olan bir adresi alır, olmayanı 422 contact_not_found ile reddeder. Önce openemail.contacts.create ile kaydedin. Birini iki kez eklemek, özgün addedAt değerini taşıyan mevcut üyelik kaydıyla yanıtlanır; dolayısıyla çağrıyı yeniden denemek güvenlidir.
Varsayılan kitle diğerleri gibi yeniden adlandırılabilir ve açıklanabilir, ama silinemez ve içi boşaltılamaz. İkisi de 409 audience_immutable ile reddedilir. Kişinin gitmesini istiyorsanız kişiyi silin.
Yanıt: AudienceResource
list bunlardan oluşan düz bir dizi döndürür; önce varsayılan kitle, ardından en yeniden eskiye diğerleri. get, create ve update ise tek bir tanesini döndürür. listContacts bunun yerine bir ContactResource dizisi döndürür: üyelik kayıtları değil, kişilerin kendisi.
idstring- Kalıcı tanıtıcı: `aud_` ve ardından 24 onaltılık karakter. Adlar benzersiz değildir, bu yüzden saklanan yapılandırmaya girmesi gereken değer budur.
namestring- Yazarken kırpılır, 1 ila 120 karakter. İki kitle aynı adı taşıyabilir, çünkü bir kitleye id'siyle erişilir.
descriptionstring | null- Listeyi sonradan okuyacak kişi için serbest metin. Kimse yazmadıysa null olur; `update` çağrısında açıkça null göndermek bu alanı temizler.
builtin'default' | (string & {}) | null- Çalışma alanı başına tam olarak bir satırda `default` olur; bu, her kişiyi barındıran kitledir. Birinin oluşturduğu her kitlede null'dır. Birleşim tipi açık bırakılmıştır; böylece sonradan eklenen bir yerleşik değer, yayımlanmış tipi bozmadan editörde daraltılabilir.
contactCountnumber- Kitledeki kişi sayısı; önbelleğe alınmak yerine okuma anında sayılır. Bir `contacts.create` çağrısının iki yanındaki iki okuma bir fark gösterir.
createdAtstring- ISO-8601 UTC; kitlenin ne zaman oluşturulduğu. Varsayılan kitleden sonraki liste sırasını belirler.
updatedAtstring- ISO-8601 UTC; yeniden adlandırma veya açıklama değişikliğinde güncellenir. Üyelik değişiklikleri bu alana dokunmaz.