AudiencePreview class

Constructors

AudiencePreview({bool? available, int? count, int? deliverable, String? reason, List<String> sample = const [], String? source_, int? unmatched})

Returns a new AudiencePreview instance.

Properties

available ↔ bool?

Available is false when the roster or the warehouse could not be read; the counts are then zero because nothing was measured, not because the cohort is empty, and Reason says which read failed.

getter/setter pair

count ↔ int?

Count is the cohort size: distinct warehouse identifiers for an event audience, mailable customers for an event-less (whole-org) one.

getter/setter pair

deliverable ↔ int?

Deliverable is how many de-duplicated mailboxes a send would reach. Two customers sharing an address count once, so it is <= Count.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

reason ↔ String?

Reason is the error text of the read that failed: the org's roster could not be loaded ("identity store unavailable…"), or the cohort query had no warehouse to run against ("analytics warehouse not configured"). Absent when the evaluation succeeded, so its presence and Available=false are one fact seen twice.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sample ↔ List<String>

Sample is up to 1000 cohort IDENTIFIERS — never addresses, which product analytics does not hold. Empty for an event-less (whole-org) audience.

getter/setter pair

source_ ↔ String?

Source names where the cohort was read: the events table for an event audience, "iam:

getter/setter pair

unmatched ↔ int?

Unmatched is how many cohort identifiers named nobody on the org's roster and so have no address to mail. It is reported rather than hidden: it is the honest explanation for a cohort of 500 that mails 3. Always 0 for an event-less (whole-org) audience, which starts from the roster and has nothing to match.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → AudiencePreview?

Returns a new AudiencePreview instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<AudiencePreview>

mapFromJson(dynamic json) → Map<String, AudiencePreview>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<AudiencePreview>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.