Skip to content

LayoutPreview

Source code in docs_src/capo_partnercentral_marketing/types/layout_preview.py
class LayoutPreview(TypedDict, closed=True):
    format: "capo_partnercentral_marketing.types.layout_format.LayoutFormat"
    """The format of the referenced object."""
    url: "capo_partnercentral_marketing.types.layout_url.LayoutUrl"
    """A stable URL serving the object. Not presigned, so it does not expire."""
    page_type: NotRequired[
        "capo_partnercentral_marketing.types.layout_page_type.LayoutPageType"
    ]
    """Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one. A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have."""

format instance-attribute

format: LayoutFormat

The format of the referenced object.

page_type instance-attribute

page_type: NotRequired[LayoutPageType]

Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one. A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.

url instance-attribute

url: LayoutUrl

A stable URL serving the object. Not presigned, so it does not expire.