ListEmail

Salesforce から送信されたリストメール、または Account Engagement から送信されて Salesforce と同期されたリストメールを表します。リストメールが送信されるときに、ListEmailIndividualRecipients と ListEmailRecipientSource の受信者を組み合わせて受信者が生成されます。重複やその他の無効な受信者は削除されます。その結果、特定のリストメールが送信される受信者のみになります。ListEmail には ListEmailRecipientSource および ListEmailIndividualRecipient との一対多リレーションがあります。このオブジェクトは、API バージョン 41.0 以降で使用できます。

サポートされているコール

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()undelete()update()upsert()

項目

項目 詳細
ActionCadenceStepId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明

リストメールレコードを生成したアクションケイデンスステップの ID。Sales Engagement の自動メールに使用されます。

ユーザーは、「Sales Engagement ケイデンス作成者」または「Sales Engagement ユーザー」権限が有効化されている必要があります。

この項目は、API バージョン 54.0 以降で使用できます。

リレーション名
ActionCadenceStep
リレーション種別
Lookup
参照先
ActionCadenceStep
CampaignId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明

関連キャンペーンの ID。

この項目は、API バージョン 42.0 以降で使用できます。

これはリレーション項目です。
リレーション名
Campaign
リレーション種別
Lookup
参照先
Campaign
ClickThroughRate
percent
プロパティ
Filter、Nillable、Sort
説明

配信された (送信済みから不達を差し引いた) メールに含まれるリンクをクリックした訪問者の割合。同じリンクの複数のクリックは含まれます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

ClickToOpenRatio
percent
プロパティ
Filter、Nillable、Sort
説明

ユニーククリック数をユニーク HTML 開封数で割った数。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

DeliveryRate
percent
プロパティ
Filter、Nillable、Sort
説明

(ソフトおよびハード) バウンスした数と対比した配信されたメール数の割合。なお、このデータには、受信者のスパムフォルダーに配信されたメールも含まれます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

EmailContentId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
リストメールに関連付けられたメールコンテンツレコードの ID。

この項目は、API バージョン 50.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

FromAddress
textarea
プロパティ
Create、Filter、Update
説明
参照のみ (ただし、リストメールがドラフトの状態になっている場合を除く)。ユーザーのアドレスに対して検証済み。
FromName
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
参照のみ (ただし、リストメールがドラフトの状態になっている場合を除く)。ユーザーのアドレスに対して検証済み。Account Engagement から送信されたメールの場合、この項目は null です。
HasAttachment
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
参照のみ。作成および更新時にデフォルト設定されます。リストメールに添付ファイルが含まれる場合、値は true です。Account Engagement から送信されたメールの場合、この項目は null です。
HtmlBody
textarea
プロパティ
Create、Nillable、Update
説明
リストメールの本文。Account Engagement から送信されたメールの場合、この項目は null です。
リストメールでは、本文に最大 32,000 文字を使用できます。これらの制限には、メール内の表示文字と、マークアップなどのその他の文字が含まれます。
IsTracked
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
リストメールが送信されたときにメール追跡が有効だったかどうかを示します。Account Engagement から送信されて Salesforce と同期されたメールの場合、この項目は空白です。Account Engagement から送信されたメールの場合、この項目は null です。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザーがこのリストメールに関連するレコードを最後に参照した時間を示すタイムスタンプ。Account Engagement から送信されたメールの場合、この項目は null です。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザーがこのレコードを最後に表示したときのタイムスタンプ。この値が null の場合、このレコードは参照 (LastReferencedDate) されただけで、表示はされていない可能性があります。Account Engagement から送信されたメールの場合、この項目は null です。
Name
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
参照のみ (ただし、リストメールがドラフトの状態になっている場合を除く)。
OpenRate
percent
プロパティ
Filter、Nillable、Sort
説明

配信された (送信済みから不達を引いた) メールの合計数と比較したユニーク HTML 開封数の割合。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

OptOutRate
percent
プロパティ
Filter、Nillable、Sort
説明

送信されたメールの合計数と比較したオプトアウト済みユーザー数の割合。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
グループとユーザーを参照します。Account Engagement から送信されたメールの場合、この項目は null です。
これは多態的なリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
Group、User
ProgramName
string
プロパティ
Filter、Group、Nillable
説明

自動メールの送信元である Engagement Studio プログラムの名前。将来の使用のために予約されています。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

ScheduledDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
参照のみ。null の場合、Status が Scheduled に設定されていると、デフォルトは作成時刻になります。
SentVia
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明

メールが Salesforce と Account Engagement のどちらから送信されたかを示します。使用できる値は SalesforcePardot、または MessagingService です。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

SpamComplaintRate
percent
プロパティ
Filter、Nillable、Sort
説明

送信されたメールの合計数と比較したスパム報告数の割合。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

Status
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
参照のみ (ただし、リストメールがドラフトの状態になっている場合を除く)。
状況を Scheduled に変更すると、リストメールが送信されます。
有効な値は次のとおりです。
  • Draft
  • Scheduled
  • Sent
  • Limit Error
  • Cancelled
Subject
textarea
プロパティ
Create、Filter、Nillable、Update
説明
参照のみ (ただし、リストメールがドラフトの状態になっている場合を除く)。Account Engagement から送信されたメールの場合、この項目は null です。
リストメールでは、件名に最大 3,000 文字を使用できます。これらの制限には、メール内の表示文字と、マークアップなどのその他の文字が含まれます。
TextBody
textarea
プロパティ
Create、Nillable、Update
説明
参照のみ (ただし、リストメールがドラフトの状態になっている場合を除く)。Account Engagement から送信されたメールの場合、この項目は null です。
TotalDelivered
int
プロパティ
Filter、Group、Nillable、Sort
説明

メールの合計数からハードバウンス数とソフトバウンス数を差し引いた数。なお、このデータには、受信者のスパムフォルダーに配信されたメールも含まれます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

TotalHardBounced
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

アドレスが無効であるために、送信者に永続的にバウンスされたメールの総数。ハードバウンスは、ドメイン名が存在しないか、受信者が不明であると発生します。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

TotalOpens
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

プロスペクトのメールクライアントが HTML 版のメールに含まれる画像を読み込んだ合計回数。画像をダウンロードしない HTML メールまたはテキストメールのリンクをプロスペクトがクリックした場合も、開封が記録されます。クリックされたということは、メッセージが表示されたということを意味します。デフォルトでは画像が表示されないメールクライアントもあります (Outlook、Apple Mail、Thunderbird)。Account Engagement では、画像が読み込まれるたびに開封が計数されます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、ユーザーに「Sales Engagement ユーザー」権限セットが必要か、組織で Account Engagement を使用する必要がありユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

TotalOutOfOffice
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

不在通知メッセージが含まれる受信した返信の合計数。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「Salesforce Engage」権限セットが必要です。

TotalReplies
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

受信した返信の合計数。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「Salesforce Engage」権限セットが必要です。

TotalSent
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明
参照のみ。送信したリストメールの総数。不達、送信除外、無効な宛先アドレスを含みます。
TotalSoftBounced
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

受信者のメールサーバーでメールが認識されたが、送信者に返された合計回数。受信者のメールボックスがいっぱいであるか、メールサーバーが一時的に使用不可になっていると発生します。ソフトバウンスメッセージは、時間を置くと配信可能になることがあります。ソフトバウンスが 5 回になると、Account Engagement によってプロスペクトはメールからオプトアウトされます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

TotalSpamComplaints
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

メールをスパムと報告した見込み客の合計数。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

TotalTrackedLinkClicks
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

見込み客がメールのリンクをクリックした回数。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

Type
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist
説明

送信されたメールの種別: リストメールまたは自動メール。将来の使用のために予約されています。

この項目は、API バージョン 46.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

UniqueClickThroughRate
percent
プロパティ
Filter、Nillable、Sort
説明

メールに含まれるリンクをクリックした訪問者の割合。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

UniqueOpens
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

HTML バージョンのメールで画像を読み込んだ見込み客の数。ユニーク開封数カテゴリでは、見込み客が画像を複数回読み込んだ場合でも、各受信者あたり 1 回のみ計数されます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

UniqueOptOuts
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

ユニークオプトアウト数は、登録を解除するリンクをクリックしたか、メールプリファレンスセンターですべてのメールからオプトアウトした見込み客の合計数を表します。これらの見込み客は今後のメール送信から削除されます。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

UniqueReplies
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

ユニーク返信の合計数。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「Salesforce Engage」権限セットが必要です。

UniqueTrackedLinkClicks
int
プロパティ
Defaulted on create、Filter、Group、Nillable、Sort
説明

個人見込み客がメールのリンクをクリックした回数。この総計値には、同じリンクの複数のクリックは含まれません。

この項目は、API バージョン 41.0 以降で使用できます。この項目にアクセスするには、組織で Account Engagement を使用する必要があり、ユーザーに「CRM ユーザー」または「営業ユーザー」権限セットが必要です。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。

AccountChangeEvent (API バージョン 44.0)
このオブジェクトには変更イベントを利用できます。
ListEmailOwnerSharingRule
このオブジェクトには共有ルールを利用できます。
ListEmailShare
このオブジェクトには共有を利用できます。