Struct mailchimp::types::CampaignType
source · pub struct CampaignType {Show 24 fields
pub id: Option<String>,
pub web_id: Option<u64>,
pub parent_campaign_id: Option<String>,
pub campaign_type: Option<String>,
pub create_time: Option<String>,
pub archive_url: Option<String>,
pub long_archive_url: Option<String>,
pub status: Option<String>,
pub emails_sent: Option<u64>,
pub send_time: Option<String>,
pub content_type: Option<String>,
pub needs_block_refresh: Option<bool>,
pub has_logo_merge_tag: Option<bool>,
pub resendable: Option<bool>,
pub recipients: Option<RecipientType>,
pub settings: Option<CampaignSettingsType>,
pub variate_settings: Option<VariateSettingsType>,
pub tracking: Option<CampaignTrackingOptionsType>,
pub rss_opts: Option<RSSOptionsType>,
pub ab_split_opts: Option<ABTestingOptionsType>,
pub social_card: Option<SocialCardType>,
pub report_summary: Option<CampaignReportSummaryType>,
pub delivery_status: Option<CampaignDeliveryStatusType>,
pub _links: Option<Vec<LinkType>>,
/* private fields */
}
Fields
id: Option<String>
A string that uniquely identifies this campaign.
web_id: Option<u64>
The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.
parent_campaign_id: Option<String>
If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children.
campaign_type: Option<String>
There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.
create_time: Option<String>
The date and time the campaign was created in ISO 8601 format.
archive_url: Option<String>
The link to the campaign’s archive version in ISO 8601 format.
long_archive_url: Option<String>
The original link to the campaign’s archive version.
status: Option<String>
The current status of the campaign.
emails_sent: Option<u64>
The total number of emails sent for this campaign.
send_time: Option<String>
The date and time a campaign was sent.
content_type: Option<String>
How the campaign’s content is put together (‘template’, ‘drag_and_drop’, ‘html’, ‘url’).
needs_block_refresh: Option<bool>
Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor.
has_logo_merge_tag: Option<bool>
Determines if the campaign contains the |BRAND:LOGO| merge tag.
resendable: Option<bool>
Determines if the campaign qualifies to be resent to non-openers.
recipients: Option<RecipientType>
List settings for the campaign.
settings: Option<CampaignSettingsType>
The settings for your campaign, including subject, from name, reply-to address, and more.
variate_settings: Option<VariateSettingsType>
The settings specific to A/B test campaigns.
tracking: Option<CampaignTrackingOptionsType>
The tracking options for a campaign.
rss_opts: Option<RSSOptionsType>
RSS options for a campaign.
ab_split_opts: Option<ABTestingOptionsType>
A/B Testing options for a campaign.
The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.
report_summary: Option<CampaignReportSummaryType>
For sent campaigns, a summary of opens, clicks, and e-commerce data.
delivery_status: Option<CampaignDeliveryStatusType>
Updates on campaigns in the process of sending.
_links: Option<Vec<LinkType>>
Desc: A list of link types and descriptions for the API schema documents.
Implementations
sourceimpl CampaignType
impl CampaignType
sourcepub fn cancel_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
pub fn cancel_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
Cancel a campaign
sourcepub fn resend_campaign(&self) -> Result<CampaignType, MailchimpErrorType>
pub fn resend_campaign(&self) -> Result<CampaignType, MailchimpErrorType>
Resend a campaign
sourcepub fn pause_rss_driven_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
pub fn pause_rss_driven_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
Pause an RSS-Driven campaign
sourcepub fn replicate_campaign(&self) -> Result<CampaignType, MailchimpErrorType>
pub fn replicate_campaign(&self) -> Result<CampaignType, MailchimpErrorType>
Replicate a campaign in saved or send status.
sourcepub fn resume_rss_driven_campaign(
&self
) -> Result<EmptyType, MailchimpErrorType>
pub fn resume_rss_driven_campaign(
&self
) -> Result<EmptyType, MailchimpErrorType>
Resume an RSS-Driven campaign.
sourcepub fn schedule_campaign(
&self,
param: ScheduleParam
) -> Result<EmptyType, MailchimpErrorType>
pub fn schedule_campaign(
&self,
param: ScheduleParam
) -> Result<EmptyType, MailchimpErrorType>
Schedule a campaign for delivery. If you’re using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.
sourcepub fn send_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
pub fn send_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.
sourcepub fn send_test_email(
&self,
param: EmailParam
) -> Result<EmptyType, MailchimpErrorType>
pub fn send_test_email(
&self,
param: EmailParam
) -> Result<EmptyType, MailchimpErrorType>
Send a test email.
sourcepub fn unschedule_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
pub fn unschedule_campaign(&self) -> Result<EmptyType, MailchimpErrorType>
Unschedule a scheduled campaign that hasn’t started sending.
sourcepub fn delete(&self) -> Result<bool, MailchimpErrorType>
pub fn delete(&self) -> Result<bool, MailchimpErrorType>
Remove a campaign from your Mailchimp account.
sourcepub fn update(
&self,
param: UpdateCampaignParam
) -> Result<CampaignType, MailchimpErrorType>
pub fn update(
&self,
param: UpdateCampaignParam
) -> Result<CampaignType, MailchimpErrorType>
Remove a campaign from your Mailchimp account.
sourcepub fn get_content(
&self,
fields: Option<String>,
exclude_fields: Option<String>
) -> Result<CampaignContentType, MailchimpErrorType>
pub fn get_content(
&self,
fields: Option<String>,
exclude_fields: Option<String>
) -> Result<CampaignContentType, MailchimpErrorType>
Get the the HTML and plain-text content for a campaign.
Arguments: fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
sourcepub fn update_content(
&self,
param: CampaignContentParam
) -> Result<CampaignContentType, MailchimpErrorType>
pub fn update_content(
&self,
param: CampaignContentParam
) -> Result<CampaignContentType, MailchimpErrorType>
Set the content for a campaign.
sourcepub fn send_checklist(
&self,
fields: Option<String>,
exclude_fields: Option<String>
) -> Result<SendChecklistType, MailchimpErrorType>
pub fn send_checklist(
&self,
fields: Option<String>,
exclude_fields: Option<String>
) -> Result<SendChecklistType, MailchimpErrorType>
Review the send checklist for a campaign, and resolve any issues before sending.
Arguments: fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
sourcepub fn get_feedbacks(
&self,
fields: Option<String>,
exclude_fields: Option<String>
) -> MalchimpIter<CampaignFeedbackBuilder> ⓘ
pub fn get_feedbacks(
&self,
fields: Option<String>,
exclude_fields: Option<String>
) -> MalchimpIter<CampaignFeedbackBuilder> ⓘ
Get team feedback while you’re working together on a Mailchimp campaign.
Arguments: fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
pub fn get_feedback_info<'a>(
&self,
feedback_id: &'a str,
fields: Option<String>,
exclude_fields: Option<String>
) -> Result<CampaignFeedbackType, MailchimpErrorType>
Trait Implementations
sourceimpl Clone for CampaignType
impl Clone for CampaignType
sourcefn clone(&self) -> CampaignType
fn clone(&self) -> CampaignType
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for CampaignType
impl Debug for CampaignType
sourceimpl<'de> Deserialize<'de> for CampaignType
impl<'de> Deserialize<'de> for CampaignType
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl MailchimpCollection<CampaignType> for CampaignsType
impl MailchimpCollection<CampaignType> for CampaignsType
sourcefn get_total_items(&self) -> u64
fn get_total_items(&self) -> u64
Total Items
sourcefn get_values(&self) -> Vec<CampaignType>
fn get_values(&self) -> Vec<CampaignType>
Data