Audiencat
`audiences.list`, `get`, `create`, `update`, `delete`, `empty`, `growth`, `list_contacts`, `add_contact`, `add_contacts`, `import_contacts`, `remove_contact` dhe `remove_contacts`.
Çdo metodë
from openemail import openemail audiences = openemail.audiences.list_all()everyone = next((audience for audience in audiences if audience['builtin'] == 'default'), None) created = openemail.audiences.create({ 'name': 'Product updates', 'description': 'Customers who asked to hear about releases',})audience_id = created['id'] openemail.contacts.create({'email': '[email protected]', 'name': 'Grace Hopper'})openemail.audiences.add_contact(audience_id, {'email': '[email protected]'}) bulk = openemail.audiences.add_contacts(audience_id, { 'emails': ['[email protected]', '[email protected]'],}) imported = openemail.audiences.import_contacts(audience_id, { 'contacts': [{'email': '[email protected]', 'name': 'Katherine Johnson'}],}) members = openemail.audiences.list_all_contacts( audience_id, q='grace', sort='added-newest', limit=200,) growth = openemail.audiences.growth(audience_ids=[audience_id], days=30) openemail.audiences.update(audience_id, {'name': 'Release notes'})openemail.audiences.remove_contact(audience_id, '[email protected]')openemail.audiences.remove_contacts(audience_id, {'emails': ['[email protected]']})openemail.audiences.empty(audience_id)openemail.audiences.delete(audience_id) print(everyone['contactCount'] if everyone else None, bulk['missing'], imported['created'])print(len(members), growth['totals']['added'])Një audiencë është një listë e emërtuar kontaktesh në këtë hapësirë pune. Çdo kontakt është në audiencën e integruar të parazgjedhur që nga çasti që ekziston, dhe builtin është ajo që e emërton atë rresht; të tjerat janë tuajat për t'i krijuar, mbushur dhe fshirë. Degëzoni mbi builtin dhe jo mbi emrin, të cilin mund ta ndryshojë kushdo.
Dërgoni te një ose më shumë audienca me openemail.broadcasts.send, te faqja Broadcasts. Vendosja e një kontakti në një audiencë është shkrim te audienca dhe jo te kontakti, ndaj audiences:write është i vetmi scope që kontrollohet. import_contacts është përjashtimi: krijon kontakte, ndaj kërkon edhe contacts:write.
add_contact merr një adresë që është tashmë kontakt dhe refuzon një që nuk është, me 422 contact_not_found. Ruajeni atë fillimisht me openemail.contacts.create. Shtimi i dikujt dy herë përgjigjet me anëtarësimin që ekziston tashmë, duke mbartur addedAt-in e tij origjinal, prandaj thirrja është e sigurt për t'u riprovuar.
Audienca e parazgjedhur mund të riemërtohet dhe të përshkruhet si çdo tjetër, por nuk mund të fshihet dhe nuk mund të hollohet. Të dyja refuzohen me 409 audience_immutable. Fshini kontaktin kur doni të ikë kontakti.
Përgjigjja: AudienceResource
list kthen një faqe me to, një dict me items, hasMore dhe nextCursor, audiencën e parazgjedhur të parën dhe të tjerat nga më e reja, dhe list_all e iterate përshkojnë të gjitha faqet. get, create dhe update kthejnë secila një. list_contacts kthen në vend të saj një faqe me AudienceContactResource, vetë kontaktet me datën kur hyri secili, në vend të regjistrave të anëtarësimit, me list_all_contacts dhe iterate_contacts pranë saj.
idstr- Identifikuesi i qëndrueshëm, `aud_` i ndjekur nga 24 karaktere hex. Emrat nuk janë unikë, prandaj ky është ai që i përket konfigurimit të ruajtur.
namestr- I pastruar nga hapësirat në shkrim, 1 deri 120 karaktere. Dy audienca mund të ndajnë një emër, sepse një audiencë adresohet me id-në e saj.
descriptionstr | None- Tekst i lirë për këdo që e lexon listën më vonë. `None` kur nuk ka shkruar askush, dhe një `None` i shprehur te `update` e pastron.
builtinAudienceBuiltin | str | None- `default` në saktësisht një rresht për hapësirë pune, audienca që mban çdo kontakt, dhe `None` në çdo audiencë që krijoi dikush. Tipi mbetet i hapur, me `str` pranë literalit, kështu që një audiencë e integruar e shtuar më vonë nuk e prish kodin e tipizuar sipas këtij tipi.
contactCountint- Sa kontakte ka në audiencë, të numëruara në çastin e leximit dhe jo të ruajtura në cache. Dy lexime në të dyja anët e një `contacts.create` ndryshojnë me një.
lastContactAtstr | None- ISO-8601 UTC, kur hyri në këtë audiencë kontakti që hyri së fundi. `None` sa kohë që audienca është bosh.
createdAtstr- ISO-8601 UTC, kur u krijua audienca. Fikson renditjen e listës pas asaj të parazgjedhurës.
updatedAtstr- ISO-8601 UTC, i përditësuar nga një riemërtim ose një ndryshim përshkrimi. Ndryshimet e anëtarësimit nuk e prekin.
Parametrat: audiences.list_contacts
limitint- Sa kontakte për faqe: një numër i plotë nga 1 deri në 200, si parazgjedhje 50.
cursorstr- `nextCursor` i faqes së mëparshme, i dërguar me të njëjtat `q`, `source` dhe `sort`. Një kursor që emërton një kontakt që nuk është në këtë audiencë jep 400 `invalid_cursor`.
qstr- Kërkon në emër dhe në adresë, deri në 200 karaktere. Kur asgjë nuk përputhet saktësisht në faqen e parë, kthehen në vend të kësaj shkrime të afërta, dhe faqet që vijojnë vazhdojnë të kërkojnë në të njëjtën mënyrë.
sourceContactSource- `'manual'` për kontaktet që dikush i ruajti qëllimisht, `'auto'` për ato që regjistroi hartuesi i aplikacionit. Lëreni jashtë për të gjithë në audiencë.
sortAudienceMemberSort- `'last-heard-newest'` (parazgjedhja) dhe `'last-heard-oldest'` ndjekin `lastSeenAt`, dhe kontaktet që nuk janë kontaktuar kurrë dalin të fundit te e para dhe të parat te e dyta. `'added-newest'` dhe `'added-oldest'` ndjekin kur hyri secili kontakt në këtë audiencë, dhe `'name'` shpërfill shkronjat e mëdha e të vogla dhe e rendit një kontakt pa emër sipas adresës së tij.
statusesSequence[AudienceMemberStatus]- `['subscribed']` mban anëtarët që nuk janë çregjistruar dhe `['unsubscribed']` ata që janë çregjistruar. Lëre jashtë, ose përmend të dyja, për të gjithë në audiencë. `AUDIENCE_MEMBER_STATUSES` mban vlerat.
Përgjigjja: AudienceContactResource
list_contacts kthen një Page[AudienceContactResource], dhe list_all_contacts e iterate_contacts përshkojnë të gjitha faqet me të njëjtat opsione. Çdo rresht është një ContactResource, fushat e të cilit janë te faqja Kontaktet, me dy fusha më shumë. Përshkimi i të gjitha faqeve është mënyra për të eksportuar një audiencë.
addedAtstr- ISO-8601 UTC, kur hyri kontakti në këtë audiencë. Heqja e një kontakti dhe shtimi i tij sërish e nis nga e para.
unsubscribedAtstr | None- ISO-8601 UTC, kur kontakti u çregjistrua nga një transmetim drejt kësaj audience, ose `None` sa kohë është i regjistruar. Një kontakt i çregjistruar mbetet në audiencë, dhe transmetimet drejt saj e kapërcejnë. Heqja dhe shtimi sërish e regjistron përsëri.
Shtimi dhe heqja në masë
add_contacts dhe remove_contacts marrin {'emails': [...]}, 1 deri në 200 adresa, dhe ndryshojnë një audiencë me një kërkesë. add_contacts nuk krijon kurrë kontakt: një adresë që nuk është kontakt kthehet te missing, dhe import_contacts është thirrja që i krijon. Të dyja janë të sigurta për t'u përsëritur, prandaj një provë e re pas një skadimi kohe i raporton të njëjtët njerëz si të kryer, në vend që të dështojë.
Shtimi në audiencën e parazgjedhur jep 'added': 0, sepse çdo kontakt është tashmë në të, dhe remove_contacts mbi të refuzohet me 409 audience_immutable. Heqja e dikujt nga një audiencë e lë atë në librin e adresave, në audiencën e parazgjedhur dhe në audiencat e tjera të veta.
audienceIdstr- Audienca që ndryshoi thirrja, në të dy rezultatet.
addedint- Te `AudienceBatchAddResource`: anëtarësimet e reja që bëri kjo thirrje.
unchangedint- Te `AudienceBatchAddResource`: kontaktet që ishin tashmë në audiencë. Për to nuk u shkrua asgjë.
removedint- Te `AudienceBatchRemoveResource`: anëtarësimet që hoqi kjo thirrje.
notInAudiencelist[str]- Te `AudienceBatchRemoveResource`: kontaktet që nuk ishin në audiencë, prandaj atyre nuk u ndodhi asgjë.
missinglist[str]- Te të dyja: adresat që nuk janë kontakte në këtë hapësirë pune, me shkronja të vogla dhe pa përsëritje.
Importimi
import_contacts është importi CSV i faqes së audiencës. Merr {'contacts': [...]}, nga 1 deri në 500 rreshta, secili me një email dhe një name opsional: çdo adresë e formuar mirë bëhet kontakt nëse ende nuk është, dhe secila përfundon në audiencë. Dërgojeni një listë më të gjatë në disa thirrje. Kërkon audiences:write dhe contacts:write.
Një adresë që është tashmë kontakt ripërdoret dhe e mban emrin e vet, dhe një name këtu mbush vetëm një emër bosh. Një kontakt i ri ruhet si manual dhe hyn edhe në audiencën e parazgjedhur, dhe një adresë që u fshi nga libri kthehet. Përsëritja e të njëjtave rreshta nuk krijon asgjë dy herë.
audienceIdstr- Audienca ku shkuan rreshtat.
createdint- Kontaktet e reja që ruajti kjo thirrje.
addedint- Anëtarësimet e reja në këtë audiencë, duke numëruar kontaktet që ekzistonin tashmë dhe ende nuk ishin në të.
skippedint- Rreshtat që nuk u importuan sepse adresa ishte e formuar keq.
invalidlist[str]- Adresat e formuara keq, saktësisht siç u dërguan.
Zbrazja
empty(id) heq çdo kontakt nga një audiencë me një kërkesë dhe kthen një EmptiedAudienceResource: audiencën siç është tani, me contactCount 0, plus removed, numrin e anëtarësimeve të hequra. Audienca mban id-në, emrin dhe përshkrimin e saj, dhe çdo kontakt mbetet në librin e adresave dhe në audiencat e tjera të veta.
Nuk mund të zhbëhet dhe asgjë nuk regjistron kush ishte në listë, prandaj përshkoni fillimisht list_all_contacts nëse mund ta doni përsëri. Audienca e parazgjedhur nuk mund të zbrazet, dhe thirrja refuzohet me 409 audience_immutable.
Rritja
growth() lexon sa kontakte hynë në secilën audiencë gjatë një periudhe që mbaron tani, sipas ditës, orës ose minutës, që është grafiku në faqen e audiencave. Kërkon audiences:read dhe kthen një AudienceGrowthResource.
Një audiencë regjistron kur hyri dikush dhe kurrë kur doli, prandaj çdo shifër hyrjesh numëron njerëzit që janë ende sot në listë, sipas datës kur hynë, dhe një vijë nuk bie kurrë. Një kontakt që hyri dhe më vonë doli nuk është në asnjë nga shifrat.
Parametrat
audience_idsSequence[str]- Deri në 50 id audiencash, të dërguara të bashkuara me presje. Lëreni jashtë për të gjitha audiencat. Një id që nuk është audiencë në këtë hapësirë pune jep 404 `audience_not_found`.
daysint- Sa larg pas shkon periudha, 1 deri në 1095. Është 30 kur nuk jepet as `days` as `minutes`.
minutesint- Periudha në minuta, 1 deri në 1576800, për një periudhë më të shkurtër se një ditë. Ka përparësi ndaj `days` kur jepen të dyja.
grainTrackingGrain- Madhësia e çdo ndarjeje: `day` (parazgjedhja), `hour` ose `minute`.
offset_minutesint- Zhvendosja e shikuesit nga UTC në minuta, -840 deri në 840, që ndarjet ditore dhe orare të nisin në kufirin e tij vendor. Si parazgjedhje 0.
Përgjigje
sincestr- ISO-8601 UTC, fillimi i ndarjes së parë.
untilstr- ISO-8601 UTC, çasti i leximit.
totalsAudienceGrowthTotals- `contacts` numëron çdo person një herë, pavarësisht në sa lista është, ndërsa `memberships` i mbledh listat, kështu që një person numërohet një herë për çdo listë të lexuar që e mban. `subscribed` numëron, nga një herë secilin, njerëzit që janë ende të regjistruar në të paktën një nga listat e lexuara. `added` mbledh hyrjet brenda periudhës, `unsubscribed` çregjistrimet brenda saj, `lists` tregon sa audienca u lexuan, dhe `busiest` është intervali me më shumë hyrje, ose `None`.
serieslist[AudienceGrowthSeries]- Një element për çdo audiencë, nga më e madhja: `id`, `name`, `builtin` (`True` te audienca e parazgjedhur), `total` anëtarë tani, `subscribed` (ata prej tyre që nuk janë çregjistruar), `before` (ata që hynë para `since`), `added` (ata që hynë brenda periudhës), `unsubscribed` (ata që u çregjistruan brenda saj) dhe `buckets`, secili një dict me `bucket`, `added` dhe `unsubscribed`. Listohen vetëm intervalet me një hyrje ose një çregjistrim, me çelësa `YYYY-MM-DD`, `YYYY-MM-DDTHH` ose `YYYY-MM-DDTHH:MM` në orën vendore të zhvendosjes.
Referencë
audiences.list()Referenca e plotëaudiences.list_all()Referenca e plotëaudiences.iterate()Referenca e plotëaudiences.get()Referenca e plotëaudiences.create()Referenca e plotëaudiences.update()Referenca e plotëaudiences.delete()Referenca e plotëaudiences.empty()Referenca e plotëaudiences.growth()Referenca e plotëaudiences.list_contacts()Referenca e plotëaudiences.list_all_contacts()Referenca e plotëaudiences.iterate_contacts()Referenca e plotëaudiences.add_contact()Referenca e plotëaudiences.add_contacts()Referenca e plotëaudiences.import_contacts()Referenca e plotëaudiences.remove_contact()Referenca e plotëaudiences.remove_contacts()Referenca e plotë