Skip to content

CampaignTemplate

Source code in docs_src/capo_partnercentral_marketing/types/campaign_template.py
class CampaignTemplate(TypedDict, closed=True):
    id: "capo_partnercentral_marketing.types.campaign_template_id.CampaignTemplateId"
    """The campaign template identifier."""
    name: "capo_partnercentral_marketing.types.template_name.TemplateName"
    """The display name."""
    industry: NotRequired["capo_partnercentral_marketing.types.industry.Industry"]
    """Target industry for filtering or categorization."""
    use_case: NotRequired["str"]
    """Campaign use case for filtering or categorization."""
    description: NotRequired[
        "capo_partnercentral_marketing.types.campaign_template_description.CampaignTemplateDescription"
    ]
    """A short overview of the campaign, as plain text in the template's language: no HTML and no character entities. Absent when the template has none; never an empty string."""
    language_code: NotRequired[
        "capo_partnercentral_marketing.types.asset_language.AssetLanguage"
    ]
    """Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template."""
    collection: "capo_partnercentral_marketing.types.campaign_template_collection.CampaignTemplateCollection"
    """The browsing context the template is listed in. Every template has exactly one."""
    aws_services: NotRequired[
        "capo_partnercentral_marketing.types.aws_services_list.AwsServicesList"
    ]
    """AWS services the template promotes."""
    customer_segments: NotRequired[
        "capo_partnercentral_marketing.types.customer_segment_list.CustomerSegmentList"
    ]
    """The customer segments the template is written for. Absent when the template names none, in which case it matches every `CustomerSegments` search filter."""
    themes: NotRequired["capo_partnercentral_marketing.types.theme_list.ThemeList"]
    """The template's marketing themes. Absent when the template names none, in which case it matches every `Themes` search filter."""
    setup_duration: NotRequired["str"]
    """Estimated setup time."""
    thumbnail_url: NotRequired["str"]
    """Thumbnail URL."""
    effective_date_begin: NotRequired[
        "capo_partnercentral_marketing.types.timestamp.Timestamp"
    ]
    """The instant the template becomes available to partners. Until then the template does not exist to a partner: SearchCampaignTemplates omits it and GetCampaignTemplate returns ResourceNotFoundException."""
    asset_templates: NotRequired[
        "capo_partnercentral_marketing.types.campaign_asset_template_list.CampaignAssetTemplateList"
    ]
    """The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create."""
    reference_materials: NotRequired[
        "capo_partnercentral_marketing.types.reference_material_list.ReferenceMaterialList"
    ]
    """The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart from `AssetTemplates` because none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited a `BatchCreateCampaignAsset` that could only fail. Absent when the template has none."""
    created_at: NotRequired["capo_partnercentral_marketing.types.timestamp.Timestamp"]
    """Creation timestamp."""
    updated_at: NotRequired["capo_partnercentral_marketing.types.timestamp.Timestamp"]
    """Last update timestamp."""

asset_templates instance-attribute

asset_templates: NotRequired[CampaignAssetTemplateList]

The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.

aws_services instance-attribute

aws_services: NotRequired[AwsServicesList]

AWS services the template promotes.

collection instance-attribute

The browsing context the template is listed in. Every template has exactly one.

created_at instance-attribute

created_at: NotRequired[Timestamp]

Creation timestamp.

customer_segments instance-attribute

customer_segments: NotRequired[CustomerSegmentList]

The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search filter.

description instance-attribute

description: NotRequired[CampaignTemplateDescription]

A short overview of the campaign, as plain text in the template's language: no HTML and no character entities. Absent when the template has none; never an empty string.

effective_date_begin instance-attribute

effective_date_begin: NotRequired[Timestamp]

The instant the template becomes available to partners. Until then the template does not exist to a partner: SearchCampaignTemplates omits it and GetCampaignTemplate returns ResourceNotFoundException.

id instance-attribute

The campaign template identifier.

industry instance-attribute

industry: NotRequired[Industry]

Target industry for filtering or categorization.

language_code instance-attribute

language_code: NotRequired[AssetLanguage]

Language the template is authored in, which a campaign created from it takes. A template has one language; the same content in another language is another template.

name instance-attribute

The display name.

reference_materials instance-attribute

reference_materials: NotRequired[ReferenceMaterialList]

The template's reference materials: guides, briefs, copy blocks and other files a partner downloads and uses in their own channels. Kept apart from AssetTemplates because none of them can become a campaign asset — they have no editable field and nothing to activate — and listing them beside the blueprints invited a BatchCreateCampaignAsset that could only fail. Absent when the template has none.

setup_duration instance-attribute

setup_duration: NotRequired[str]

Estimated setup time.

themes instance-attribute

themes: NotRequired[ThemeList]

The template's marketing themes. Absent when the template names none, in which case it matches every Themes search filter.

thumbnail_url instance-attribute

thumbnail_url: NotRequired[str]

Thumbnail URL.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

Last update timestamp.

use_case instance-attribute

use_case: NotRequired[str]

Campaign use case for filtering or categorization.