com.facebook.ads.sdk.AdPreview Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of facebook-java-business-sdk Show documentation
Show all versions of facebook-java-business-sdk Show documentation
Facebook Business Solutions SDK for Java
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under the license found in the
* LICENSE file in the root directory of this source tree.
*/
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.MoreExecutors;
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 AdPreview extends APINode {
@SerializedName("body")
private String mBody = null;
@SerializedName("transformation_spec")
private Object mTransformationSpec = null;
protected static Gson gson = null;
public AdPreview() {
}
public String getId() {
return null;
}
public static AdPreview loadJSON(String json, APIContext context, String header) {
AdPreview adPreview = getGson().fromJson(json, AdPreview.class);
if (context.isDebug()) {
JsonParser parser = new JsonParser();
JsonElement o1 = parser.parse(json);
JsonElement o2 = parser.parse(adPreview.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);
}
}
adPreview.context = context;
adPreview.rawValue = json;
adPreview.header = header;
return adPreview;
}
public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
APINodeList adPreviews = 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++) {
adPreviews.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
};
return adPreviews;
} 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;
adPreviews.setCursors(before, after);
}
String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
String next = paging.has("next") ? paging.get("next").getAsString() : null;
adPreviews.setPaging(previous, next);
if (context.hasAppSecret()) {
adPreviews.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++) {
adPreviews.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()) {
adPreviews.add(loadJSON(entry.getValue().toString(), context, header));
}
break;
}
}
if (!isRedownload) {
adPreviews.add(loadJSON(obj.toString(), context, header));
}
}
return adPreviews;
} 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()) {
adPreviews.add(loadJSON(entry.getValue().toString(), context, header));
}
return adPreviews;
} 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)
) {
adPreviews.add(loadJSON(value.toString(), context, header));
} else {
isIdIndexedArray = false;
break;
}
}
if (isIdIndexedArray) {
return adPreviews;
}
// Sixth, check if it's pure JsonObject
adPreviews.clear();
adPreviews.add(loadJSON(json, context, header));
return adPreviews;
}
}
} 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 String getFieldBody() {
return mBody;
}
public AdPreview setFieldBody(String value) {
this.mBody = value;
return this;
}
public Object getFieldTransformationSpec() {
return mTransformationSpec;
}
public AdPreview setFieldTransformationSpec(Object value) {
this.mTransformationSpec = value;
return this;
}
public static enum EnumAdFormat {
@SerializedName("AUDIENCE_NETWORK_INSTREAM_VIDEO")
VALUE_AUDIENCE_NETWORK_INSTREAM_VIDEO("AUDIENCE_NETWORK_INSTREAM_VIDEO"),
@SerializedName("AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE")
VALUE_AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE("AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE"),
@SerializedName("AUDIENCE_NETWORK_OUTSTREAM_VIDEO")
VALUE_AUDIENCE_NETWORK_OUTSTREAM_VIDEO("AUDIENCE_NETWORK_OUTSTREAM_VIDEO"),
@SerializedName("AUDIENCE_NETWORK_REWARDED_VIDEO")
VALUE_AUDIENCE_NETWORK_REWARDED_VIDEO("AUDIENCE_NETWORK_REWARDED_VIDEO"),
@SerializedName("BIZ_DISCO_FEED_MOBILE")
VALUE_BIZ_DISCO_FEED_MOBILE("BIZ_DISCO_FEED_MOBILE"),
@SerializedName("DESKTOP_FEED_STANDARD")
VALUE_DESKTOP_FEED_STANDARD("DESKTOP_FEED_STANDARD"),
@SerializedName("FACEBOOK_PROFILE_FEED_DESKTOP")
VALUE_FACEBOOK_PROFILE_FEED_DESKTOP("FACEBOOK_PROFILE_FEED_DESKTOP"),
@SerializedName("FACEBOOK_PROFILE_FEED_MOBILE")
VALUE_FACEBOOK_PROFILE_FEED_MOBILE("FACEBOOK_PROFILE_FEED_MOBILE"),
@SerializedName("FACEBOOK_PROFILE_REELS_MOBILE")
VALUE_FACEBOOK_PROFILE_REELS_MOBILE("FACEBOOK_PROFILE_REELS_MOBILE"),
@SerializedName("FACEBOOK_REELS_BANNER")
VALUE_FACEBOOK_REELS_BANNER("FACEBOOK_REELS_BANNER"),
@SerializedName("FACEBOOK_REELS_BANNER_DESKTOP")
VALUE_FACEBOOK_REELS_BANNER_DESKTOP("FACEBOOK_REELS_BANNER_DESKTOP"),
@SerializedName("FACEBOOK_REELS_BANNER_FULLSCREEN_IOS")
VALUE_FACEBOOK_REELS_BANNER_FULLSCREEN_IOS("FACEBOOK_REELS_BANNER_FULLSCREEN_IOS"),
@SerializedName("FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE")
VALUE_FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE("FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE"),
@SerializedName("FACEBOOK_REELS_MOBILE")
VALUE_FACEBOOK_REELS_MOBILE("FACEBOOK_REELS_MOBILE"),
@SerializedName("FACEBOOK_REELS_POSTLOOP")
VALUE_FACEBOOK_REELS_POSTLOOP("FACEBOOK_REELS_POSTLOOP"),
@SerializedName("FACEBOOK_REELS_STICKER")
VALUE_FACEBOOK_REELS_STICKER("FACEBOOK_REELS_STICKER"),
@SerializedName("FACEBOOK_STORY_MOBILE")
VALUE_FACEBOOK_STORY_MOBILE("FACEBOOK_STORY_MOBILE"),
@SerializedName("FACEBOOK_STORY_STICKER_MOBILE")
VALUE_FACEBOOK_STORY_STICKER_MOBILE("FACEBOOK_STORY_STICKER_MOBILE"),
@SerializedName("INSTAGRAM_EXPLORE_CONTEXTUAL")
VALUE_INSTAGRAM_EXPLORE_CONTEXTUAL("INSTAGRAM_EXPLORE_CONTEXTUAL"),
@SerializedName("INSTAGRAM_EXPLORE_GRID_HOME")
VALUE_INSTAGRAM_EXPLORE_GRID_HOME("INSTAGRAM_EXPLORE_GRID_HOME"),
@SerializedName("INSTAGRAM_EXPLORE_IMMERSIVE")
VALUE_INSTAGRAM_EXPLORE_IMMERSIVE("INSTAGRAM_EXPLORE_IMMERSIVE"),
@SerializedName("INSTAGRAM_FEED_WEB")
VALUE_INSTAGRAM_FEED_WEB("INSTAGRAM_FEED_WEB"),
@SerializedName("INSTAGRAM_FEED_WEB_M_SITE")
VALUE_INSTAGRAM_FEED_WEB_M_SITE("INSTAGRAM_FEED_WEB_M_SITE"),
@SerializedName("INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS")
VALUE_INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS("INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS"),
@SerializedName("INSTAGRAM_PROFILE_FEED")
VALUE_INSTAGRAM_PROFILE_FEED("INSTAGRAM_PROFILE_FEED"),
@SerializedName("INSTAGRAM_PROFILE_REELS")
VALUE_INSTAGRAM_PROFILE_REELS("INSTAGRAM_PROFILE_REELS"),
@SerializedName("INSTAGRAM_REELS")
VALUE_INSTAGRAM_REELS("INSTAGRAM_REELS"),
@SerializedName("INSTAGRAM_REELS_OVERLAY")
VALUE_INSTAGRAM_REELS_OVERLAY("INSTAGRAM_REELS_OVERLAY"),
@SerializedName("INSTAGRAM_SEARCH_CHAIN")
VALUE_INSTAGRAM_SEARCH_CHAIN("INSTAGRAM_SEARCH_CHAIN"),
@SerializedName("INSTAGRAM_SEARCH_GRID")
VALUE_INSTAGRAM_SEARCH_GRID("INSTAGRAM_SEARCH_GRID"),
@SerializedName("INSTAGRAM_STANDARD")
VALUE_INSTAGRAM_STANDARD("INSTAGRAM_STANDARD"),
@SerializedName("INSTAGRAM_STORY")
VALUE_INSTAGRAM_STORY("INSTAGRAM_STORY"),
@SerializedName("INSTAGRAM_STORY_EFFECT_TRAY")
VALUE_INSTAGRAM_STORY_EFFECT_TRAY("INSTAGRAM_STORY_EFFECT_TRAY"),
@SerializedName("INSTAGRAM_STORY_WEB")
VALUE_INSTAGRAM_STORY_WEB("INSTAGRAM_STORY_WEB"),
@SerializedName("INSTAGRAM_STORY_WEB_M_SITE")
VALUE_INSTAGRAM_STORY_WEB_M_SITE("INSTAGRAM_STORY_WEB_M_SITE"),
@SerializedName("INSTANT_ARTICLE_RECIRCULATION_AD")
VALUE_INSTANT_ARTICLE_RECIRCULATION_AD("INSTANT_ARTICLE_RECIRCULATION_AD"),
@SerializedName("INSTANT_ARTICLE_STANDARD")
VALUE_INSTANT_ARTICLE_STANDARD("INSTANT_ARTICLE_STANDARD"),
@SerializedName("INSTREAM_BANNER_DESKTOP")
VALUE_INSTREAM_BANNER_DESKTOP("INSTREAM_BANNER_DESKTOP"),
@SerializedName("INSTREAM_BANNER_FULLSCREEN_IOS")
VALUE_INSTREAM_BANNER_FULLSCREEN_IOS("INSTREAM_BANNER_FULLSCREEN_IOS"),
@SerializedName("INSTREAM_BANNER_FULLSCREEN_MOBILE")
VALUE_INSTREAM_BANNER_FULLSCREEN_MOBILE("INSTREAM_BANNER_FULLSCREEN_MOBILE"),
@SerializedName("INSTREAM_BANNER_IMMERSIVE_MOBILE")
VALUE_INSTREAM_BANNER_IMMERSIVE_MOBILE("INSTREAM_BANNER_IMMERSIVE_MOBILE"),
@SerializedName("INSTREAM_BANNER_MOBILE")
VALUE_INSTREAM_BANNER_MOBILE("INSTREAM_BANNER_MOBILE"),
@SerializedName("INSTREAM_VIDEO_DESKTOP")
VALUE_INSTREAM_VIDEO_DESKTOP("INSTREAM_VIDEO_DESKTOP"),
@SerializedName("INSTREAM_VIDEO_FULLSCREEN_IOS")
VALUE_INSTREAM_VIDEO_FULLSCREEN_IOS("INSTREAM_VIDEO_FULLSCREEN_IOS"),
@SerializedName("INSTREAM_VIDEO_FULLSCREEN_MOBILE")
VALUE_INSTREAM_VIDEO_FULLSCREEN_MOBILE("INSTREAM_VIDEO_FULLSCREEN_MOBILE"),
@SerializedName("INSTREAM_VIDEO_IMAGE")
VALUE_INSTREAM_VIDEO_IMAGE("INSTREAM_VIDEO_IMAGE"),
@SerializedName("INSTREAM_VIDEO_IMMERSIVE_MOBILE")
VALUE_INSTREAM_VIDEO_IMMERSIVE_MOBILE("INSTREAM_VIDEO_IMMERSIVE_MOBILE"),
@SerializedName("INSTREAM_VIDEO_MOBILE")
VALUE_INSTREAM_VIDEO_MOBILE("INSTREAM_VIDEO_MOBILE"),
@SerializedName("JOB_BROWSER_DESKTOP")
VALUE_JOB_BROWSER_DESKTOP("JOB_BROWSER_DESKTOP"),
@SerializedName("JOB_BROWSER_MOBILE")
VALUE_JOB_BROWSER_MOBILE("JOB_BROWSER_MOBILE"),
@SerializedName("MARKETPLACE_MOBILE")
VALUE_MARKETPLACE_MOBILE("MARKETPLACE_MOBILE"),
@SerializedName("MESSENGER_MOBILE_INBOX_MEDIA")
VALUE_MESSENGER_MOBILE_INBOX_MEDIA("MESSENGER_MOBILE_INBOX_MEDIA"),
@SerializedName("MESSENGER_MOBILE_STORY_MEDIA")
VALUE_MESSENGER_MOBILE_STORY_MEDIA("MESSENGER_MOBILE_STORY_MEDIA"),
@SerializedName("MOBILE_BANNER")
VALUE_MOBILE_BANNER("MOBILE_BANNER"),
@SerializedName("MOBILE_FEED_BASIC")
VALUE_MOBILE_FEED_BASIC("MOBILE_FEED_BASIC"),
@SerializedName("MOBILE_FEED_STANDARD")
VALUE_MOBILE_FEED_STANDARD("MOBILE_FEED_STANDARD"),
@SerializedName("MOBILE_FULLWIDTH")
VALUE_MOBILE_FULLWIDTH("MOBILE_FULLWIDTH"),
@SerializedName("MOBILE_INTERSTITIAL")
VALUE_MOBILE_INTERSTITIAL("MOBILE_INTERSTITIAL"),
@SerializedName("MOBILE_MEDIUM_RECTANGLE")
VALUE_MOBILE_MEDIUM_RECTANGLE("MOBILE_MEDIUM_RECTANGLE"),
@SerializedName("MOBILE_NATIVE")
VALUE_MOBILE_NATIVE("MOBILE_NATIVE"),
@SerializedName("RIGHT_COLUMN_STANDARD")
VALUE_RIGHT_COLUMN_STANDARD("RIGHT_COLUMN_STANDARD"),
@SerializedName("SUGGESTED_VIDEO_DESKTOP")
VALUE_SUGGESTED_VIDEO_DESKTOP("SUGGESTED_VIDEO_DESKTOP"),
@SerializedName("SUGGESTED_VIDEO_FULLSCREEN_MOBILE")
VALUE_SUGGESTED_VIDEO_FULLSCREEN_MOBILE("SUGGESTED_VIDEO_FULLSCREEN_MOBILE"),
@SerializedName("SUGGESTED_VIDEO_IMMERSIVE_MOBILE")
VALUE_SUGGESTED_VIDEO_IMMERSIVE_MOBILE("SUGGESTED_VIDEO_IMMERSIVE_MOBILE"),
@SerializedName("SUGGESTED_VIDEO_MOBILE")
VALUE_SUGGESTED_VIDEO_MOBILE("SUGGESTED_VIDEO_MOBILE"),
@SerializedName("WATCH_FEED_HOME")
VALUE_WATCH_FEED_HOME("WATCH_FEED_HOME"),
@SerializedName("WATCH_FEED_MOBILE")
VALUE_WATCH_FEED_MOBILE("WATCH_FEED_MOBILE"),
;
private String value;
private EnumAdFormat(String value) {
this.value = value;
}
@Override
public String toString() {
return value;
}
}
public static enum EnumCreativeFeature {
@SerializedName("product_metadata_automation")
VALUE_PRODUCT_METADATA_AUTOMATION("product_metadata_automation"),
@SerializedName("profile_card")
VALUE_PROFILE_CARD("profile_card"),
@SerializedName("standard_enhancements_catalog")
VALUE_STANDARD_ENHANCEMENTS_CATALOG("standard_enhancements_catalog"),
@SerializedName("video_to_image")
VALUE_VIDEO_TO_IMAGE("video_to_image"),
;
private String value;
private EnumCreativeFeature(String value) {
this.value = value;
}
@Override
public String toString() {
return value;
}
}
public static enum EnumRenderType {
@SerializedName("FALLBACK")
VALUE_FALLBACK("FALLBACK"),
;
private String value;
private EnumRenderType(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 AdPreview copyFrom(AdPreview instance) {
this.mBody = instance.mBody;
this.mTransformationSpec = instance.mTransformationSpec;
this.context = instance.context;
this.rawValue = instance.rawValue;
return this;
}
public static APIRequest.ResponseParser getParser() {
return new APIRequest.ResponseParser() {
public APINodeList parseResponse(String response, APIContext context, APIRequest request, String header) throws MalformedResponseException {
return AdPreview.parseResponse(response, context, request, header);
}
};
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy