Package com.adobe.marketing.mobile.optimize

Class Offer

java.lang.Object
com.adobe.marketing.mobile.optimize.Offer
public class Offer extends Object

  • Method Details

    • getId

      public String getId()
      Gets the Offer identifier.
      Returns:
      String containing the Offer identifier.

    • getEtag

      public String getEtag()
      Gets the Offer etag.
      Returns:
      String containing the Offer etag.

    • getScore

      public int getScore()
      Gets the Offer score.
      Returns:
      int containing the Offer score.

    • getSchema

      public String getSchema()
      Gets the Offer schema.
      Returns:
      String containing the Offer schema.

    • getMeta

      public Map<String,Object> getMeta()
      Gets the Offer metadata.
      Returns:
      Map<String, Object> containing the Offer metadata.

    • getType

      public OfferType getType()
      Gets the Offer type.
      Returns:
      OfferType indicating the Offer type.

    • getLanguage

      public List<String> getLanguage()
      Gets the Offer language.
      Returns:
      List<String> containing the supported Offer language.

    • getContent

      public String getContent()
      Gets the Offer content.
      Returns:
      String containing the Offer content.

    • getCharacteristics

      public Map<String,String> getCharacteristics()
      Gets the Offer characteristics.
      Returns:
      Map<String, String> containing the Offer characteristics.

    • getProposition

      public OptimizeProposition getProposition()
      Gets the containing OptimizeProposition for this Offer.
      Returns:
      OptimizeProposition instance.

    • displayed

      public void displayed()
      Dispatches an event for the Edge network extension to send an Experience Event to the Edge network with the display interaction data for the given OptimizeProposition offer.
      See Also:
      • trackWithData(Map)

    • tapped

      public void tapped()
      Dispatches an event for the Edge network extension to send an Experience Event to the Edge network with the tap interaction data for the given OptimizeProposition offer.
      See Also:
      • trackWithData(Map)

    • generateDisplayInteractionXdm

      public Map<String,Object> generateDisplayInteractionXdm()
      Generates a map containing XDM formatted data for Experience Event - OptimizeProposition Interactions field group from this OptimizeProposition item.

      The returned XDM data does contain the eventType for the Experience Event with value decisioning.propositionDisplay.

      Note: The Edge sendEvent API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, and override dataset identifier.

      Returns:
      Map<String, Object> containing the XDM data for the proposition interaction.
      See Also:
      • generateInteractionXdm(String)

    • generateTapInteractionXdm

      public Map<String,Object> generateTapInteractionXdm()
      Generates a map containing XDM formatted data for Experience Event - OptimizeProposition Interactions field group from this OptimizeProposition offer.

      The returned XDM data contains the eventType for the Experience Event with value decisioning.propositionInteract.

      Note: The Edge sendEvent API can be used to dispatch this data in an Experience Event along with any additional XDM, free-form data, and override dataset identifier.

      Returns:
      Map<String, Object> containing the XDM data for the proposition interaction.
      See Also:
      • generateInteractionXdm(String)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object