com.facebook.ads.sdk.Link 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 Link extends APINode {
@SerializedName("caption")
private String mCaption = null;
@SerializedName("created_time")
private String mCreatedTime = null;
@SerializedName("description")
private String mDescription = null;
@SerializedName("from")
private Object mFrom = null;
@SerializedName("icon")
private String mIcon = null;
@SerializedName("id")
private String mId = null;
@SerializedName("link")
private String mLink = null;
@SerializedName("message")
private String mMessage = null;
@SerializedName("multi_share_optimized")
private Boolean mMultiShareOptimized = null;
@SerializedName("name")
private String mName = null;
@SerializedName("privacy")
private Privacy mPrivacy = null;
@SerializedName("via")
private Object mVia = null;
protected static Gson gson = null;
Link() {
}
public Link(Long id, APIContext context) {
this(id.toString(), context);
}
public Link(String id, APIContext context) {
this.mId = id;
this.context = context;
}
public Link fetch() throws APIException{
Link newInstance = fetchById(this.getPrefixedId().toString(), this.context);
this.copyFrom(newInstance);
return this;
}
public static Link 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 Link 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", Link.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", Link.getParser())
.setParam("ids", APIRequest.joinStringList(ids))
.requestFields(fields)
.executeAsyncBase();
}
private String getPrefixedId() {
return getId();
}
public String getId() {
return getFieldId().toString();
}
public static Link loadJSON(String json, APIContext context, String header) {
Link link = getGson().fromJson(json, Link.class);
if (context.isDebug()) {
JsonParser parser = new JsonParser();
JsonElement o1 = parser.parse(json);
JsonElement o2 = parser.parse(link.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);
}
}
link.context = context;
link.rawValue = json;
link.header = header;
return link;
}
public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
APINodeList links = 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++) {
links.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
};
return links;
} 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;
links.setCursors(before, after);
}
String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
String next = paging.has("next") ? paging.get("next").getAsString() : null;
links.setPaging(previous, next);
if (context.hasAppSecret()) {
links.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++) {
links.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()) {
links.add(loadJSON(entry.getValue().toString(), context, header));
}
break;
}
}
if (!isRedownload) {
links.add(loadJSON(obj.toString(), context, header));
}
}
return links;
} 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()) {
links.add(loadJSON(entry.getValue().toString(), context, header));
}
return links;
} 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)
) {
links.add(loadJSON(value.toString(), context, header));
} else {
isIdIndexedArray = false;
break;
}
}
if (isIdIndexedArray) {
return links;
}
// Sixth, check if it's pure JsonObject
links.clear();
links.add(loadJSON(json, context, header));
return links;
}
}
} 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 APIRequestCreateComment createComment() {
return new APIRequestCreateComment(this.getPrefixedId().toString(), context);
}
public APIRequestGetLikes getLikes() {
return new APIRequestGetLikes(this.getPrefixedId().toString(), context);
}
public APIRequestGet get() {
return new APIRequestGet(this.getPrefixedId().toString(), context);
}
public String getFieldCaption() {
return mCaption;
}
public String getFieldCreatedTime() {
return mCreatedTime;
}
public String getFieldDescription() {
return mDescription;
}
public Object getFieldFrom() {
return mFrom;
}
public String getFieldIcon() {
return mIcon;
}
public String getFieldId() {
return mId;
}
public String getFieldLink() {
return mLink;
}
public String getFieldMessage() {
return mMessage;
}
public Boolean getFieldMultiShareOptimized() {
return mMultiShareOptimized;
}
public String getFieldName() {
return mName;
}
public Privacy getFieldPrivacy() {
return mPrivacy;
}
public Object getFieldVia() {
return mVia;
}
public static class APIRequestCreateComment extends APIRequest {
Comment lastResponse = null;
@Override
public Comment getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
"attachment_id",
"attachment_share_url",
"attachment_url",
"comment_privacy_value",
"facepile_mentioned_ids",
"feedback_source",
"is_offline",
"message",
"nectar_module",
"object_id",
"parent_comment_id",
"text",
"tracking",
};
public static final String[] FIELDS = {
};
@Override
public Comment parseResponse(String response, String header) throws APIException {
return Comment.parseResponse(response, getContext(), this, header).head();
}
@Override
public Comment execute() throws APIException {
return execute(new HashMap());
}
@Override
public Comment 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 Comment apply(ResponseWrapper result) {
try {
return APIRequestCreateComment.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestCreateComment(String nodeId, APIContext context) {
super(context, nodeId, "/comments", "POST", Arrays.asList(PARAMS));
}
@Override
public APIRequestCreateComment setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestCreateComment setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestCreateComment setAttachmentId (String attachmentId) {
this.setParam("attachment_id", attachmentId);
return this;
}
public APIRequestCreateComment setAttachmentShareUrl (String attachmentShareUrl) {
this.setParam("attachment_share_url", attachmentShareUrl);
return this;
}
public APIRequestCreateComment setAttachmentUrl (String attachmentUrl) {
this.setParam("attachment_url", attachmentUrl);
return this;
}
public APIRequestCreateComment setCommentPrivacyValue (Comment.EnumCommentPrivacyValue commentPrivacyValue) {
this.setParam("comment_privacy_value", commentPrivacyValue);
return this;
}
public APIRequestCreateComment setCommentPrivacyValue (String commentPrivacyValue) {
this.setParam("comment_privacy_value", commentPrivacyValue);
return this;
}
public APIRequestCreateComment setFacepileMentionedIds (List facepileMentionedIds) {
this.setParam("facepile_mentioned_ids", facepileMentionedIds);
return this;
}
public APIRequestCreateComment setFacepileMentionedIds (String facepileMentionedIds) {
this.setParam("facepile_mentioned_ids", facepileMentionedIds);
return this;
}
public APIRequestCreateComment setFeedbackSource (String feedbackSource) {
this.setParam("feedback_source", feedbackSource);
return this;
}
public APIRequestCreateComment setIsOffline (Boolean isOffline) {
this.setParam("is_offline", isOffline);
return this;
}
public APIRequestCreateComment setIsOffline (String isOffline) {
this.setParam("is_offline", isOffline);
return this;
}
public APIRequestCreateComment setMessage (String message) {
this.setParam("message", message);
return this;
}
public APIRequestCreateComment setNectarModule (String nectarModule) {
this.setParam("nectar_module", nectarModule);
return this;
}
public APIRequestCreateComment setObjectId (String objectId) {
this.setParam("object_id", objectId);
return this;
}
public APIRequestCreateComment setParentCommentId (Object parentCommentId) {
this.setParam("parent_comment_id", parentCommentId);
return this;
}
public APIRequestCreateComment setParentCommentId (String parentCommentId) {
this.setParam("parent_comment_id", parentCommentId);
return this;
}
public APIRequestCreateComment setText (String text) {
this.setParam("text", text);
return this;
}
public APIRequestCreateComment setTracking (String tracking) {
this.setParam("tracking", tracking);
return this;
}
public APIRequestCreateComment requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestCreateComment requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestCreateComment requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestCreateComment requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestCreateComment requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestCreateComment requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
}
public static class APIRequestGetLikes extends APIRequest {
APINodeList lastResponse = null;
@Override
public APINodeList getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
};
public static final String[] FIELDS = {
"can_post",
"id",
"link",
"name",
"pic",
"pic_crop",
"pic_large",
"pic_small",
"pic_square",
"profile_type",
"username",
};
@Override
public APINodeList parseResponse(String response, String header) throws APIException {
return Profile.parseResponse(response, getContext(), this, header);
}
@Override
public APINodeList execute() throws APIException {
return execute(new HashMap());
}
@Override
public APINodeList 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 APINodeList apply(ResponseWrapper result) {
try {
return APIRequestGetLikes.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestGetLikes(String nodeId, APIContext context) {
super(context, nodeId, "/likes", "GET", Arrays.asList(PARAMS));
}
@Override
public APIRequestGetLikes setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestGetLikes setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestGetLikes requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestGetLikes requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetLikes requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestGetLikes requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetLikes requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestGetLikes requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
public APIRequestGetLikes requestCanPostField () {
return this.requestCanPostField(true);
}
public APIRequestGetLikes requestCanPostField (boolean value) {
this.requestField("can_post", value);
return this;
}
public APIRequestGetLikes requestIdField () {
return this.requestIdField(true);
}
public APIRequestGetLikes requestIdField (boolean value) {
this.requestField("id", value);
return this;
}
public APIRequestGetLikes requestLinkField () {
return this.requestLinkField(true);
}
public APIRequestGetLikes requestLinkField (boolean value) {
this.requestField("link", value);
return this;
}
public APIRequestGetLikes requestNameField () {
return this.requestNameField(true);
}
public APIRequestGetLikes requestNameField (boolean value) {
this.requestField("name", value);
return this;
}
public APIRequestGetLikes requestPicField () {
return this.requestPicField(true);
}
public APIRequestGetLikes requestPicField (boolean value) {
this.requestField("pic", value);
return this;
}
public APIRequestGetLikes requestPicCropField () {
return this.requestPicCropField(true);
}
public APIRequestGetLikes requestPicCropField (boolean value) {
this.requestField("pic_crop", value);
return this;
}
public APIRequestGetLikes requestPicLargeField () {
return this.requestPicLargeField(true);
}
public APIRequestGetLikes requestPicLargeField (boolean value) {
this.requestField("pic_large", value);
return this;
}
public APIRequestGetLikes requestPicSmallField () {
return this.requestPicSmallField(true);
}
public APIRequestGetLikes requestPicSmallField (boolean value) {
this.requestField("pic_small", value);
return this;
}
public APIRequestGetLikes requestPicSquareField () {
return this.requestPicSquareField(true);
}
public APIRequestGetLikes requestPicSquareField (boolean value) {
this.requestField("pic_square", value);
return this;
}
public APIRequestGetLikes requestProfileTypeField () {
return this.requestProfileTypeField(true);
}
public APIRequestGetLikes requestProfileTypeField (boolean value) {
this.requestField("profile_type", value);
return this;
}
public APIRequestGetLikes requestUsernameField () {
return this.requestUsernameField(true);
}
public APIRequestGetLikes requestUsernameField (boolean value) {
this.requestField("username", value);
return this;
}
}
public static class APIRequestGet extends APIRequest {
Link lastResponse = null;
@Override
public Link getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
};
public static final String[] FIELDS = {
"caption",
"created_time",
"description",
"from",
"icon",
"id",
"link",
"message",
"multi_share_optimized",
"name",
"privacy",
"via",
};
@Override
public Link parseResponse(String response, String header) throws APIException {
return Link.parseResponse(response, getContext(), this, header).head();
}
@Override
public Link execute() throws APIException {
return execute(new HashMap());
}
@Override
public Link 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 Link apply(ResponseWrapper result) {
try {
return APIRequestGet.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestGet(String nodeId, APIContext context) {
super(context, nodeId, "/", "GET", Arrays.asList(PARAMS));
}
@Override
public APIRequestGet setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestGet setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestGet requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestGet requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGet requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestGet requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGet requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestGet requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
public APIRequestGet requestCaptionField () {
return this.requestCaptionField(true);
}
public APIRequestGet requestCaptionField (boolean value) {
this.requestField("caption", value);
return this;
}
public APIRequestGet requestCreatedTimeField () {
return this.requestCreatedTimeField(true);
}
public APIRequestGet requestCreatedTimeField (boolean value) {
this.requestField("created_time", value);
return this;
}
public APIRequestGet requestDescriptionField () {
return this.requestDescriptionField(true);
}
public APIRequestGet requestDescriptionField (boolean value) {
this.requestField("description", value);
return this;
}
public APIRequestGet requestFromField () {
return this.requestFromField(true);
}
public APIRequestGet requestFromField (boolean value) {
this.requestField("from", value);
return this;
}
public APIRequestGet requestIconField () {
return this.requestIconField(true);
}
public APIRequestGet requestIconField (boolean value) {
this.requestField("icon", value);
return this;
}
public APIRequestGet requestIdField () {
return this.requestIdField(true);
}
public APIRequestGet requestIdField (boolean value) {
this.requestField("id", value);
return this;
}
public APIRequestGet requestLinkField () {
return this.requestLinkField(true);
}
public APIRequestGet requestLinkField (boolean value) {
this.requestField("link", value);
return this;
}
public APIRequestGet requestMessageField () {
return this.requestMessageField(true);
}
public APIRequestGet requestMessageField (boolean value) {
this.requestField("message", value);
return this;
}
public APIRequestGet requestMultiShareOptimizedField () {
return this.requestMultiShareOptimizedField(true);
}
public APIRequestGet requestMultiShareOptimizedField (boolean value) {
this.requestField("multi_share_optimized", value);
return this;
}
public APIRequestGet requestNameField () {
return this.requestNameField(true);
}
public APIRequestGet requestNameField (boolean value) {
this.requestField("name", value);
return this;
}
public APIRequestGet requestPrivacyField () {
return this.requestPrivacyField(true);
}
public APIRequestGet requestPrivacyField (boolean value) {
this.requestField("privacy", value);
return this;
}
public APIRequestGet requestViaField () {
return this.requestViaField(true);
}
public APIRequestGet requestViaField (boolean value) {
this.requestField("via", 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 Link copyFrom(Link instance) {
this.mCaption = instance.mCaption;
this.mCreatedTime = instance.mCreatedTime;
this.mDescription = instance.mDescription;
this.mFrom = instance.mFrom;
this.mIcon = instance.mIcon;
this.mId = instance.mId;
this.mLink = instance.mLink;
this.mMessage = instance.mMessage;
this.mMultiShareOptimized = instance.mMultiShareOptimized;
this.mName = instance.mName;
this.mPrivacy = instance.mPrivacy;
this.mVia = instance.mVia;
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 Link.parseResponse(response, context, request, header);
}
};
}
}