Skip to content

CampaignAssetTemplate

Source code in docs_src/capo_partnercentral_marketing/types/campaign_asset_template.py
class CampaignAssetTemplate(TypedDict, closed=True):
    id: "capo_partnercentral_marketing.types.id.Id"
    """The template-local asset template identifier."""
    type: "capo_partnercentral_marketing.types.campaign_asset_template_type.CampaignAssetTemplateType"
    """The kind of asset this blueprint instantiates as."""
    label: "capo_partnercentral_marketing.types.asset_name.AssetName"
    """Display label; becomes the instantiated asset's name."""
    display_order: NotRequired["int"]
    """Ordering for preview and instantiation."""
    fields: NotRequired[
        "capo_partnercentral_marketing.types.campaign_asset_template_field_list.CampaignAssetTemplateFieldList"
    ]
    """The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed."""
    layout_previews: NotRequired[
        "capo_partnercentral_marketing.types.layout_preview_list.LayoutPreviewList"
    ]
    """Previews of the AWS-authored layout skeleton."""
    prerequisite_asset_template_ids: NotRequired[
        "capo_partnercentral_marketing.types.campaign_asset_template_id_list.CampaignAssetTemplateIdList"
    ]
    """The asset templates this one embeds output from, such as an email's landing page. Each must be in the same `BatchCreateCampaignAsset` request or already an asset on the campaign, else the create is refused `PREREQUISITE_ASSET_MISSING`; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an `AssetLink` field and needs nothing at create."""
    social_platform: NotRequired[
        "capo_partnercentral_marketing.types.platform.Platform"
    ]
    """SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as `SocialPlatform`. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type."""

display_order instance-attribute

display_order: NotRequired[int]

Ordering for preview and instantiation.

fields instance-attribute

fields: NotRequired[CampaignAssetTemplateFieldList]

The editable-field schema, copied and pinned onto each campaign asset at create. Fields the service fills itself are not listed.

id instance-attribute

id: Id

The template-local asset template identifier.

label instance-attribute

label: AssetName

Display label; becomes the instantiated asset's name.

layout_previews instance-attribute

layout_previews: NotRequired[LayoutPreviewList]

Previews of the AWS-authored layout skeleton.

prerequisite_asset_template_ids instance-attribute

prerequisite_asset_template_ids: NotRequired[CampaignAssetTemplateIdList]

The asset templates this one embeds output from, such as an email's landing page. Each must be in the same BatchCreateCampaignAsset request or already an asset on the campaign, else the create is refused PREREQUISITE_ASSET_MISSING; include them when the partner picks this one. Absent when there are none. A link the partner chooses, such as a landing page's download button, is not listed here: it is an AssetLink field and needs nothing at create.

social_platform instance-attribute

social_platform: NotRequired[Platform]

SOCIAL_POST only: the platform an asset made from this blueprint posts to, which the asset reports as SocialPlatform. Fixed by the template, so a client can show which social connection the post needs before it is created. Absent for every other type.

type instance-attribute

The kind of asset this blueprint instantiates as.