com.facebook.ads.sdk.AdCreativeLinkData.java Source code

Java tutorial

Introduction

Here is the source code for com.facebook.ads.sdk.AdCreativeLinkData.java

Source

/**
 * 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.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-genereated.
 *
 * 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 AdCreativeLinkData extends APINode {
    @SerializedName("additional_image_index")
    private Long mAdditionalImageIndex = null;
    @SerializedName("app_link_spec")
    private AdCreativeLinkDataAppLinkSpec mAppLinkSpec = null;
    @SerializedName("attachment_style")
    private EnumAttachmentStyle mAttachmentStyle = null;
    @SerializedName("branded_content_sponsor_page_id")
    private String mBrandedContentSponsorPageId = null;
    @SerializedName("branded_content_sponsor_relationship")
    private String mBrandedContentSponsorRelationship = null;
    @SerializedName("call_to_action")
    private AdCreativeLinkDataCallToAction mCallToAction = null;
    @SerializedName("caption")
    private String mCaption = null;
    @SerializedName("child_attachments")
    private List<AdCreativeLinkDataChildAttachment> mChildAttachments = null;
    @SerializedName("description")
    private String mDescription = null;
    @SerializedName("event_id")
    private String mEventId = null;
    @SerializedName("force_single_link")
    private Boolean mForceSingleLink = null;
    @SerializedName("image_crops")
    private AdsImageCrops mImageCrops = null;
    @SerializedName("image_hash")
    private String mImageHash = null;
    @SerializedName("link")
    private String mLink = null;
    @SerializedName("message")
    private String mMessage = null;
    @SerializedName("multi_share_end_card")
    private Boolean mMultiShareEndCard = null;
    @SerializedName("multi_share_optimized")
    private Boolean mMultiShareOptimized = null;
    @SerializedName("name")
    private String mName = null;
    @SerializedName("offer_id")
    private String mOfferId = null;
    @SerializedName("page_welcome_message")
    private String mPageWelcomeMessage = null;
    @SerializedName("picture")
    private String mPicture = null;
    protected static Gson gson = null;

    public AdCreativeLinkData() {
    }

    public String getId() {
        return null;
    }

    public static AdCreativeLinkData loadJSON(String json, APIContext context) {
        AdCreativeLinkData adCreativeLinkData = getGson().fromJson(json, AdCreativeLinkData.class);
        if (context.isDebug()) {
            JsonParser parser = new JsonParser();
            JsonElement o1 = parser.parse(json);
            JsonElement o2 = parser.parse(adCreativeLinkData.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);
            }
            ;
        }
        adCreativeLinkData.context = context;
        adCreativeLinkData.rawValue = json;
        return adCreativeLinkData;
    }

    public static APINodeList<AdCreativeLinkData> parseResponse(String json, APIContext context, APIRequest request)
            throws MalformedResponseException {
        APINodeList<AdCreativeLinkData> adCreativeLinkDatas = new APINodeList<AdCreativeLinkData>(request, json);
        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++) {
                    adCreativeLinkDatas.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context));
                }
                ;
                return adCreativeLinkDatas;
            } else if (result.isJsonObject()) {
                obj = result.getAsJsonObject();
                if (obj.has("data")) {
                    if (obj.has("paging")) {
                        JsonObject paging = obj.get("paging").getAsJsonObject().get("cursors").getAsJsonObject();
                        String before = paging.has("before") ? paging.get("before").getAsString() : null;
                        String after = paging.has("after") ? paging.get("after").getAsString() : null;
                        adCreativeLinkDatas.setPaging(before, after);
                    }
                    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++) {
                            adCreativeLinkDatas.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context));
                        }
                        ;
                    } 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<String, JsonElement> entry : obj.entrySet()) {
                                    adCreativeLinkDatas.add(loadJSON(entry.getValue().toString(), context));
                                }
                                break;
                            }
                        }
                        if (!isRedownload) {
                            adCreativeLinkDatas.add(loadJSON(obj.toString(), context));
                        }
                    }
                    return adCreativeLinkDatas;
                } else if (obj.has("images")) {
                    // Fourth, check if it's a map of image objects
                    obj = obj.get("images").getAsJsonObject();
                    for (Map.Entry<String, JsonElement> entry : obj.entrySet()) {
                        adCreativeLinkDatas.add(loadJSON(entry.getValue().toString(), context));
                    }
                    return adCreativeLinkDatas;
                } 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)) {
                            adCreativeLinkDatas.add(loadJSON(value.toString(), context));
                        } else {
                            isIdIndexedArray = false;
                            break;
                        }
                    }
                    if (isIdIndexedArray) {
                        return adCreativeLinkDatas;
                    }

                    // Sixth, check if it's pure JsonObject
                    adCreativeLinkDatas.clear();
                    adCreativeLinkDatas.add(loadJSON(json, context));
                    return adCreativeLinkDatas;
                }
            }
        } 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 Long getFieldAdditionalImageIndex() {
        return mAdditionalImageIndex;
    }

    public AdCreativeLinkData setFieldAdditionalImageIndex(Long value) {
        this.mAdditionalImageIndex = value;
        return this;
    }

    public AdCreativeLinkDataAppLinkSpec getFieldAppLinkSpec() {
        return mAppLinkSpec;
    }

    public AdCreativeLinkData setFieldAppLinkSpec(AdCreativeLinkDataAppLinkSpec value) {
        this.mAppLinkSpec = value;
        return this;
    }

    public AdCreativeLinkData setFieldAppLinkSpec(String value) {
        Type type = new TypeToken<AdCreativeLinkDataAppLinkSpec>() {
        }.getType();
        this.mAppLinkSpec = AdCreativeLinkDataAppLinkSpec.getGson().fromJson(value, type);
        return this;
    }

    public EnumAttachmentStyle getFieldAttachmentStyle() {
        return mAttachmentStyle;
    }

    public AdCreativeLinkData setFieldAttachmentStyle(EnumAttachmentStyle value) {
        this.mAttachmentStyle = value;
        return this;
    }

    public String getFieldBrandedContentSponsorPageId() {
        return mBrandedContentSponsorPageId;
    }

    public AdCreativeLinkData setFieldBrandedContentSponsorPageId(String value) {
        this.mBrandedContentSponsorPageId = value;
        return this;
    }

    public String getFieldBrandedContentSponsorRelationship() {
        return mBrandedContentSponsorRelationship;
    }

    public AdCreativeLinkData setFieldBrandedContentSponsorRelationship(String value) {
        this.mBrandedContentSponsorRelationship = value;
        return this;
    }

    public AdCreativeLinkDataCallToAction getFieldCallToAction() {
        return mCallToAction;
    }

    public AdCreativeLinkData setFieldCallToAction(AdCreativeLinkDataCallToAction value) {
        this.mCallToAction = value;
        return this;
    }

    public AdCreativeLinkData setFieldCallToAction(String value) {
        Type type = new TypeToken<AdCreativeLinkDataCallToAction>() {
        }.getType();
        this.mCallToAction = AdCreativeLinkDataCallToAction.getGson().fromJson(value, type);
        return this;
    }

    public String getFieldCaption() {
        return mCaption;
    }

    public AdCreativeLinkData setFieldCaption(String value) {
        this.mCaption = value;
        return this;
    }

    public List<AdCreativeLinkDataChildAttachment> getFieldChildAttachments() {
        return mChildAttachments;
    }

    public AdCreativeLinkData setFieldChildAttachments(List<AdCreativeLinkDataChildAttachment> value) {
        this.mChildAttachments = value;
        return this;
    }

    public AdCreativeLinkData setFieldChildAttachments(String value) {
        Type type = new TypeToken<List<AdCreativeLinkDataChildAttachment>>() {
        }.getType();
        this.mChildAttachments = AdCreativeLinkDataChildAttachment.getGson().fromJson(value, type);
        return this;
    }

    public String getFieldDescription() {
        return mDescription;
    }

    public AdCreativeLinkData setFieldDescription(String value) {
        this.mDescription = value;
        return this;
    }

    public String getFieldEventId() {
        return mEventId;
    }

    public AdCreativeLinkData setFieldEventId(String value) {
        this.mEventId = value;
        return this;
    }

    public Boolean getFieldForceSingleLink() {
        return mForceSingleLink;
    }

    public AdCreativeLinkData setFieldForceSingleLink(Boolean value) {
        this.mForceSingleLink = value;
        return this;
    }

    public AdsImageCrops getFieldImageCrops() {
        return mImageCrops;
    }

    public AdCreativeLinkData setFieldImageCrops(AdsImageCrops value) {
        this.mImageCrops = value;
        return this;
    }

    public AdCreativeLinkData setFieldImageCrops(String value) {
        Type type = new TypeToken<AdsImageCrops>() {
        }.getType();
        this.mImageCrops = AdsImageCrops.getGson().fromJson(value, type);
        return this;
    }

    public String getFieldImageHash() {
        return mImageHash;
    }

    public AdCreativeLinkData setFieldImageHash(String value) {
        this.mImageHash = value;
        return this;
    }

    public String getFieldLink() {
        return mLink;
    }

    public AdCreativeLinkData setFieldLink(String value) {
        this.mLink = value;
        return this;
    }

    public String getFieldMessage() {
        return mMessage;
    }

    public AdCreativeLinkData setFieldMessage(String value) {
        this.mMessage = value;
        return this;
    }

    public Boolean getFieldMultiShareEndCard() {
        return mMultiShareEndCard;
    }

    public AdCreativeLinkData setFieldMultiShareEndCard(Boolean value) {
        this.mMultiShareEndCard = value;
        return this;
    }

    public Boolean getFieldMultiShareOptimized() {
        return mMultiShareOptimized;
    }

    public AdCreativeLinkData setFieldMultiShareOptimized(Boolean value) {
        this.mMultiShareOptimized = value;
        return this;
    }

    public String getFieldName() {
        return mName;
    }

    public AdCreativeLinkData setFieldName(String value) {
        this.mName = value;
        return this;
    }

    public String getFieldOfferId() {
        return mOfferId;
    }

    public AdCreativeLinkData setFieldOfferId(String value) {
        this.mOfferId = value;
        return this;
    }

    public String getFieldPageWelcomeMessage() {
        return mPageWelcomeMessage;
    }

    public AdCreativeLinkData setFieldPageWelcomeMessage(String value) {
        this.mPageWelcomeMessage = value;
        return this;
    }

    public String getFieldPicture() {
        return mPicture;
    }

    public AdCreativeLinkData setFieldPicture(String value) {
        this.mPicture = value;
        return this;
    }

    public static enum EnumAttachmentStyle {
        @SerializedName("link")
        VALUE_LINK("link"), @SerializedName("default")
        VALUE_DEFAULT("default"), NULL(null);

        private String value;

        private EnumAttachmentStyle(String value) {
            this.value = value;
        }

        @Override
        public String toString() {
            return value;
        }
    }

    synchronized /*package*/ static Gson getGson() {
        if (gson != null) {
            return gson;
        } else {
            gson = new GsonBuilder().excludeFieldsWithModifiers(Modifier.STATIC)
                    .excludeFieldsWithModifiers(Modifier.PROTECTED).disableHtmlEscaping().create();
        }
        return gson;
    }

    public AdCreativeLinkData copyFrom(AdCreativeLinkData instance) {
        this.mAdditionalImageIndex = instance.mAdditionalImageIndex;
        this.mAppLinkSpec = instance.mAppLinkSpec;
        this.mAttachmentStyle = instance.mAttachmentStyle;
        this.mBrandedContentSponsorPageId = instance.mBrandedContentSponsorPageId;
        this.mBrandedContentSponsorRelationship = instance.mBrandedContentSponsorRelationship;
        this.mCallToAction = instance.mCallToAction;
        this.mCaption = instance.mCaption;
        this.mChildAttachments = instance.mChildAttachments;
        this.mDescription = instance.mDescription;
        this.mEventId = instance.mEventId;
        this.mForceSingleLink = instance.mForceSingleLink;
        this.mImageCrops = instance.mImageCrops;
        this.mImageHash = instance.mImageHash;
        this.mLink = instance.mLink;
        this.mMessage = instance.mMessage;
        this.mMultiShareEndCard = instance.mMultiShareEndCard;
        this.mMultiShareOptimized = instance.mMultiShareOptimized;
        this.mName = instance.mName;
        this.mOfferId = instance.mOfferId;
        this.mPageWelcomeMessage = instance.mPageWelcomeMessage;
        this.mPicture = instance.mPicture;
        this.context = instance.context;
        this.rawValue = instance.rawValue;
        return this;
    }

    public static APIRequest.ResponseParser<AdCreativeLinkData> getParser() {
        return new APIRequest.ResponseParser<AdCreativeLinkData>() {
            public APINodeList<AdCreativeLinkData> parseResponse(String response, APIContext context,
                    APIRequest<AdCreativeLinkData> request) throws MalformedResponseException {
                return AdCreativeLinkData.parseResponse(response, context, request);
            }
        };
    }
}