com.facebook.ads.sdk.NativeOffer Maven / Gradle / Ivy

/**
 * Copyright (c) 2015-present, Facebook, Inc. All rights reserved.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright 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.facebook.ads.sdk;

import java.io.File;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.google.common.base.Function;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;
import com.google.gson.annotations.SerializedName;
import com.google.gson.reflect.TypeToken;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;

import com.facebook.ads.sdk.APIException.MalformedResponseException;

/**
 * This class is auto-generated.
 *
 * For any issues or feature requests related to this class, please let us know
 * on github and we'll fix in our codegen framework. We'll not be able to accept
 * pull request for this class.
 *
 */
public class NativeOffer extends APINode {
  @SerializedName("barcode_photo")
  private String mBarcodePhoto = null;
  @SerializedName("barcode_photo_uri")
  private String mBarcodePhotoUri = null;
  @SerializedName("barcode_type")
  private String mBarcodeType = null;
  @SerializedName("barcode_value")
  private String mBarcodeValue = null;
  @SerializedName("block_reshares")
  private Boolean mBlockReshares = null;
  @SerializedName("details")
  private String mDetails = null;
  @SerializedName("disable_location")
  private Boolean mDisableLocation = null;
  @SerializedName("discounts")
  private List mDiscounts = null;
  @SerializedName("expiration_time")
  private String mExpirationTime = null;
  @SerializedName("id")
  private String mId = null;
  @SerializedName("instore_code")
  private String mInstoreCode = null;
  @SerializedName("location_type")
  private String mLocationType = null;
  @SerializedName("max_save_count")
  private Long mMaxSaveCount = null;
  @SerializedName("online_code")
  private String mOnlineCode = null;
  @SerializedName("page")
  private Page mPage = null;
  @SerializedName("page_set_id")
  private String mPageSetId = null;
  @SerializedName("redemption_code")
  private String mRedemptionCode = null;
  @SerializedName("redemption_link")
  private String mRedemptionLink = null;
  @SerializedName("save_count")
  private Long mSaveCount = null;
  @SerializedName("terms")
  private String mTerms = null;
  @SerializedName("title")
  private String mTitle = null;
  @SerializedName("total_unique_codes")
  private String mTotalUniqueCodes = null;
  @SerializedName("unique_codes")
  private String mUniqueCodes = null;
  @SerializedName("unique_codes_file_code_type")
  private String mUniqueCodesFileCodeType = null;
  @SerializedName("unique_codes_file_name")
  private String mUniqueCodesFileName = null;
  @SerializedName("unique_codes_file_upload_status")
  private String mUniqueCodesFileUploadStatus = null;
  protected static Gson gson = null;

  NativeOffer() {
  }

  public NativeOffer(Long id, APIContext context) {
    this(id.toString(), context);
  }

  public NativeOffer(String id, APIContext context) {
    this.mId = id;

    this.context = context;
  }

  public NativeOffer fetch() throws APIException{
    NativeOffer newInstance = fetchById(this.getPrefixedId().toString(), this.context);
    this.copyFrom(newInstance);
    return this;
  }

  public static NativeOffer fetchById(Long id, APIContext context) throws APIException {
    return fetchById(id.toString(), context);
  }

  public static ListenableFuture fetchByIdAsync(Long id, APIContext context) throws APIException {
    return fetchByIdAsync(id.toString(), context);
  }

  public static NativeOffer fetchById(String id, APIContext context) throws APIException {
    return
      new APIRequestGet(id, context)
      .requestAllFields()
      .execute();
  }

  public static ListenableFuture fetchByIdAsync(String id, APIContext context) throws APIException {
    return
      new APIRequestGet(id, context)
      .requestAllFields()
      .executeAsync();
  }

  public static APINodeList fetchByIds(List ids, List fields, APIContext context) throws APIException {
    return (APINodeList)(
      new APIRequest(context, "", "/", "GET", NativeOffer.getParser())
        .setParam("ids", APIRequest.joinStringList(ids))
        .requestFields(fields)
        .execute()
    );
  }

  public static ListenableFuture> fetchByIdsAsync(List ids, List fields, APIContext context) throws APIException {
    return
      new APIRequest(context, "", "/", "GET", NativeOffer.getParser())
        .setParam("ids", APIRequest.joinStringList(ids))
        .requestFields(fields)
        .executeAsyncBase();
  }

  private String getPrefixedId() {
    return getId();
  }

  public String getId() {
    return getFieldId().toString();
  }
  public static NativeOffer loadJSON(String json, APIContext context, String header) {
    NativeOffer nativeOffer = getGson().fromJson(json, NativeOffer.class);
    if (context.isDebug()) {
      JsonParser parser = new JsonParser();
      JsonElement o1 = parser.parse(json);
      JsonElement o2 = parser.parse(nativeOffer.toString());
      if (o1.getAsJsonObject().get("__fb_trace_id__") != null) {
        o2.getAsJsonObject().add("__fb_trace_id__", o1.getAsJsonObject().get("__fb_trace_id__"));
      }
      if (!o1.equals(o2)) {
        context.log("[Warning] When parsing response, object is not consistent with JSON:");
        context.log("[JSON]" + o1);
        context.log("[Object]" + o2);
      };
    }
    nativeOffer.context = context;
    nativeOffer.rawValue = json;
    nativeOffer.header = header;
    return nativeOffer;
  }

  public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
    APINodeList nativeOffers = new APINodeList(request, json, header);
    JsonArray arr;
    JsonObject obj;
    JsonParser parser = new JsonParser();
    Exception exception = null;
    try{
      JsonElement result = parser.parse(json);
      if (result.isJsonArray()) {
        // First, check if it's a pure JSON Array
        arr = result.getAsJsonArray();
        for (int i = 0; i < arr.size(); i++) {
          nativeOffers.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
        };
        return nativeOffers;
      } else if (result.isJsonObject()) {
        obj = result.getAsJsonObject();
        if (obj.has("data")) {
          if (obj.has("paging")) {
            JsonObject paging = obj.get("paging").getAsJsonObject();
            if (paging.has("cursors")) {
                JsonObject cursors = paging.get("cursors").getAsJsonObject();
                String before = cursors.has("before") ? cursors.get("before").getAsString() : null;
                String after = cursors.has("after") ? cursors.get("after").getAsString() : null;
                nativeOffers.setCursors(before, after);
            }
            String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
            String next = paging.has("next") ? paging.get("next").getAsString() : null;
            nativeOffers.setPaging(previous, next);
            if (context.hasAppSecret()) {
              nativeOffers.setAppSecret(context.getAppSecretProof());
            }
          }
          if (obj.get("data").isJsonArray()) {
            // Second, check if it's a JSON array with "data"
            arr = obj.get("data").getAsJsonArray();
            for (int i = 0; i < arr.size(); i++) {
              nativeOffers.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
            };
          } else if (obj.get("data").isJsonObject()) {
            // Third, check if it's a JSON object with "data"
            obj = obj.get("data").getAsJsonObject();
            boolean isRedownload = false;
            for (String s : new String[]{"campaigns", "adsets", "ads"}) {
              if (obj.has(s)) {
                isRedownload = true;
                obj = obj.getAsJsonObject(s);
                for (Map.Entry entry : obj.entrySet()) {
                  nativeOffers.add(loadJSON(entry.getValue().toString(), context, header));
                }
                break;
              }
            }
            if (!isRedownload) {
              nativeOffers.add(loadJSON(obj.toString(), context, header));
            }
          }
          return nativeOffers;
        } else if (obj.has("images")) {
          // Fourth, check if it's a map of image objects
          obj = obj.get("images").getAsJsonObject();
          for (Map.Entry entry : obj.entrySet()) {
              nativeOffers.add(loadJSON(entry.getValue().toString(), context, header));
          }
          return nativeOffers;
        } else {
          // Fifth, check if it's an array of objects indexed by id
          boolean isIdIndexedArray = true;
          for (Map.Entry entry : obj.entrySet()) {
            String key = (String) entry.getKey();
            if (key.equals("__fb_trace_id__")) {
              continue;
            }
            JsonElement value = (JsonElement) entry.getValue();
            if (
              value != null &&
              value.isJsonObject() &&
              value.getAsJsonObject().has("id") &&
              value.getAsJsonObject().get("id") != null &&
              value.getAsJsonObject().get("id").getAsString().equals(key)
            ) {
              nativeOffers.add(loadJSON(value.toString(), context, header));
            } else {
              isIdIndexedArray = false;
              break;
            }
          }
          if (isIdIndexedArray) {
            return nativeOffers;
          }

          // Sixth, check if it's pure JsonObject
          nativeOffers.clear();
          nativeOffers.add(loadJSON(json, context, header));
          return nativeOffers;
        }
      }
    } catch (Exception e) {
      exception = e;
    }
    throw new MalformedResponseException(
      "Invalid response string: " + json,
      exception
    );
  }

  @Override
  public APIContext getContext() {
    return context;
  }

  @Override
  public void setContext(APIContext context) {
    this.context = context;
  }

  @Override
  public String toString() {
    return getGson().toJson(this);
  }

  public APIRequestCreateCode createCode() {
    return new APIRequestCreateCode(this.getPrefixedId().toString(), context);
  }

  public APIRequestCreateNativeOfferView createNativeOfferView() {
    return new APIRequestCreateNativeOfferView(this.getPrefixedId().toString(), context);
  }

  public APIRequestGetViews getViews() {
    return new APIRequestGetViews(this.getPrefixedId().toString(), context);
  }

  public APIRequestGet get() {
    return new APIRequestGet(this.getPrefixedId().toString(), context);
  }


  public String getFieldBarcodePhoto() {
    return mBarcodePhoto;
  }

  public String getFieldBarcodePhotoUri() {
    return mBarcodePhotoUri;
  }

  public String getFieldBarcodeType() {
    return mBarcodeType;
  }

  public String getFieldBarcodeValue() {
    return mBarcodeValue;
  }

  public Boolean getFieldBlockReshares() {
    return mBlockReshares;
  }

  public String getFieldDetails() {
    return mDetails;
  }

  public Boolean getFieldDisableLocation() {
    return mDisableLocation;
  }

  public List getFieldDiscounts() {
    return mDiscounts;
  }

  public String getFieldExpirationTime() {
    return mExpirationTime;
  }

  public String getFieldId() {
    return mId;
  }

  public String getFieldInstoreCode() {
    return mInstoreCode;
  }

  public String getFieldLocationType() {
    return mLocationType;
  }

  public Long getFieldMaxSaveCount() {
    return mMaxSaveCount;
  }

  public String getFieldOnlineCode() {
    return mOnlineCode;
  }

  public Page getFieldPage() {
    if (mPage != null) {
      mPage.context = getContext();
    }
    return mPage;
  }

  public String getFieldPageSetId() {
    return mPageSetId;
  }

  public String getFieldRedemptionCode() {
    return mRedemptionCode;
  }

  public String getFieldRedemptionLink() {
    return mRedemptionLink;
  }

  public Long getFieldSaveCount() {
    return mSaveCount;
  }

  public String getFieldTerms() {
    return mTerms;
  }

  public String getFieldTitle() {
    return mTitle;
  }

  public String getFieldTotalUniqueCodes() {
    return mTotalUniqueCodes;
  }

  public String getFieldUniqueCodes() {
    return mUniqueCodes;
  }

  public String getFieldUniqueCodesFileCodeType() {
    return mUniqueCodesFileCodeType;
  }

  public String getFieldUniqueCodesFileName() {
    return mUniqueCodesFileName;
  }

  public String getFieldUniqueCodesFileUploadStatus() {
    return mUniqueCodesFileUploadStatus;
  }



  public static class APIRequestCreateCode extends APIRequest {

    NativeOffer lastResponse = null;
    @Override
    public NativeOffer getLastResponse() {
      return lastResponse;
    }
    public static final String[] PARAMS = {
      "unique_codes_file_code_type",
      "file",
    };

    public static final String[] FIELDS = {
    };

    @Override
    public NativeOffer parseResponse(String response, String header) throws APIException {
      return NativeOffer.parseResponse(response, getContext(), this, header).head();
    }

    @Override
    public NativeOffer execute() throws APIException {
      return execute(new HashMap());
    }

    @Override
    public NativeOffer execute(Map extraParams) throws APIException {
      ResponseWrapper rw = executeInternal(extraParams);
      lastResponse = parseResponse(rw.getBody(), rw.getHeader());
      return lastResponse;
    }

    public ListenableFuture executeAsync() throws APIException {
      return executeAsync(new HashMap());
    };

    public ListenableFuture executeAsync(Map extraParams) throws APIException {
      return Futures.transform(
        executeAsyncInternal(extraParams),
        new Function() {
           public NativeOffer apply(ResponseWrapper result) {
             try {
               return APIRequestCreateCode.this.parseResponse(result.getBody(), result.getHeader());
             } catch (Exception e) {
               throw new RuntimeException(e);
             }
           }
         }
      );
    };

    public APIRequestCreateCode(String nodeId, APIContext context) {
      super(context, nodeId, "/codes", "POST", Arrays.asList(PARAMS));
    }

    @Override
    public APIRequestCreateCode setParam(String param, Object value) {
      setParamInternal(param, value);
      return this;
    }

    @Override
    public APIRequestCreateCode setParams(Map params) {
      setParamsInternal(params);
      return this;
    }

    public APIRequestCreateCode addUploadFile (String uploadName, File file) {
      this.setParam(uploadName, file);
      return this;
    }

    public APIRequestCreateCode setUseVideoEndpoint(boolean useVideoEndpoint) {
      this.useVideoEndpoint = useVideoEndpoint;
      return this;
    }

    public APIRequestCreateCode setUniqueCodesFileCodeType (NativeOffer.EnumUniqueCodesFileCodeType uniqueCodesFileCodeType) {
      this.setParam("unique_codes_file_code_type", uniqueCodesFileCodeType);
      return this;
    }
    public APIRequestCreateCode setUniqueCodesFileCodeType (String uniqueCodesFileCodeType) {
      this.setParam("unique_codes_file_code_type", uniqueCodesFileCodeType);
      return this;
    }

    public APIRequestCreateCode requestAllFields () {
      return this.requestAllFields(true);
    }

    public APIRequestCreateCode requestAllFields (boolean value) {
      for (String field : FIELDS) {
        this.requestField(field, value);
      }
      return this;
    }

    @Override
    public APIRequestCreateCode requestFields (List fields) {
      return this.requestFields(fields, true);
    }

    @Override
    public APIRequestCreateCode requestFields (List fields, boolean value) {
      for (String field : fields) {
        this.requestField(field, value);
      }
      return this;
    }

    @Override
    public APIRequestCreateCode requestField (String field) {
      this.requestField(field, true);
      return this;
    }

    @Override
    public APIRequestCreateCode requestField (String field, boolean value) {
      this.requestFieldInternal(field, value);
      return this;
    }

  }

  public static class APIRequestCreateNativeOfferView extends APIRequest {

    NativeOffer lastResponse = null;
    @Override
    public NativeOffer getLastResponse() {
      return lastResponse;
    }
    public static final String[] PARAMS = {
      "urls",
      "photos",
      "ad_account",
      "ad_image_hashes",
      "image_crops",
      "published_ads",
      "published",
      "message",
      "place_data",
      "deeplinks",
      "carousel_captions",
      "carousel_links",
      "carousel_data",
      "videos",
    };

    public static final String[] FIELDS = {
    };

    @Override
    public NativeOffer parseResponse(String response, String header) throws APIException {
      return NativeOffer.parseResponse(response, getContext(), this, header).head();
    }

    @Override
    public NativeOffer execute() throws APIException {
      return execute(new HashMap());
    }

    @Override
    public NativeOffer execute(Map extraParams) throws APIException {
      ResponseWrapper rw = executeInternal(extraParams);
      lastResponse = parseResponse(rw.getBody(), rw.getHeader());
      return lastResponse;
    }

    public ListenableFuture executeAsync() throws APIException {
      return executeAsync(new HashMap());
    };

    public ListenableFuture executeAsync(Map extraParams) throws APIException {
      return Futures.transform(
        executeAsyncInternal(extraParams),
        new Function() {
           public NativeOffer apply(ResponseWrapper result) {
             try {
               return APIRequestCreateNativeOfferView.this.parseResponse(result.getBody(), result.getHeader());
             } catch (Exception e) {
               throw new RuntimeException(e);
             }
           }
         }
      );
    };

    public APIRequestCreateNativeOfferView(String nodeId, APIContext context) {
      super(context, nodeId, "/nativeofferviews", "POST", Arrays.asList(PARAMS));
    }

    @Override
    public APIRequestCreateNativeOfferView setParam(String param, Object value) {
      setParamInternal(param, value);
      return this;
    }

    @Override
    public APIRequestCreateNativeOfferView setParams(Map params) {
      setParamsInternal(params);
      return this;
    }


    public APIRequestCreateNativeOfferView setUrls (List urls) {
      this.setParam("urls", urls);
      return this;
    }
    public APIRequestCreateNativeOfferView setUrls (String urls) {
      this.setParam("urls", urls);
      return this;
    }

    public APIRequestCreateNativeOfferView setPhotos (List photos) {
      this.setParam("photos", photos);
      return this;
    }
    public APIRequestCreateNativeOfferView setPhotos (String photos) {
      this.setParam("photos", photos);
      return this;
    }

    public APIRequestCreateNativeOfferView setAdAccount (String adAccount) {
      this.setParam("ad_account", adAccount);
      return this;
    }

    public APIRequestCreateNativeOfferView setAdImageHashes (List adImageHashes) {
      this.setParam("ad_image_hashes", adImageHashes);
      return this;
    }
    public APIRequestCreateNativeOfferView setAdImageHashes (String adImageHashes) {
      this.setParam("ad_image_hashes", adImageHashes);
      return this;
    }

    public APIRequestCreateNativeOfferView setImageCrops (List> imageCrops) {
      this.setParam("image_crops", imageCrops);
      return this;
    }
    public APIRequestCreateNativeOfferView setImageCrops (String imageCrops) {
      this.setParam("image_crops", imageCrops);
      return this;
    }

    public APIRequestCreateNativeOfferView setPublishedAds (Boolean publishedAds) {
      this.setParam("published_ads", publishedAds);
      return this;
    }
    public APIRequestCreateNativeOfferView setPublishedAds (String publishedAds) {
      this.setParam("published_ads", publishedAds);
      return this;
    }

    public APIRequestCreateNativeOfferView setPublished (Boolean published) {
      this.setParam("published", published);
      return this;
    }
    public APIRequestCreateNativeOfferView setPublished (String published) {
      this.setParam("published", published);
      return this;
    }

    public APIRequestCreateNativeOfferView setMessage (String message) {
      this.setParam("message", message);
      return this;
    }

    public APIRequestCreateNativeOfferView setPlaceData (Object placeData) {
      this.setParam("place_data", placeData);
      return this;
    }
    public APIRequestCreateNativeOfferView setPlaceData (String placeData) {
      this.setParam("place_data", placeData);
      return this;
    }

    public APIRequestCreateNativeOfferView setDeeplinks (List deeplinks) {
      this.setParam("deeplinks", deeplinks);
      return this;
    }
    public APIRequestCreateNativeOfferView setDeeplinks (String deeplinks) {
      this.setParam("deeplinks", deeplinks);
      return this;
    }

    public APIRequestCreateNativeOfferView setCarouselCaptions (List carouselCaptions) {
      this.setParam("carousel_captions", carouselCaptions);
      return this;
    }
    public APIRequestCreateNativeOfferView setCarouselCaptions (String carouselCaptions) {
      this.setParam("carousel_captions", carouselCaptions);
      return this;
    }

    public APIRequestCreateNativeOfferView setCarouselLinks (List carouselLinks) {
      this.setParam("carousel_links", carouselLinks);
      return this;
    }
    public APIRequestCreateNativeOfferView setCarouselLinks (String carouselLinks) {
      this.setParam("carousel_links", carouselLinks);
      return this;
    }

    public APIRequestCreateNativeOfferView setCarouselData (List