Interface CampaignTemplate.Builder

  • Method Details

    • id

      The campaign template identifier.

      Parameters:
      id - The campaign template identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The display name.

      Parameters:
      name - The display name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • industry

      CampaignTemplate.Builder industry(String industry)

      Target industry for filtering or categorization.

      Parameters:
      industry - Target industry for filtering or categorization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • industry

      CampaignTemplate.Builder industry(Industry industry)

      Target industry for filtering or categorization.

      Parameters:
      industry - Target industry for filtering or categorization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • useCase

      CampaignTemplate.Builder useCase(String useCase)

      Campaign use case for filtering or categorization.

      Parameters:
      useCase - Campaign use case for filtering or categorization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CampaignTemplate.Builder description(String description)

      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.

      Parameters:
      description - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • languageCode

      CampaignTemplate.Builder languageCode(String languageCode)

      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.

      Parameters:
      languageCode - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • languageCode

      CampaignTemplate.Builder languageCode(AssetLanguage languageCode)

      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.

      Parameters:
      languageCode - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • collection

      CampaignTemplate.Builder collection(String collection)

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

      Parameters:
      collection - The browsing context the template is listed in. Every template has exactly one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • collection

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

      Parameters:
      collection - The browsing context the template is listed in. Every template has exactly one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • awsServices

      CampaignTemplate.Builder awsServices(Collection<String> awsServices)

      AWS services the template promotes.

      Parameters:
      awsServices - AWS services the template promotes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • awsServices

      CampaignTemplate.Builder awsServices(String... awsServices)

      AWS services the template promotes.

      Parameters:
      awsServices - AWS services the template promotes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegmentsWithStrings

      CampaignTemplate.Builder customerSegmentsWithStrings(Collection<String> customerSegments)

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

      Parameters:
      customerSegments - The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegmentsWithStrings

      CampaignTemplate.Builder customerSegmentsWithStrings(String... customerSegments)

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

      Parameters:
      customerSegments - The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegments

      CampaignTemplate.Builder customerSegments(Collection<CustomerSegment> customerSegments)

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

      Parameters:
      customerSegments - The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerSegments

      CampaignTemplate.Builder customerSegments(CustomerSegment... customerSegments)

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

      Parameters:
      customerSegments - The customer segments the template is written for. Absent when the template names none, in which case it matches every CustomerSegments search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themesWithStrings

      CampaignTemplate.Builder themesWithStrings(Collection<String> themes)

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

      Parameters:
      themes - The template's marketing themes. Absent when the template names none, in which case it matches every Themes search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themesWithStrings

      CampaignTemplate.Builder themesWithStrings(String... themes)

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

      Parameters:
      themes - The template's marketing themes. Absent when the template names none, in which case it matches every Themes search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themes

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

      Parameters:
      themes - The template's marketing themes. Absent when the template names none, in which case it matches every Themes search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • themes

      CampaignTemplate.Builder themes(Theme... themes)

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

      Parameters:
      themes - The template's marketing themes. Absent when the template names none, in which case it matches every Themes search filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setupDuration

      CampaignTemplate.Builder setupDuration(String setupDuration)

      Estimated setup time.

      Parameters:
      setupDuration - Estimated setup time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • thumbnailUrl

      CampaignTemplate.Builder thumbnailUrl(String thumbnailUrl)

      Thumbnail URL.

      Parameters:
      thumbnailUrl - Thumbnail URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • effectiveDateBegin

      CampaignTemplate.Builder effectiveDateBegin(Instant effectiveDateBegin)

      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.

      Parameters:
      effectiveDateBegin - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assetTemplates

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

      Parameters:
      assetTemplates - The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assetTemplates

      CampaignTemplate.Builder assetTemplates(CampaignAssetTemplate... assetTemplates)

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

      Parameters:
      assetTemplates - The ordered asset blueprints. One call serves both template browsing and server-side copy-at-create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • assetTemplates

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assetTemplates(List<CampaignAssetTemplate>).

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

      CampaignTemplate.Builder referenceMaterials(Collection<ReferenceMaterial> referenceMaterials)

      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.

      Parameters:
      referenceMaterials - 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.

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

      CampaignTemplate.Builder referenceMaterials(ReferenceMaterial... referenceMaterials)

      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.

      Parameters:
      referenceMaterials - 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.

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

      CampaignTemplate.Builder referenceMaterials(Consumer<ReferenceMaterial.Builder>... referenceMaterials)

      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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to referenceMaterials(List<ReferenceMaterial>).

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

      CampaignTemplate.Builder createdAt(Instant createdAt)

      Creation timestamp.

      Parameters:
      createdAt - Creation timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      CampaignTemplate.Builder updatedAt(Instant updatedAt)

      Last update timestamp.

      Parameters:
      updatedAt - Last update timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.