Interface CampaignAssetTemplateField.Builder

  • Method Details

    • fieldId

      The field identifier; matches a {{fieldId}} slot in the layout.

      Parameters:
      fieldId - The field identifier; matches a {{fieldId}} slot in the layout.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • label

      Human-readable name for the field, for display. Authored in the template policy, never derived from the field id or the source layout's field name: the id is a slug (Page_2_Title) and is not meant to be shown to a partner. Absent on fields imported before labels existed.

      Parameters:
      label - Human-readable name for the field, for display. Authored in the template policy, never derived from the field id or the source layout's field name: the id is a slug (Page_2_Title) and is not meant to be shown to a partner. Absent on fields imported before labels existed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CampaignAssetTemplateField.Builder description(String description)

      What belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic"). AWS-authored with the template; never written by a partner. Absent when the template carries none, never empty. Pinned onto the asset with the field, so a corrected description reaches assets created after the correction.

      Parameters:
      description - What belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic"). AWS-authored with the template; never written by a partner. Absent when the template carries none, never empty. Pinned onto the asset with the field, so a corrected description reaches assets created after the correction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • section

      Layout section the field belongs to.

      Parameters:
      section - Layout section the field belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • section

      Layout section the field belongs to.

      Parameters:
      section - Layout section the field belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • page

      One-based page number, for paginated layouts (print documents).

      Parameters:
      page - One-based page number, for paginated layouts (print documents).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • required

      Whether the field must be filled before the asset can be activated. Derived from DG policy — never inherited from an upstream authoring system.

      Required for activation, not for saving: UpdateCampaignAsset accepts partial content and may clear a required field. An unfilled required field appears in the asset's ActivationIssues as REQUIRED_FIELD_MISSING, and activation refuses the asset with the same code.

      A text field is filled only by a non-blank value, and a rich-text field only by a value with non-blank text; a Placeholder never fills one. An image field is filled by the partner's image or by the template's DefaultValue. A field the campaign fills (CampaignSetting) or the partner's profile fills (PartnerProfileField) is never unfilled on the asset.

      Parameters:
      required - Whether the field must be filled before the asset can be activated. Derived from DG policy — never inherited from an upstream authoring system.

      Required for activation, not for saving: UpdateCampaignAsset accepts partial content and may clear a required field. An unfilled required field appears in the asset's ActivationIssues as REQUIRED_FIELD_MISSING, and activation refuses the asset with the same code.

      A text field is filled only by a non-blank value, and a rich-text field only by a value with non-blank text; a Placeholder never fills one. An image field is filled by the partner's image or by the template's DefaultValue. A field the campaign fills (CampaignSetting) or the partner's profile fills (PartnerProfileField) is never unfilled on the asset.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The field kind, with that kind's constraints, placeholder or default.

      Parameters:
      type - The field kind, with that kind's constraints, placeholder or default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The field kind, with that kind's constraints, placeholder or default.

      This is a convenience method that creates an instance of the FieldType.Builder avoiding the need to create one manually via FieldType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to type(FieldType).

      Parameters:
      type - a consumer that will call methods on FieldType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • campaignSetting

      CampaignAssetTemplateField.Builder campaignSetting(String campaignSetting)

      The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.

      A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

      Parameters:
      campaignSetting - The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.

      A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • campaignSetting

      CampaignAssetTemplateField.Builder campaignSetting(CampaignSetting campaignSetting)

      The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.

      A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

      Parameters:
      campaignSetting - The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.

      A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • partnerProfileField

      CampaignAssetTemplateField.Builder partnerProfileField(String partnerProfileField)

      The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.

      A client shows the field as "From your Partner Central profile" rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone; GetCampaign's Campaign$PartnerProfile carries the same three values.

      Parameters:
      partnerProfileField - The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.

      A client shows the field as "From your Partner Central profile" rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone; GetCampaign's Campaign$PartnerProfile carries the same three values.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • partnerProfileField

      CampaignAssetTemplateField.Builder partnerProfileField(PartnerProfileField partnerProfileField)

      The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.

      A client shows the field as "From your Partner Central profile" rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone; GetCampaign's Campaign$PartnerProfile carries the same three values.

      Parameters:
      partnerProfileField - The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.

      A client shows the field as "From your Partner Central profile" rather than as an input. UpdateCampaignAsset refuses a value for it with FIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone; GetCampaign's Campaign$PartnerProfile carries the same three values.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: