Skip to content

CampaignAssetSummary

Source code in docs_src/capo_partnercentral_marketing/types/campaign_asset_summary.py
class CampaignAssetSummary(TypedDict, closed=True):
    id: "capo_partnercentral_marketing.types.campaign_asset_id.CampaignAssetId"
    """The asset identifier."""
    category: "capo_partnercentral_marketing.types.campaign_asset_category.CampaignAssetCategory"
    """The asset category."""
    name: "capo_partnercentral_marketing.types.asset_name.AssetName"
    """The display name."""
    link_label: NotRequired["capo_partnercentral_marketing.types.link_label.LinkLabel"]
    """DOCUMENT only: the words a page uses for this document, such as "eBook". A client listing the candidates for an `AssetLink` field reads it here, so a preview can update on pick without a fetch."""
    state: NotRequired[
        "capo_partnercentral_marketing.types.campaign_asset_state.CampaignAssetState"
    ]
    """Where the asset sits in its lifecycle."""
    last_activation_status: NotRequired[
        "capo_partnercentral_marketing.types.attempt_status.AttemptStatus"
    ]
    """How the last hand-over to the delivery platform ended. Absent before the first activation."""
    delivery_status: NotRequired[
        "capo_partnercentral_marketing.types.delivery_status.DeliveryStatus"
    ]
    """Whether the platform has delivered the asset."""
    delivery_status_reason: NotRequired[
        "capo_partnercentral_marketing.types.campaign_asset_state_reason.CampaignAssetStateReason"
    ]
    """Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry."""
    source_asset_template_id: NotRequired["capo_partnercentral_marketing.types.id.Id"]
    """The asset template this asset was created from. The same value `CampaignAsset.SourceAssetTemplateId` reports, and absent when it is."""
    social_platform: NotRequired[
        "capo_partnercentral_marketing.types.platform.Platform"
    ]
    """SOCIAL_POST only: the platform the post goes to. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed."""
    started_at: NotRequired["capo_partnercentral_marketing.types.timestamp.Timestamp"]
    """When the asset first went live, set once. Absent if it never has."""
    file_format: NotRequired[
        "capo_partnercentral_marketing.types.file_format.FileFormat"
    ]
    """Concrete file format of the finished artifact."""
    send_mode: NotRequired["capo_partnercentral_marketing.types.send_mode.SendMode"]
    """When this asset sends, as chosen with UpdateCampaignAsset. `EMAIL` and `SOCIAL_POST` only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports `SEND_MODE_MISSING`."""
    scheduled_send_at: NotRequired[
        "capo_partnercentral_marketing.types.timestamp.Timestamp"
    ]
    """The send time, present only when `SendMode` is `SCHEDULED`. It reaches the delivery platform at the asset's next activation. Was `scheduleDate: UtcDate`; retyped with the write member of the same name."""

category instance-attribute

The asset category.

delivery_status instance-attribute

delivery_status: NotRequired[DeliveryStatus]

Whether the platform has delivered the asset.

delivery_status_reason instance-attribute

delivery_status_reason: NotRequired[CampaignAssetStateReason]

Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.

file_format instance-attribute

file_format: NotRequired[FileFormat]

Concrete file format of the finished artifact.

id instance-attribute

The asset identifier.

last_activation_status instance-attribute

last_activation_status: NotRequired[AttemptStatus]

How the last hand-over to the delivery platform ended. Absent before the first activation.

link_label: NotRequired[LinkLabel]

DOCUMENT only: the words a page uses for this document, such as "eBook". A client listing the candidates for an AssetLink field reads it here, so a preview can update on pick without a fetch.

name instance-attribute

name: AssetName

The display name.

scheduled_send_at instance-attribute

scheduled_send_at: NotRequired[Timestamp]

The send time, present only when SendMode is SCHEDULED. It reaches the delivery platform at the asset's next activation. Was scheduleDate: UtcDate; retyped with the write member of the same name.

send_mode instance-attribute

send_mode: NotRequired[SendMode]

When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.

social_platform instance-attribute

social_platform: NotRequired[Platform]

SOCIAL_POST only: the platform the post goes to. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed.

source_asset_template_id instance-attribute

source_asset_template_id: NotRequired[Id]

The asset template this asset was created from. The same value CampaignAsset.SourceAssetTemplateId reports, and absent when it is.

started_at instance-attribute

started_at: NotRequired[Timestamp]

When the asset first went live, set once. Absent if it never has.

state instance-attribute

state: NotRequired[CampaignAssetState]

Where the asset sits in its lifecycle.