Interface CampaignAsset.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<CampaignAsset.Builder,,CampaignAsset> SdkBuilder<CampaignAsset.Builder,,CampaignAsset> SdkPojo
- Enclosing class:
CampaignAsset
-
Method Summary
Modifier and TypeMethodDescriptionactivationIssues(Collection<ActivationIssue> activationIssues) What must be fixed on this asset before it can be activated.activationIssues(Consumer<ActivationIssue.Builder>... activationIssues) What must be fixed on this asset before it can be activated.activationIssues(ActivationIssue... activationIssues) What must be fixed on this asset before it can be activated.campaignId(String campaignId) The campaign identifier.The asset category.category(CampaignAssetCategory category) The asset category.Creation timestamp.deliveryStatus(String deliveryStatus) What the platform did with the artifact after accepting it.deliveryStatus(DeliveryStatus deliveryStatus) What the platform did with the artifact after accepting it.deliveryStatusReason(String deliveryStatusReason) Why delivery failed.deliveryStatusReason(CampaignAssetStateReason deliveryStatusReason) Why delivery failed.fieldValues(Collection<CampaignAssetFieldValue> fieldValues) The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value.fieldValues(Consumer<CampaignAssetFieldValue.Builder>... fieldValues) The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value.fieldValues(CampaignAssetFieldValue... fieldValues) The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value.fileFormat(String fileFormat) Concrete file format of the finished artifact.fileFormat(FileFormat fileFormat) Concrete file format of the finished artifact.The asset identifier.lastActivationStatus(String lastActivationStatus) How the most recent hand-over to the delivery platform ended.lastActivationStatus(AttemptStatus lastActivationStatus) How the most recent hand-over to the delivery platform ended.default CampaignAsset.Builderlayout(Consumer<CampaignAssetLayout.Builder> layout) A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with.layout(CampaignAssetLayout layout) A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with.layoutPreviews(Collection<LayoutPreview> layoutPreviews) The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation.layoutPreviews(Consumer<LayoutPreview.Builder>... layoutPreviews) The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation.layoutPreviews(LayoutPreview... layoutPreviews) The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation.DOCUMENT only: the words a page uses for this document, such as "eBook".The display name.The live public address this asset's activation produced.scheduledSendAt(Instant scheduledSendAt) The send time, present only whenSendModeisSCHEDULED.When this asset sends, as chosen with UpdateCampaignAsset.When this asset sends, as chosen with UpdateCampaignAsset.socialPlatform(String socialPlatform) SOCIAL_POST only: the platform the post goes to, set from its template and never writable.socialPlatform(Platform socialPlatform) SOCIAL_POST only: the platform the post goes to, set from its template and never writable.sourceAssetTemplateId(String sourceAssetTemplateId) The asset template this asset was created from: theSourceAssetTemplateIdentifieritsBatchCreateCampaignAssetentry named, one ofGetCampaignTemplate'sCampaignTemplate.AssetTemplates[].Id.Whether the asset is live.state(CampaignAssetState state) Whether the asset is live.Last update timestamp.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
id
The asset identifier.
- Parameters:
id- The asset identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
campaignId
The campaign identifier.
- Parameters:
campaignId- The campaign identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
category
The asset category.
- Parameters:
category- The asset category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
category
The asset category.
- Parameters:
category- The asset category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The display name.
- Parameters:
name- The display name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
linkLabel
DOCUMENT only: the words a page uses for this document, such as "eBook". Fill an
AssetLinkfield'sLabelFieldIdwith it when the partner picks this asset.- Parameters:
linkLabel- DOCUMENT only: the words a page uses for this document, such as "eBook". Fill anAssetLinkfield'sLabelFieldIdwith it when the partner picks this asset.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
Whether the asset is live.
Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re-publication it stays ACTIVE, because the previously published content is still serving.
A stopped asset and one never started both read INACTIVE;
LastActivationStatustells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that memberSUCCEEDED, never started is INACTIVE with it absent.An update never moves this member.
- Parameters:
state- Whether the asset is live.Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re -publication it stays ACTIVE, because the previously published content is still serving.
A stopped asset and one never started both read INACTIVE;
LastActivationStatustells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that memberSUCCEEDED, never started is INACTIVE with it absent.An update never moves this member.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
Whether the asset is live.
Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re-publication it stays ACTIVE, because the previously published content is still serving.
A stopped asset and one never started both read INACTIVE;
LastActivationStatustells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that memberSUCCEEDED, never started is INACTIVE with it absent.An update never moves this member.
- Parameters:
state- Whether the asset is live.Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re -publication it stays ACTIVE, because the previously published content is still serving.
A stopped asset and one never started both read INACTIVE;
LastActivationStatustells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that memberSUCCEEDED, never started is INACTIVE with it absent.An update never moves this member.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lastActivationStatus
How the most recent hand-over to the delivery platform ended.
The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is
DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.Read with
Statethis is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.
Omitted before the first activation attempt.
- Parameters:
lastActivationStatus- How the most recent hand-over to the delivery platform ended.The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is
DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.Read with
Statethis is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.
Omitted before the first activation attempt.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lastActivationStatus
How the most recent hand-over to the delivery platform ended.
The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is
DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.Read with
Statethis is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.
Omitted before the first activation attempt.
- Parameters:
lastActivationStatus- How the most recent hand-over to the delivery platform ended.The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is
DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.Read with
Statethis is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.
Omitted before the first activation attempt.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deliveryStatus
What the platform did with the artifact after accepting it.
EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.
- Parameters:
deliveryStatus- What the platform did with the artifact after accepting it.EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deliveryStatus
What the platform did with the artifact after accepting it.
EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.
- Parameters:
deliveryStatus- What the platform did with the artifact after accepting it.EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deliveryStatusReason
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.
- Parameters:
deliveryStatusReason- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deliveryStatusReason
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.
- Parameters:
deliveryStatusReason- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceAssetTemplateId
The asset template this asset was created from: the
SourceAssetTemplateIdentifieritsBatchCreateCampaignAssetentry named, one ofGetCampaignTemplate'sCampaignTemplate.AssetTemplates[].Id. Set at create and never writable. Absent on an asset created before DG recorded it, which can't be activated either. A campaign holds at most one asset per asset template, so this is how a client matches a campaign's assets to its template's asset templates, for example to create the same assets in another campaign. Names don't identify one: two asset templates can share a name.- Parameters:
sourceAssetTemplateId- The asset template this asset was created from: theSourceAssetTemplateIdentifieritsBatchCreateCampaignAssetentry named, one ofGetCampaignTemplate'sCampaignTemplate.AssetTemplates[].Id. Set at create and never writable. Absent on an asset created before DG recorded it, which can't be activated either. A campaign holds at most one asset per asset template, so this is how a client matches a campaign's assets to its template's asset templates, for example to create the same assets in another campaign. Names don't identify one: two asset templates can share a name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
socialPlatform
SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value
CampaignAssetSummary.SocialPlatformreports. Absent for every other category.- Parameters:
socialPlatform- SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same valueCampaignAssetSummary.SocialPlatformreports. Absent for every other category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileFormat
Concrete file format of the finished artifact. For
DOWNLOAD_ONLYthis is the format of the object export copies through verbatim.- Parameters:
fileFormat- Concrete file format of the finished artifact. ForDOWNLOAD_ONLYthis is the format of the object export copies through verbatim.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileFormat
Concrete file format of the finished artifact. For
DOWNLOAD_ONLYthis is the format of the object export copies through verbatim.- Parameters:
fileFormat- Concrete file format of the finished artifact. ForDOWNLOAD_ONLYthis is the format of the object export copies through verbatim.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sendMode
When this asset sends, as chosen with UpdateCampaignAsset.
EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.- Parameters:
sendMode- When this asset sends, as chosen with UpdateCampaignAsset.EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sendMode
When this asset sends, as chosen with UpdateCampaignAsset.
EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.- Parameters:
sendMode- When this asset sends, as chosen with UpdateCampaignAsset.EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheduledSendAt
The send time, present only when
SendModeisSCHEDULED. It reaches the delivery platform at the asset's next activation.Was
scheduleDate: UtcDate; retyped with the write member of the same name.- Parameters:
scheduledSendAt- The send time, present only whenSendModeisSCHEDULED. It reaches the delivery platform at the asset's next activation.Was
scheduleDate: UtcDate; retyped with the write member of the same name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldValues
The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.
- Parameters:
fieldValues- The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldValues
The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.
- Parameters:
fieldValues- The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldValues
The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.
This is a convenience method that creates an instance of theCampaignAssetFieldValue.Builderavoiding the need to create one manually viaCampaignAssetFieldValue.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofieldValues(List<CampaignAssetFieldValue>).- Parameters:
fieldValues- a consumer that will call methods onCampaignAssetFieldValue.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
layoutPreviews
The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.
The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).
One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.
On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.
- Parameters:
layoutPreviews- The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).
One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.
On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layoutPreviews
The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.
The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).
One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.
On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.
- Parameters:
layoutPreviews- The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).
One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.
On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layoutPreviews
The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.
The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).
One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.
On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.
This is a convenience method that creates an instance of theLayoutPreview.Builderavoiding the need to create one manually viaLayoutPreview.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolayoutPreviews(List<LayoutPreview>).- Parameters:
layoutPreviews- a consumer that will call methods onLayoutPreview.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
layout
A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with. Absent for a single-layout asset.
FieldValues is always the union of every option's fields, selected or not, so a client can switch layouts without a round trip: each option lists its own FieldIds. The selection drives layout.selected and the top-level LayoutPreviews only.
- Parameters:
layout- A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with. Absent for a single-layout asset.FieldValues is always the union of every option's fields, selected or not, so a client can switch layouts without a round trip: each option lists its own FieldIds. The selection drives layout.selected and the top-level LayoutPreviews only.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layout
A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with. Absent for a single-layout asset.
FieldValues is always the union of every option's fields, selected or not, so a client can switch layouts without a round trip: each option lists its own FieldIds. The selection drives layout.selected and the top-level LayoutPreviews only.
This is a convenience method that creates an instance of theCampaignAssetLayout.Builderavoiding the need to create one manually viaCampaignAssetLayout.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolayout(CampaignAssetLayout).- Parameters:
layout- a consumer that will call methods onCampaignAssetLayout.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
activationIssues
What must be fixed on this asset before it can be activated. Empty when the asset is ready.
Issues don't block saving: an asset can be saved incomplete and fixed over several updates.
StartCampaignAssetActivationTaskrefuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans the text was refused as a whole; editing any text field removes it.Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on
Campaign.ActivationIssues, not here.- Parameters:
activationIssues- What must be fixed on this asset before it can be activated. Empty when the asset is ready.Issues don't block saving: an asset can be saved incomplete and fixed over several updates.
StartCampaignAssetActivationTaskrefuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans the text was refused as a whole; editing any text field removes it.Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on
Campaign.ActivationIssues, not here.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activationIssues
What must be fixed on this asset before it can be activated. Empty when the asset is ready.
Issues don't block saving: an asset can be saved incomplete and fixed over several updates.
StartCampaignAssetActivationTaskrefuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans the text was refused as a whole; editing any text field removes it.Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on
Campaign.ActivationIssues, not here.- Parameters:
activationIssues- What must be fixed on this asset before it can be activated. Empty when the asset is ready.Issues don't block saving: an asset can be saved incomplete and fixed over several updates.
StartCampaignAssetActivationTaskrefuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans the text was refused as a whole; editing any text field removes it.Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on
Campaign.ActivationIssues, not here.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activationIssues
What must be fixed on this asset before it can be activated. Empty when the asset is ready.
Issues don't block saving: an asset can be saved incomplete and fixed over several updates.
StartCampaignAssetActivationTaskrefuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans the text was refused as a whole; editing any text field removes it.Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on
This is a convenience method that creates an instance of theCampaign.ActivationIssues, not here.ActivationIssue.Builderavoiding the need to create one manually viaActivationIssue.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toactivationIssues(List<ActivationIssue>).- Parameters:
activationIssues- a consumer that will call methods onActivationIssue.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
publicUrl
The live public address this asset's activation produced.
A landing page's page URL, read back from the delivery platform at activation and preserved across every convergence; a document's public CDN URL, composed on read from the key the publish wrote. Absent until the asset activates, and absent for EMAIL and SOCIAL_POST, which produce no partner-addressable URL of their own.
For a landing page this is the entire deliverable — without it a partner has no way to learn where their live page is. A WIDGET landing page reports none: it is embedded rather than standalone, so absence there is expected rather than a fault.
- Parameters:
publicUrl- The live public address this asset's activation produced.A landing page's page URL, read back from the delivery platform at activation and preserved across every convergence; a document's public CDN URL, composed on read from the key the publish wrote. Absent until the asset activates, and absent for EMAIL and SOCIAL_POST, which produce no partner-addressable URL of their own.
For a landing page this is the entire deliverable — without it a partner has no way to learn where their live page is. A WIDGET landing page reports none: it is embedded rather than standalone, so absence there is expected rather than a fault.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
Creation timestamp.
- Parameters:
createdAt- Creation timestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
Last update timestamp.
- Parameters:
updatedAt- Last update timestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
socialPlatform
SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value
CampaignAssetSummary.SocialPlatformreports. Absent for every other category.socialPlatform- SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same valueCampaignAssetSummary.SocialPlatformreports. Absent for every other category.PlatformPlatform