// Generated by delombok at Tue Jun 03 09:05:42 UTC 2025
/*
 * Copyright (c) 2010-2025 Mark Allen, Norbert Bartels.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.restfb.types.ads;

import java.util.List;
import com.restfb.Facebook;

/**
 * Represents the <a href="https://developers.facebook.com/docs/marketing-api/adcreative/">AdGroup Creative type</a>.
 */
public class AdCreative extends NamedAdsObject {
  private static final long serialVersionUID = 1L;
  /**
   * The actor ID (Page ID) of this creative.
   *
   * This field is available only for mobile app ads created before 2015
   */
  @Facebook("actor_id")
  private String actorId;
  /**
   * The image used for actor's icon.
   *
   * This field is available only for mobile app ads created before 2015
   */
  @Facebook("actor_image_hash")
  private String actorImageHash;
  /**
   * The URL of the icon for the actor (Page ID) of this creative.
   *
   * This field is only available for mobile app ads created before 2015
   */
  @Facebook("actor_image_url")
  private String actorImageUrl;
  /**
   * The title text used for actor.
   *
   * This field is available only for mobile app ads created before 2015
   */
  @Facebook("actor_name")
  private String actorName;
  /**
   * Ad Labels that are associated with this creative
   */
  @Facebook("adlabels")
  private List<AdLabel> adlabels;
  /**
   * Deep link fallback behavior for dynamic product ads if the app is not installed.
   */
  @Facebook("applink_treatment")
  private String applinkTreatment;
  /**
   * Used for Dynamic Creative to automatically experiment and deliver different variations of an ad's creative.
   */
  @Facebook("asset_feed_spec")
  private AdAssetFeedSpec assetFeedSpec;
  /**
   * The body of the ad
   */
  @Facebook
  private String body;
  /**
   * The call to action button text and header text of legacy ads.
   */
  @Facebook("call_to_action_type")
  private String callToActionType;
  /**
   * A JSON object defining crop dimensions for the image specified.
   *
   * See image crop reference for more details
   */
  @Facebook("image_crops")
  private AdsImageCrops imageCrops;
  /**
   * Image hash for an image you can use in creatives.
   *
   * See image library for more details
   */
  @Facebook("image_hash")
  private String imageHash;
  /**
   * A URL for the image for this creative.
   *
   * The image specified at this URL will be saved into the ad account's image library
   */
  @Facebook("image_url")
  private String imageUrl;
  /**
   * Instagram actor ID
   */
  @Deprecated
  @Facebook("instagram_actor_id")
  private String instagramActorId;
  /**
   * Instagram user ID
   */
  @Facebook("instagram_user_id")
  private String instagramUserId;
  /**
   * Instagram permalink
   */
  @Facebook("instagram_permalink_url")
  private String instagramPermalinkUrl;
  /**
   * Instagram Story ID
   *
   * -- GETTER
   */
  @Facebook("instagram_story_id")
  private String instagramStoryId;
  @Facebook("interactive_components_spec")
  private AdCreativeInteractiveComponentsSpec interactiveComponentsSpec;
  /**
   * The Open Graph (OG) ID for the link in this creative if the landing page has OG tags
   */
  @Facebook("link_og_id")
  private String linkOgId;
  /**
   * Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
   *
   * See connection objects for retrieving Page tabs' URLs. app_data parameters may be added to the url to pass data to
   * a tab app
   */
  @Facebook("link_url")
  private String linkUrl;
  /**
   * The ID of the promoted_object or object that is relevant to the ad and ad type
   */
  @Facebook("object_id")
  private String objectId;
  /**
   * The ID of a page post to use in an ad.
   *
   * This ID can be retrieved by using the graph API to query the posts of the page. If an image is used in the post, it
   * will be downloaded and available in your account's image library
   */
  @Facebook("object_story_id")
  private String objectStoryId;
  /**
   * The page id and the content to create a new unpublished page post specified using one of link_data, photo_data,
   * video_data, offer_data, text_data or template_data
   */
  @Facebook("object_story_spec")
  private AdCreativeObjectStorySpec objectStorySpec;
  /**
   * The type of object that is being advertised.
   *
   * Allowed values are:
   * <ul>
   * <li>PAGE</li>
   * <li>DOMAIN</li>
   * <li>EVENT</li>
   * <li>STORE_ITEM: refers to an iTunes or Google Play store destination</li>
   * <li>OFFER</li>
   * <li>SHARE: from a page</li>
   * <li>PHOTO</li>
   * <li>STATUS: of a page</li>
   * <li>VIDEO</li>
   * <li>APPLICATION: app on Facebook</li>
   * <li>INVALID: when an invalid object_id was specified such as a deleted object or if you do not have permission to
   * see the object. In very few cases, this field may be empty if Facebook is unable to identify the type of advertised
   * object</li>
   * </ul>
   */
  @Facebook("object_type")
  private String objectType;
  /**
   * Destination URL for a link ads not connected to a page
   */
  @Facebook("object_url")
  private String objectUrl;
  /**
   * Use this field to customize the media for different Facebook placements.
   *
   * Currently you can use this field for customizing images only. The media specified here replaces the original media
   * defined in the ad creative when the ad displays on those placements. For example, if you define a media here for
   * the instagram key, Facebook uses that media instead of the media defined in the ad creative when showing the ad on
   * Instagram.
   */
  @Facebook("platform_customizations")
  private String platformCustomizations;
  /**
   * The ID of the product set for this creative. See dynamic product ads for more detail
   */
  @Facebook("product_set_id")
  private String productSetId;
  @Facebook("source_instagram_media_id")
  private String sourceInstagramMediaId;
  /**
   * The run status of this creative.
   *
   * Allowed values are:
   * <ul>
   * <li>ACTIVE</li>
   * <li>DELETED</li>
   * </ul>
   */
  @Facebook("run_status")
  private String runStatus;
  /**
   * The Tracking URL for dynamic product ads.
   *
   * See dynamic product ads for more detail
   */
  @Facebook("template_url")
  private String templateUrl;
  /**
   * The URL to a thumbnail for this creative.
   *
   * You can optionally request dimensions of this thumbnail by providing the thumbnail_width and thumbnail_height
   * parameters. See example for more detail
   */
  @Facebook("thumbnail_url")
  private String thumbnailUrl;
  /**
   * Title for a link ad (not connected to a Page)
   */
  @Facebook("title")
  private String title;
  /**
   * A set of query string parameters which will replace or be appended to urls clicked from page post ads, and canvas
   * app install creatives only
   */
  @Facebook("url_tags")
  private String urlTags;
  @Facebook("use_page_actor_override")
  private Boolean usePageActorOverride;
  @Facebook("video_id")
  private String videoId;
  @Facebook("creative_id")
  private String creativeId;

  /**
   * @return The actor ID (Page ID) of this creative.
   */
  @java.lang.SuppressWarnings("all")
  public String getActorId() {
    return this.actorId;
  }

  /**
   * The actor ID (Page ID) of this creative.
   *
   * This field is available only for mobile app ads created before 2015
   */
  @java.lang.SuppressWarnings("all")
  public void setActorId(final String actorId) {
    this.actorId = actorId;
  }

  /**
   * @return The image used for actor's icon.
   */
  @java.lang.SuppressWarnings("all")
  public String getActorImageHash() {
    return this.actorImageHash;
  }

  /**
   * The image used for actor's icon.
   *
   * This field is available only for mobile app ads created before 2015
   */
  @java.lang.SuppressWarnings("all")
  public void setActorImageHash(final String actorImageHash) {
    this.actorImageHash = actorImageHash;
  }

  /**
   * @return The URL of the icon for the actor (Page ID) of this creative.
   */
  @java.lang.SuppressWarnings("all")
  public String getActorImageUrl() {
    return this.actorImageUrl;
  }

  /**
   * The URL of the icon for the actor (Page ID) of this creative.
   *
   * This field is only available for mobile app ads created before 2015
   */
  @java.lang.SuppressWarnings("all")
  public void setActorImageUrl(final String actorImageUrl) {
    this.actorImageUrl = actorImageUrl;
  }

  /**
   * @return The title text used for actor.
   */
  @java.lang.SuppressWarnings("all")
  public String getActorName() {
    return this.actorName;
  }

  /**
   * The title text used for actor.
   *
   * This field is available only for mobile app ads created before 2015
   */
  @java.lang.SuppressWarnings("all")
  public void setActorName(final String actorName) {
    this.actorName = actorName;
  }

  /**
   * @return Ad Labels that are associated with this creative
   */
  @java.lang.SuppressWarnings("all")
  public List<AdLabel> getAdlabels() {
    return this.adlabels;
  }

  /**
   * Ad Labels that are associated with this creative
   */
  @java.lang.SuppressWarnings("all")
  public void setAdlabels(final List<AdLabel> adlabels) {
    this.adlabels = adlabels;
  }

  /**
   * Deep link fallback behavior for dynamic product ads if the app is not installed.
   */
  @java.lang.SuppressWarnings("all")
  public String getApplinkTreatment() {
    return this.applinkTreatment;
  }

  /**
   * Deep link fallback behavior for dynamic product ads if the app is not installed.
   */
  @java.lang.SuppressWarnings("all")
  public void setApplinkTreatment(final String applinkTreatment) {
    this.applinkTreatment = applinkTreatment;
  }

  /**
   * Used for Dynamic Creative to automatically experiment and deliver different variations of an ad's creative.
   */
  @java.lang.SuppressWarnings("all")
  public AdAssetFeedSpec getAssetFeedSpec() {
    return this.assetFeedSpec;
  }

  /**
   * Used for Dynamic Creative to automatically experiment and deliver different variations of an ad's creative.
   */
  @java.lang.SuppressWarnings("all")
  public void setAssetFeedSpec(final AdAssetFeedSpec assetFeedSpec) {
    this.assetFeedSpec = assetFeedSpec;
  }

  /**
   * @return The body of the ad
   */
  @java.lang.SuppressWarnings("all")
  public String getBody() {
    return this.body;
  }

  /**
   * The body of the ad
   */
  @java.lang.SuppressWarnings("all")
  public void setBody(final String body) {
    this.body = body;
  }

  /**
   * @return The call to action button text and header text of legacy ads.
   */
  @java.lang.SuppressWarnings("all")
  public String getCallToActionType() {
    return this.callToActionType;
  }

  /**
   * The call to action button text and header text of legacy ads.
   */
  @java.lang.SuppressWarnings("all")
  public void setCallToActionType(final String callToActionType) {
    this.callToActionType = callToActionType;
  }

  /**
   * @return A JSON object defining crop dimensions for the image specified.
   */
  @java.lang.SuppressWarnings("all")
  public AdsImageCrops getImageCrops() {
    return this.imageCrops;
  }

  /**
   * A JSON object defining crop dimensions for the image specified.
   *
   * See image crop reference for more details
   */
  @java.lang.SuppressWarnings("all")
  public void setImageCrops(final AdsImageCrops imageCrops) {
    this.imageCrops = imageCrops;
  }

  /**
   * @return Image hash for an image you can use in creatives.
   */
  @java.lang.SuppressWarnings("all")
  public String getImageHash() {
    return this.imageHash;
  }

  /**
   * Image hash for an image you can use in creatives.
   *
   * See image library for more details
   */
  @java.lang.SuppressWarnings("all")
  public void setImageHash(final String imageHash) {
    this.imageHash = imageHash;
  }

  /**
   * @return A URL for the image for this creative.
   */
  @java.lang.SuppressWarnings("all")
  public String getImageUrl() {
    return this.imageUrl;
  }

  /**
   * A URL for the image for this creative.
   *
   * The image specified at this URL will be saved into the ad account's image library
   */
  @java.lang.SuppressWarnings("all")
  public void setImageUrl(final String imageUrl) {
    this.imageUrl = imageUrl;
  }

  /**
   * @return Instagram actor ID
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public String getInstagramActorId() {
    return this.instagramActorId;
  }

  /**
   * Instagram actor ID
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public void setInstagramActorId(final String instagramActorId) {
    this.instagramActorId = instagramActorId;
  }

  /**
   * @return Instagram user ID
   */
  @java.lang.SuppressWarnings("all")
  public String getInstagramUserId() {
    return this.instagramUserId;
  }

  /**
   * Instagram user ID
   */
  @java.lang.SuppressWarnings("all")
  public void setInstagramUserId(final String instagramUserId) {
    this.instagramUserId = instagramUserId;
  }

  /**
   * @return Instagram permalink
   */
  @java.lang.SuppressWarnings("all")
  public String getInstagramPermalinkUrl() {
    return this.instagramPermalinkUrl;
  }

  /**
   * Instagram permalink
   */
  @java.lang.SuppressWarnings("all")
  public void setInstagramPermalinkUrl(final String instagramPermalinkUrl) {
    this.instagramPermalinkUrl = instagramPermalinkUrl;
  }

  /**
   * Instagram Story ID
   *
   * -- GETTER
   *
   * @return Instagram Story ID
   */
  @java.lang.SuppressWarnings("all")
  public String getInstagramStoryId() {
    return this.instagramStoryId;
  }

  /**
   * Instagram Story ID
   *
   * -- GETTER
   */
  @java.lang.SuppressWarnings("all")
  public void setInstagramStoryId(final String instagramStoryId) {
    this.instagramStoryId = instagramStoryId;
  }

  @java.lang.SuppressWarnings("all")
  public AdCreativeInteractiveComponentsSpec getInteractiveComponentsSpec() {
    return this.interactiveComponentsSpec;
  }

  @java.lang.SuppressWarnings("all")
  public void setInteractiveComponentsSpec(final AdCreativeInteractiveComponentsSpec interactiveComponentsSpec) {
    this.interactiveComponentsSpec = interactiveComponentsSpec;
  }

  /**
   * @return The Open Graph (OG) ID for the link in this creative if the landing page has OG tags
   */
  @java.lang.SuppressWarnings("all")
  public String getLinkOgId() {
    return this.linkOgId;
  }

  /**
   * The Open Graph (OG) ID for the link in this creative if the landing page has OG tags
   */
  @java.lang.SuppressWarnings("all")
  public void setLinkOgId(final String linkOgId) {
    this.linkOgId = linkOgId;
  }

  /**
   * @return Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
   */
  @java.lang.SuppressWarnings("all")
  public String getLinkUrl() {
    return this.linkUrl;
  }

  /**
   * Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
   *
   * See connection objects for retrieving Page tabs' URLs. app_data parameters may be added to the url to pass data to
   * a tab app
   */
  @java.lang.SuppressWarnings("all")
  public void setLinkUrl(final String linkUrl) {
    this.linkUrl = linkUrl;
  }

  /**
   * @return The ID of the promoted_object or object that is relevant to the ad and ad type
   */
  @java.lang.SuppressWarnings("all")
  public String getObjectId() {
    return this.objectId;
  }

  /**
   * The ID of the promoted_object or object that is relevant to the ad and ad type
   */
  @java.lang.SuppressWarnings("all")
  public void setObjectId(final String objectId) {
    this.objectId = objectId;
  }

  /**
   * @return The ID of a page post to use in an ad.
   */
  @java.lang.SuppressWarnings("all")
  public String getObjectStoryId() {
    return this.objectStoryId;
  }

  /**
   * The ID of a page post to use in an ad.
   *
   * This ID can be retrieved by using the graph API to query the posts of the page. If an image is used in the post, it
   * will be downloaded and available in your account's image library
   */
  @java.lang.SuppressWarnings("all")
  public void setObjectStoryId(final String objectStoryId) {
    this.objectStoryId = objectStoryId;
  }

  /**
   * @return The page id and the content to create a new unpublished page post
   */
  @java.lang.SuppressWarnings("all")
  public AdCreativeObjectStorySpec getObjectStorySpec() {
    return this.objectStorySpec;
  }

  /**
   * The page id and the content to create a new unpublished page post specified using one of link_data, photo_data,
   * video_data, offer_data, text_data or template_data
   */
  @java.lang.SuppressWarnings("all")
  public void setObjectStorySpec(final AdCreativeObjectStorySpec objectStorySpec) {
    this.objectStorySpec = objectStorySpec;
  }

  /**
   * @return The type of object that is being advertised.
   */
  @java.lang.SuppressWarnings("all")
  public String getObjectType() {
    return this.objectType;
  }

  /**
   * The type of object that is being advertised.
   *
   * Allowed values are:
   * <ul>
   * <li>PAGE</li>
   * <li>DOMAIN</li>
   * <li>EVENT</li>
   * <li>STORE_ITEM: refers to an iTunes or Google Play store destination</li>
   * <li>OFFER</li>
   * <li>SHARE: from a page</li>
   * <li>PHOTO</li>
   * <li>STATUS: of a page</li>
   * <li>VIDEO</li>
   * <li>APPLICATION: app on Facebook</li>
   * <li>INVALID: when an invalid object_id was specified such as a deleted object or if you do not have permission to
   * see the object. In very few cases, this field may be empty if Facebook is unable to identify the type of advertised
   * object</li>
   * </ul>
   */
  @java.lang.SuppressWarnings("all")
  public void setObjectType(final String objectType) {
    this.objectType = objectType;
  }

  /**
   * @return Destination URL for a link ads not connected to a page
   */
  @java.lang.SuppressWarnings("all")
  public String getObjectUrl() {
    return this.objectUrl;
  }

  /**
   * Destination URL for a link ads not connected to a page
   */
  @java.lang.SuppressWarnings("all")
  public void setObjectUrl(final String objectUrl) {
    this.objectUrl = objectUrl;
  }

  /**
   * @return Use this field to customize the media for different Facebook placements.
   */
  @java.lang.SuppressWarnings("all")
  public String getPlatformCustomizations() {
    return this.platformCustomizations;
  }

  /**
   * Use this field to customize the media for different Facebook placements.
   *
   * Currently you can use this field for customizing images only. The media specified here replaces the original media
   * defined in the ad creative when the ad displays on those placements. For example, if you define a media here for
   * the instagram key, Facebook uses that media instead of the media defined in the ad creative when showing the ad on
   * Instagram.
   */
  @java.lang.SuppressWarnings("all")
  public void setPlatformCustomizations(final String platformCustomizations) {
    this.platformCustomizations = platformCustomizations;
  }

  /**
   * @return The ID of the product set for this creative. See dynamic product ads for more detail
   */
  @java.lang.SuppressWarnings("all")
  public String getProductSetId() {
    return this.productSetId;
  }

  /**
   * The ID of the product set for this creative. See dynamic product ads for more detail
   */
  @java.lang.SuppressWarnings("all")
  public void setProductSetId(final String productSetId) {
    this.productSetId = productSetId;
  }

  @java.lang.SuppressWarnings("all")
  public String getSourceInstagramMediaId() {
    return this.sourceInstagramMediaId;
  }

  @java.lang.SuppressWarnings("all")
  public void setSourceInstagramMediaId(final String sourceInstagramMediaId) {
    this.sourceInstagramMediaId = sourceInstagramMediaId;
  }

  /**
   * @return The run status of this creative.
   */
  @java.lang.SuppressWarnings("all")
  public String getRunStatus() {
    return this.runStatus;
  }

  /**
   * The run status of this creative.
   *
   * Allowed values are:
   * <ul>
   * <li>ACTIVE</li>
   * <li>DELETED</li>
   * </ul>
   */
  @java.lang.SuppressWarnings("all")
  public void setRunStatus(final String runStatus) {
    this.runStatus = runStatus;
  }

  /**
   * @return The Tracking URL for dynamic product ads.
   */
  @java.lang.SuppressWarnings("all")
  public String getTemplateUrl() {
    return this.templateUrl;
  }

  /**
   * The Tracking URL for dynamic product ads.
   *
   * See dynamic product ads for more detail
   */
  @java.lang.SuppressWarnings("all")
  public void setTemplateUrl(final String templateUrl) {
    this.templateUrl = templateUrl;
  }

  /**
   * @return The URL to a thumbnail for this creative.
   */
  @java.lang.SuppressWarnings("all")
  public String getThumbnailUrl() {
    return this.thumbnailUrl;
  }

  /**
   * The URL to a thumbnail for this creative.
   *
   * You can optionally request dimensions of this thumbnail by providing the thumbnail_width and thumbnail_height
   * parameters. See example for more detail
   */
  @java.lang.SuppressWarnings("all")
  public void setThumbnailUrl(final String thumbnailUrl) {
    this.thumbnailUrl = thumbnailUrl;
  }

  /**
   * @return Title for a link ad (not connected to a Page)
   */
  @java.lang.SuppressWarnings("all")
  public String getTitle() {
    return this.title;
  }

  /**
   * Title for a link ad (not connected to a Page)
   */
  @java.lang.SuppressWarnings("all")
  public void setTitle(final String title) {
    this.title = title;
  }

  /**
   * @return A set of query string parameters
   */
  @java.lang.SuppressWarnings("all")
  public String getUrlTags() {
    return this.urlTags;
  }

  /**
   * A set of query string parameters which will replace or be appended to urls clicked from page post ads, and canvas
   * app install creatives only
   */
  @java.lang.SuppressWarnings("all")
  public void setUrlTags(final String urlTags) {
    this.urlTags = urlTags;
  }

  @java.lang.SuppressWarnings("all")
  public Boolean getUsePageActorOverride() {
    return this.usePageActorOverride;
  }

  @java.lang.SuppressWarnings("all")
  public void setUsePageActorOverride(final Boolean usePageActorOverride) {
    this.usePageActorOverride = usePageActorOverride;
  }

  @java.lang.SuppressWarnings("all")
  public String getVideoId() {
    return this.videoId;
  }

  @java.lang.SuppressWarnings("all")
  public void setVideoId(final String videoId) {
    this.videoId = videoId;
  }

  @java.lang.SuppressWarnings("all")
  public String getCreativeId() {
    return this.creativeId;
  }

  @java.lang.SuppressWarnings("all")
  public void setCreativeId(final String creativeId) {
    this.creativeId = creativeId;
  }
}