Interface TemplateFieldValue.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<TemplateFieldValue.Builder,,TemplateFieldValue> SdkBuilder<TemplateFieldValue.Builder,,TemplateFieldValue> SdkPojo
- Enclosing class:
TemplateFieldValue
-
Method Summary
Modifier and TypeMethodDescriptiondefault TemplateFieldValue.BuildercampaignAssetImage(Consumer<CampaignAssetImageSource.Builder> campaignAssetImage) Write only.campaignAssetImage(CampaignAssetImageSource campaignAssetImage) Write only.imageReference(String imageReference) Image reference (image fields).linkedAssetId(String linkedAssetId) The asset anAssetLinkfield names: the id of an asset on the same campaign, of the field's category.Text value — for both text and RichText fields.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
-
text
Text value — for both text and RichText fields. A RichText value is a markup fragment restricted to the field's AllowedTags.
- Parameters:
text- Text value — for both text and RichText fields. A RichText value is a markup fragment restricted to the field's AllowedTags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageReference
Image reference (image fields).
On a write, one of exactly two forms:
- the
s3://URI of a file you staged in the Partner Central file staging bucket. It is scanned, then copied into this asset. - the URL Build with AI returned for a suggested image, unchanged. It is copied into this asset and not
scanned. Any other URL is refused with
FILE_REFERENCE_INVALID, including one a read returned: to keep the current image, omit the field; to put it on another asset, useCampaignAssetImage.
On a read, a URL the caller can fetch: an image in the asset's own storage comes back as a presigned GET that expires one hour after the read, so fetch it again with
GetCampaignAssetwhen it returns 403; an image already on DG's public CDN comes back as that stable URL. A stored reference outside this asset's storage, or not a raster image, is never signed, and the value is omitted. The signed URL serves the image as its image type, whatever the upload declared.- Parameters:
imageReference- Image reference (image fields).On a write, one of exactly two forms:
- the
s3://URI of a file you staged in the Partner Central file staging bucket. It is scanned, then copied into this asset. - the URL Build with AI returned for a suggested image, unchanged. It is copied into this asset and
not scanned. Any other URL is refused with
FILE_REFERENCE_INVALID, including one a read returned: to keep the current image, omit the field; to put it on another asset, useCampaignAssetImage.
On a read, a URL the caller can fetch: an image in the asset's own storage comes back as a presigned GET that expires one hour after the read, so fetch it again with
GetCampaignAssetwhen it returns 403; an image already on DG's public CDN comes back as that stable URL. A stored reference outside this asset's storage, or not a raster image, is never signed, and the value is omitted. The signed URL serves the image as its image type, whatever the upload declared.- the
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- the
-
linkedAssetId
The asset an
AssetLinkfield names: the id of an asset on the same campaign, of the field's category. It is a prerequisite of this asset while linked, so it activates first, this asset cannot start until it is live, and it cannot be deleted.- Parameters:
linkedAssetId- The asset anAssetLinkfield names: the id of an asset on the same campaign, of the field's category. It is a prerequisite of this asset while linked, so it activates first, this asset cannot start until it is live, and it cannot be deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
campaignAssetImage
Write only. Copies an image stored on another of your assets into this image field. The image is checked against this field's constraints and not scanned again. Also requires
partnercentral:GetCampaignAsseton the source campaign. Reads return the copy asImageReference.- Parameters:
campaignAssetImage- Write only. Copies an image stored on another of your assets into this image field. The image is checked against this field's constraints and not scanned again. Also requirespartnercentral:GetCampaignAsseton the source campaign. Reads return the copy asImageReference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
campaignAssetImage
default TemplateFieldValue.Builder campaignAssetImage(Consumer<CampaignAssetImageSource.Builder> campaignAssetImage) Write only. Copies an image stored on another of your assets into this image field. The image is checked against this field's constraints and not scanned again. Also requires
This is a convenience method that creates an instance of thepartnercentral:GetCampaignAsseton the source campaign. Reads return the copy asImageReference.CampaignAssetImageSource.Builderavoiding the need to create one manually viaCampaignAssetImageSource.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocampaignAssetImage(CampaignAssetImageSource).- Parameters:
campaignAssetImage- a consumer that will call methods onCampaignAssetImageSource.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-