com.facebook.ads.sdk.AdCreativeVideoData 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) 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 AdCreativeVideoData extends APINode {
@SerializedName("additional_image_index")
private Long mAdditionalImageIndex = null;
@SerializedName("branded_content_shared_to_sponsor_status")
private String mBrandedContentSharedToSponsorStatus = 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("collection_thumbnails")
private List mCollectionThumbnails = null;
@SerializedName("custom_overlay_spec")
private List mCustomOverlaySpec = null;
@SerializedName("image_hash")
private String mImageHash = null;
@SerializedName("image_url")
private String mImageUrl = null;
@SerializedName("link_description")
private String mLinkDescription = null;
@SerializedName("message")
private String mMessage = null;
@SerializedName("offer_id")
private String mOfferId = null;
@SerializedName("page_welcome_message")
private String mPageWelcomeMessage = null;
@SerializedName("post_click_configuration")
private AdCreativePostClickConfiguration mPostClickConfiguration = null;
@SerializedName("retailer_item_ids")
private List mRetailerItemIds = null;
@SerializedName("targeting")
private Targeting mTargeting = null;
@SerializedName("title")
private String mTitle = null;
@SerializedName("video_id")
private String mVideoId = null;
protected static Gson gson = null;
public AdCreativeVideoData() {
}
public String getId() {
return null;
}
public static AdCreativeVideoData loadJSON(String json, APIContext context, String header) {
AdCreativeVideoData adCreativeVideoData = getGson().fromJson(json, AdCreativeVideoData.class);
if (context.isDebug()) {
JsonParser parser = new JsonParser();
JsonElement o1 = parser.parse(json);
JsonElement o2 = parser.parse(adCreativeVideoData.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);
};
}
adCreativeVideoData.context = context;
adCreativeVideoData.rawValue = json;
adCreativeVideoData.header = header;
return adCreativeVideoData;
}
public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
APINodeList adCreativeVideoDatas = 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++) {
adCreativeVideoDatas.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
};
return adCreativeVideoDatas;
} 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;
adCreativeVideoDatas.setCursors(before, after);
}
String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
String next = paging.has("next") ? paging.get("next").getAsString() : null;
adCreativeVideoDatas.setPaging(previous, next);
if (context.hasAppSecret()) {
adCreativeVideoDatas.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++) {
adCreativeVideoDatas.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()) {
adCreativeVideoDatas.add(loadJSON(entry.getValue().toString(), context, header));
}
break;
}
}
if (!isRedownload) {
adCreativeVideoDatas.add(loadJSON(obj.toString(), context, header));
}
}
return adCreativeVideoDatas;
} 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()) {
adCreativeVideoDatas.add(loadJSON(entry.getValue().toString(), context, header));
}
return adCreativeVideoDatas;
} 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)
) {
adCreativeVideoDatas.add(loadJSON(value.toString(), context, header));
} else {
isIdIndexedArray = false;
break;
}
}
if (isIdIndexedArray) {
return adCreativeVideoDatas;
}
// Sixth, check if it's pure JsonObject
adCreativeVideoDatas.clear();
adCreativeVideoDatas.add(loadJSON(json, context, header));
return adCreativeVideoDatas;
}
}
} 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 AdCreativeVideoData setFieldAdditionalImageIndex(Long value) {
this.mAdditionalImageIndex = value;
return this;
}
public String getFieldBrandedContentSharedToSponsorStatus() {
return mBrandedContentSharedToSponsorStatus;
}
public AdCreativeVideoData setFieldBrandedContentSharedToSponsorStatus(String value) {
this.mBrandedContentSharedToSponsorStatus = value;
return this;
}
public String getFieldBrandedContentSponsorPageId() {
return mBrandedContentSponsorPageId;
}
public AdCreativeVideoData setFieldBrandedContentSponsorPageId(String value) {
this.mBrandedContentSponsorPageId = value;
return this;
}
public String getFieldBrandedContentSponsorRelationship() {
return mBrandedContentSponsorRelationship;
}
public AdCreativeVideoData setFieldBrandedContentSponsorRelationship(String value) {
this.mBrandedContentSponsorRelationship = value;
return this;
}
public AdCreativeLinkDataCallToAction getFieldCallToAction() {
return mCallToAction;
}
public AdCreativeVideoData setFieldCallToAction(AdCreativeLinkDataCallToAction value) {
this.mCallToAction = value;
return this;
}
public AdCreativeVideoData setFieldCallToAction(String value) {
Type type = new TypeToken(){}.getType();
this.mCallToAction = AdCreativeLinkDataCallToAction.getGson().fromJson(value, type);
return this;
}
public List getFieldCollectionThumbnails() {
return mCollectionThumbnails;
}
public AdCreativeVideoData setFieldCollectionThumbnails(List value) {
this.mCollectionThumbnails = value;
return this;
}
public AdCreativeVideoData setFieldCollectionThumbnails(String value) {
Type type = new TypeToken>(){}.getType();
this.mCollectionThumbnails = AdCreativeCollectionThumbnailInfo.getGson().fromJson(value, type);
return this;
}
public List getFieldCustomOverlaySpec() {
return mCustomOverlaySpec;
}
public AdCreativeVideoData setFieldCustomOverlaySpec(List value) {
this.mCustomOverlaySpec = value;
return this;
}
public AdCreativeVideoData setFieldCustomOverlaySpec(String value) {
Type type = new TypeToken>(){}.getType();
this.mCustomOverlaySpec = AdCreativeVideoDataCustomOverlaySpec.getGson().fromJson(value, type);
return this;
}
public String getFieldImageHash() {
return mImageHash;
}
public AdCreativeVideoData setFieldImageHash(String value) {
this.mImageHash = value;
return this;
}
public String getFieldImageUrl() {
return mImageUrl;
}
public AdCreativeVideoData setFieldImageUrl(String value) {
this.mImageUrl = value;
return this;
}
public String getFieldLinkDescription() {
return mLinkDescription;
}
public AdCreativeVideoData setFieldLinkDescription(String value) {
this.mLinkDescription = value;
return this;
}
public String getFieldMessage() {
return mMessage;
}
public AdCreativeVideoData setFieldMessage(String value) {
this.mMessage = value;
return this;
}
public String getFieldOfferId() {
return mOfferId;
}
public AdCreativeVideoData setFieldOfferId(String value) {
this.mOfferId = value;
return this;
}
public String getFieldPageWelcomeMessage() {
return mPageWelcomeMessage;
}
public AdCreativeVideoData setFieldPageWelcomeMessage(String value) {
this.mPageWelcomeMessage = value;
return this;
}
public AdCreativePostClickConfiguration getFieldPostClickConfiguration() {
return mPostClickConfiguration;
}
public AdCreativeVideoData setFieldPostClickConfiguration(AdCreativePostClickConfiguration value) {
this.mPostClickConfiguration = value;
return this;
}
public AdCreativeVideoData setFieldPostClickConfiguration(String value) {
Type type = new TypeToken(){}.getType();
this.mPostClickConfiguration = AdCreativePostClickConfiguration.getGson().fromJson(value, type);
return this;
}
public List getFieldRetailerItemIds() {
return mRetailerItemIds;
}
public AdCreativeVideoData setFieldRetailerItemIds(List value) {
this.mRetailerItemIds = value;
return this;
}
public Targeting getFieldTargeting() {
return mTargeting;
}
public AdCreativeVideoData setFieldTargeting(Targeting value) {
this.mTargeting = value;
return this;
}
public AdCreativeVideoData setFieldTargeting(String value) {
Type type = new TypeToken(){}.getType();
this.mTargeting = Targeting.getGson().fromJson(value, type);
return this;
}
public String getFieldTitle() {
return mTitle;
}
public AdCreativeVideoData setFieldTitle(String value) {
this.mTitle = value;
return this;
}
public String getFieldVideoId() {
return mVideoId;
}
public AdCreativeVideoData setFieldVideoId(String value) {
this.mVideoId = value;
return this;
}
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 AdCreativeVideoData copyFrom(AdCreativeVideoData instance) {
this.mAdditionalImageIndex = instance.mAdditionalImageIndex;
this.mBrandedContentSharedToSponsorStatus = instance.mBrandedContentSharedToSponsorStatus;
this.mBrandedContentSponsorPageId = instance.mBrandedContentSponsorPageId;
this.mBrandedContentSponsorRelationship = instance.mBrandedContentSponsorRelationship;
this.mCallToAction = instance.mCallToAction;
this.mCollectionThumbnails = instance.mCollectionThumbnails;
this.mCustomOverlaySpec = instance.mCustomOverlaySpec;
this.mImageHash = instance.mImageHash;
this.mImageUrl = instance.mImageUrl;
this.mLinkDescription = instance.mLinkDescription;
this.mMessage = instance.mMessage;
this.mOfferId = instance.mOfferId;
this.mPageWelcomeMessage = instance.mPageWelcomeMessage;
this.mPostClickConfiguration = instance.mPostClickConfiguration;
this.mRetailerItemIds = instance.mRetailerItemIds;
this.mTargeting = instance.mTargeting;
this.mTitle = instance.mTitle;
this.mVideoId = instance.mVideoId;
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 AdCreativeVideoData.parseResponse(response, context, request, header);
}
};
}
}