com.facebook.ads.sdk.AdStudyCell 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 AdStudyCell extends APINode {
@SerializedName("ad_entities_count")
private Long mAdEntitiesCount = null;
@SerializedName("control_percentage")
private Double mControlPercentage = null;
@SerializedName("id")
private String mId = null;
@SerializedName("name")
private String mName = null;
@SerializedName("treatment_percentage")
private Double mTreatmentPercentage = null;
protected static Gson gson = null;
AdStudyCell() {
}
public AdStudyCell(Long id, APIContext context) {
this(id.toString(), context);
}
public AdStudyCell(String id, APIContext context) {
this.mId = id;
this.context = context;
}
public AdStudyCell fetch() throws APIException{
AdStudyCell newInstance = fetchById(this.getPrefixedId().toString(), this.context);
this.copyFrom(newInstance);
return this;
}
public static AdStudyCell 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 AdStudyCell 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", AdStudyCell.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", AdStudyCell.getParser())
.setParam("ids", APIRequest.joinStringList(ids))
.requestFields(fields)
.executeAsyncBase();
}
private String getPrefixedId() {
return getId();
}
public String getId() {
return getFieldId().toString();
}
public static AdStudyCell loadJSON(String json, APIContext context, String header) {
AdStudyCell adStudyCell = getGson().fromJson(json, AdStudyCell.class);
if (context.isDebug()) {
JsonParser parser = new JsonParser();
JsonElement o1 = parser.parse(json);
JsonElement o2 = parser.parse(adStudyCell.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);
}
}
adStudyCell.context = context;
adStudyCell.rawValue = json;
adStudyCell.header = header;
return adStudyCell;
}
public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
APINodeList adStudyCells = 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++) {
adStudyCells.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
};
return adStudyCells;
} 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;
adStudyCells.setCursors(before, after);
}
String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
String next = paging.has("next") ? paging.get("next").getAsString() : null;
adStudyCells.setPaging(previous, next);
if (context.hasAppSecret()) {
adStudyCells.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++) {
adStudyCells.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()) {
adStudyCells.add(loadJSON(entry.getValue().toString(), context, header));
}
break;
}
}
if (!isRedownload) {
adStudyCells.add(loadJSON(obj.toString(), context, header));
}
}
return adStudyCells;
} 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()) {
adStudyCells.add(loadJSON(entry.getValue().toString(), context, header));
}
return adStudyCells;
} 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)
) {
adStudyCells.add(loadJSON(value.toString(), context, header));
} else {
isIdIndexedArray = false;
break;
}
}
if (isIdIndexedArray) {
return adStudyCells;
}
// Sixth, check if it's pure JsonObject
adStudyCells.clear();
adStudyCells.add(loadJSON(json, context, header));
return adStudyCells;
}
}
} 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 APIRequestGetAdAccounts getAdAccounts() {
return new APIRequestGetAdAccounts(this.getPrefixedId().toString(), context);
}
public APIRequestGetAdSets getAdSets() {
return new APIRequestGetAdSets(this.getPrefixedId().toString(), context);
}
public APIRequestGetCampaigns getCampaigns() {
return new APIRequestGetCampaigns(this.getPrefixedId().toString(), context);
}
public APIRequestGet get() {
return new APIRequestGet(this.getPrefixedId().toString(), context);
}
public APIRequestUpdate update() {
return new APIRequestUpdate(this.getPrefixedId().toString(), context);
}
public Long getFieldAdEntitiesCount() {
return mAdEntitiesCount;
}
public Double getFieldControlPercentage() {
return mControlPercentage;
}
public String getFieldId() {
return mId;
}
public String getFieldName() {
return mName;
}
public Double getFieldTreatmentPercentage() {
return mTreatmentPercentage;
}
public static class APIRequestGetAdAccounts extends APIRequest {
APINodeList lastResponse = null;
@Override
public APINodeList getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
};
public static final String[] FIELDS = {
"account_id",
"account_status",
"ad_account_promotable_objects",
"age",
"agency_client_declaration",
"all_capabilities",
"amount_spent",
"attribution_spec",
"balance",
"brand_safety_content_filter_levels",
"business",
"business_city",
"business_country_code",
"business_name",
"business_state",
"business_street",
"business_street2",
"business_zip",
"capabilities",
"created_time",
"currency",
"custom_audience_info",
"default_dsa_beneficiary",
"default_dsa_payor",
"disable_reason",
"end_advertiser",
"end_advertiser_name",
"existing_customers",
"extended_credit_invoice_group",
"failed_delivery_checks",
"fb_entity",
"funding_source",
"funding_source_details",
"has_migrated_permissions",
"has_page_authorized_adaccount",
"id",
"io_number",
"is_attribution_spec_system_default",
"is_direct_deals_enabled",
"is_in_3ds_authorization_enabled_market",
"is_notifications_enabled",
"is_personal",
"is_prepay_account",
"is_tax_id_required",
"liable_address",
"line_numbers",
"media_agency",
"min_campaign_group_spend_cap",
"min_daily_budget",
"name",
"offsite_pixels_tos_accepted",
"owner",
"owner_business",
"partner",
"rf_spec",
"send_bill_to_address",
"show_checkout_experience",
"sold_to_address",
"spend_cap",
"tax_id",
"tax_id_status",
"tax_id_type",
"timezone_id",
"timezone_name",
"timezone_offset_hours_utc",
"tos_accepted",
"user_access_expire_time",
"user_tasks",
"user_tos_accepted",
"viewable_business",
};
@Override
public APINodeList parseResponse(String response, String header) throws APIException {
return AdAccount.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 APIRequestGetAdAccounts.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestGetAdAccounts(String nodeId, APIContext context) {
super(context, nodeId, "/adaccounts", "GET", Arrays.asList(PARAMS));
}
@Override
public APIRequestGetAdAccounts setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestGetAdAccounts setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestGetAdAccounts requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestGetAdAccounts requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetAdAccounts requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestGetAdAccounts requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetAdAccounts requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestGetAdAccounts requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
public APIRequestGetAdAccounts requestAccountIdField () {
return this.requestAccountIdField(true);
}
public APIRequestGetAdAccounts requestAccountIdField (boolean value) {
this.requestField("account_id", value);
return this;
}
public APIRequestGetAdAccounts requestAccountStatusField () {
return this.requestAccountStatusField(true);
}
public APIRequestGetAdAccounts requestAccountStatusField (boolean value) {
this.requestField("account_status", value);
return this;
}
public APIRequestGetAdAccounts requestAdAccountPromotableObjectsField () {
return this.requestAdAccountPromotableObjectsField(true);
}
public APIRequestGetAdAccounts requestAdAccountPromotableObjectsField (boolean value) {
this.requestField("ad_account_promotable_objects", value);
return this;
}
public APIRequestGetAdAccounts requestAgeField () {
return this.requestAgeField(true);
}
public APIRequestGetAdAccounts requestAgeField (boolean value) {
this.requestField("age", value);
return this;
}
public APIRequestGetAdAccounts requestAgencyClientDeclarationField () {
return this.requestAgencyClientDeclarationField(true);
}
public APIRequestGetAdAccounts requestAgencyClientDeclarationField (boolean value) {
this.requestField("agency_client_declaration", value);
return this;
}
public APIRequestGetAdAccounts requestAllCapabilitiesField () {
return this.requestAllCapabilitiesField(true);
}
public APIRequestGetAdAccounts requestAllCapabilitiesField (boolean value) {
this.requestField("all_capabilities", value);
return this;
}
public APIRequestGetAdAccounts requestAmountSpentField () {
return this.requestAmountSpentField(true);
}
public APIRequestGetAdAccounts requestAmountSpentField (boolean value) {
this.requestField("amount_spent", value);
return this;
}
public APIRequestGetAdAccounts requestAttributionSpecField () {
return this.requestAttributionSpecField(true);
}
public APIRequestGetAdAccounts requestAttributionSpecField (boolean value) {
this.requestField("attribution_spec", value);
return this;
}
public APIRequestGetAdAccounts requestBalanceField () {
return this.requestBalanceField(true);
}
public APIRequestGetAdAccounts requestBalanceField (boolean value) {
this.requestField("balance", value);
return this;
}
public APIRequestGetAdAccounts requestBrandSafetyContentFilterLevelsField () {
return this.requestBrandSafetyContentFilterLevelsField(true);
}
public APIRequestGetAdAccounts requestBrandSafetyContentFilterLevelsField (boolean value) {
this.requestField("brand_safety_content_filter_levels", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessField () {
return this.requestBusinessField(true);
}
public APIRequestGetAdAccounts requestBusinessField (boolean value) {
this.requestField("business", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessCityField () {
return this.requestBusinessCityField(true);
}
public APIRequestGetAdAccounts requestBusinessCityField (boolean value) {
this.requestField("business_city", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessCountryCodeField () {
return this.requestBusinessCountryCodeField(true);
}
public APIRequestGetAdAccounts requestBusinessCountryCodeField (boolean value) {
this.requestField("business_country_code", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessNameField () {
return this.requestBusinessNameField(true);
}
public APIRequestGetAdAccounts requestBusinessNameField (boolean value) {
this.requestField("business_name", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessStateField () {
return this.requestBusinessStateField(true);
}
public APIRequestGetAdAccounts requestBusinessStateField (boolean value) {
this.requestField("business_state", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessStreetField () {
return this.requestBusinessStreetField(true);
}
public APIRequestGetAdAccounts requestBusinessStreetField (boolean value) {
this.requestField("business_street", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessStreet2Field () {
return this.requestBusinessStreet2Field(true);
}
public APIRequestGetAdAccounts requestBusinessStreet2Field (boolean value) {
this.requestField("business_street2", value);
return this;
}
public APIRequestGetAdAccounts requestBusinessZipField () {
return this.requestBusinessZipField(true);
}
public APIRequestGetAdAccounts requestBusinessZipField (boolean value) {
this.requestField("business_zip", value);
return this;
}
public APIRequestGetAdAccounts requestCapabilitiesField () {
return this.requestCapabilitiesField(true);
}
public APIRequestGetAdAccounts requestCapabilitiesField (boolean value) {
this.requestField("capabilities", value);
return this;
}
public APIRequestGetAdAccounts requestCreatedTimeField () {
return this.requestCreatedTimeField(true);
}
public APIRequestGetAdAccounts requestCreatedTimeField (boolean value) {
this.requestField("created_time", value);
return this;
}
public APIRequestGetAdAccounts requestCurrencyField () {
return this.requestCurrencyField(true);
}
public APIRequestGetAdAccounts requestCurrencyField (boolean value) {
this.requestField("currency", value);
return this;
}
public APIRequestGetAdAccounts requestCustomAudienceInfoField () {
return this.requestCustomAudienceInfoField(true);
}
public APIRequestGetAdAccounts requestCustomAudienceInfoField (boolean value) {
this.requestField("custom_audience_info", value);
return this;
}
public APIRequestGetAdAccounts requestDefaultDsaBeneficiaryField () {
return this.requestDefaultDsaBeneficiaryField(true);
}
public APIRequestGetAdAccounts requestDefaultDsaBeneficiaryField (boolean value) {
this.requestField("default_dsa_beneficiary", value);
return this;
}
public APIRequestGetAdAccounts requestDefaultDsaPayorField () {
return this.requestDefaultDsaPayorField(true);
}
public APIRequestGetAdAccounts requestDefaultDsaPayorField (boolean value) {
this.requestField("default_dsa_payor", value);
return this;
}
public APIRequestGetAdAccounts requestDisableReasonField () {
return this.requestDisableReasonField(true);
}
public APIRequestGetAdAccounts requestDisableReasonField (boolean value) {
this.requestField("disable_reason", value);
return this;
}
public APIRequestGetAdAccounts requestEndAdvertiserField () {
return this.requestEndAdvertiserField(true);
}
public APIRequestGetAdAccounts requestEndAdvertiserField (boolean value) {
this.requestField("end_advertiser", value);
return this;
}
public APIRequestGetAdAccounts requestEndAdvertiserNameField () {
return this.requestEndAdvertiserNameField(true);
}
public APIRequestGetAdAccounts requestEndAdvertiserNameField (boolean value) {
this.requestField("end_advertiser_name", value);
return this;
}
public APIRequestGetAdAccounts requestExistingCustomersField () {
return this.requestExistingCustomersField(true);
}
public APIRequestGetAdAccounts requestExistingCustomersField (boolean value) {
this.requestField("existing_customers", value);
return this;
}
public APIRequestGetAdAccounts requestExtendedCreditInvoiceGroupField () {
return this.requestExtendedCreditInvoiceGroupField(true);
}
public APIRequestGetAdAccounts requestExtendedCreditInvoiceGroupField (boolean value) {
this.requestField("extended_credit_invoice_group", value);
return this;
}
public APIRequestGetAdAccounts requestFailedDeliveryChecksField () {
return this.requestFailedDeliveryChecksField(true);
}
public APIRequestGetAdAccounts requestFailedDeliveryChecksField (boolean value) {
this.requestField("failed_delivery_checks", value);
return this;
}
public APIRequestGetAdAccounts requestFbEntityField () {
return this.requestFbEntityField(true);
}
public APIRequestGetAdAccounts requestFbEntityField (boolean value) {
this.requestField("fb_entity", value);
return this;
}
public APIRequestGetAdAccounts requestFundingSourceField () {
return this.requestFundingSourceField(true);
}
public APIRequestGetAdAccounts requestFundingSourceField (boolean value) {
this.requestField("funding_source", value);
return this;
}
public APIRequestGetAdAccounts requestFundingSourceDetailsField () {
return this.requestFundingSourceDetailsField(true);
}
public APIRequestGetAdAccounts requestFundingSourceDetailsField (boolean value) {
this.requestField("funding_source_details", value);
return this;
}
public APIRequestGetAdAccounts requestHasMigratedPermissionsField () {
return this.requestHasMigratedPermissionsField(true);
}
public APIRequestGetAdAccounts requestHasMigratedPermissionsField (boolean value) {
this.requestField("has_migrated_permissions", value);
return this;
}
public APIRequestGetAdAccounts requestHasPageAuthorizedAdaccountField () {
return this.requestHasPageAuthorizedAdaccountField(true);
}
public APIRequestGetAdAccounts requestHasPageAuthorizedAdaccountField (boolean value) {
this.requestField("has_page_authorized_adaccount", value);
return this;
}
public APIRequestGetAdAccounts requestIdField () {
return this.requestIdField(true);
}
public APIRequestGetAdAccounts requestIdField (boolean value) {
this.requestField("id", value);
return this;
}
public APIRequestGetAdAccounts requestIoNumberField () {
return this.requestIoNumberField(true);
}
public APIRequestGetAdAccounts requestIoNumberField (boolean value) {
this.requestField("io_number", value);
return this;
}
public APIRequestGetAdAccounts requestIsAttributionSpecSystemDefaultField () {
return this.requestIsAttributionSpecSystemDefaultField(true);
}
public APIRequestGetAdAccounts requestIsAttributionSpecSystemDefaultField (boolean value) {
this.requestField("is_attribution_spec_system_default", value);
return this;
}
public APIRequestGetAdAccounts requestIsDirectDealsEnabledField () {
return this.requestIsDirectDealsEnabledField(true);
}
public APIRequestGetAdAccounts requestIsDirectDealsEnabledField (boolean value) {
this.requestField("is_direct_deals_enabled", value);
return this;
}
public APIRequestGetAdAccounts requestIsIn3dsAuthorizationEnabledMarketField () {
return this.requestIsIn3dsAuthorizationEnabledMarketField(true);
}
public APIRequestGetAdAccounts requestIsIn3dsAuthorizationEnabledMarketField (boolean value) {
this.requestField("is_in_3ds_authorization_enabled_market", value);
return this;
}
public APIRequestGetAdAccounts requestIsNotificationsEnabledField () {
return this.requestIsNotificationsEnabledField(true);
}
public APIRequestGetAdAccounts requestIsNotificationsEnabledField (boolean value) {
this.requestField("is_notifications_enabled", value);
return this;
}
public APIRequestGetAdAccounts requestIsPersonalField () {
return this.requestIsPersonalField(true);
}
public APIRequestGetAdAccounts requestIsPersonalField (boolean value) {
this.requestField("is_personal", value);
return this;
}
public APIRequestGetAdAccounts requestIsPrepayAccountField () {
return this.requestIsPrepayAccountField(true);
}
public APIRequestGetAdAccounts requestIsPrepayAccountField (boolean value) {
this.requestField("is_prepay_account", value);
return this;
}
public APIRequestGetAdAccounts requestIsTaxIdRequiredField () {
return this.requestIsTaxIdRequiredField(true);
}
public APIRequestGetAdAccounts requestIsTaxIdRequiredField (boolean value) {
this.requestField("is_tax_id_required", value);
return this;
}
public APIRequestGetAdAccounts requestLiableAddressField () {
return this.requestLiableAddressField(true);
}
public APIRequestGetAdAccounts requestLiableAddressField (boolean value) {
this.requestField("liable_address", value);
return this;
}
public APIRequestGetAdAccounts requestLineNumbersField () {
return this.requestLineNumbersField(true);
}
public APIRequestGetAdAccounts requestLineNumbersField (boolean value) {
this.requestField("line_numbers", value);
return this;
}
public APIRequestGetAdAccounts requestMediaAgencyField () {
return this.requestMediaAgencyField(true);
}
public APIRequestGetAdAccounts requestMediaAgencyField (boolean value) {
this.requestField("media_agency", value);
return this;
}
public APIRequestGetAdAccounts requestMinCampaignGroupSpendCapField () {
return this.requestMinCampaignGroupSpendCapField(true);
}
public APIRequestGetAdAccounts requestMinCampaignGroupSpendCapField (boolean value) {
this.requestField("min_campaign_group_spend_cap", value);
return this;
}
public APIRequestGetAdAccounts requestMinDailyBudgetField () {
return this.requestMinDailyBudgetField(true);
}
public APIRequestGetAdAccounts requestMinDailyBudgetField (boolean value) {
this.requestField("min_daily_budget", value);
return this;
}
public APIRequestGetAdAccounts requestNameField () {
return this.requestNameField(true);
}
public APIRequestGetAdAccounts requestNameField (boolean value) {
this.requestField("name", value);
return this;
}
public APIRequestGetAdAccounts requestOffsitePixelsTosAcceptedField () {
return this.requestOffsitePixelsTosAcceptedField(true);
}
public APIRequestGetAdAccounts requestOffsitePixelsTosAcceptedField (boolean value) {
this.requestField("offsite_pixels_tos_accepted", value);
return this;
}
public APIRequestGetAdAccounts requestOwnerField () {
return this.requestOwnerField(true);
}
public APIRequestGetAdAccounts requestOwnerField (boolean value) {
this.requestField("owner", value);
return this;
}
public APIRequestGetAdAccounts requestOwnerBusinessField () {
return this.requestOwnerBusinessField(true);
}
public APIRequestGetAdAccounts requestOwnerBusinessField (boolean value) {
this.requestField("owner_business", value);
return this;
}
public APIRequestGetAdAccounts requestPartnerField () {
return this.requestPartnerField(true);
}
public APIRequestGetAdAccounts requestPartnerField (boolean value) {
this.requestField("partner", value);
return this;
}
public APIRequestGetAdAccounts requestRfSpecField () {
return this.requestRfSpecField(true);
}
public APIRequestGetAdAccounts requestRfSpecField (boolean value) {
this.requestField("rf_spec", value);
return this;
}
public APIRequestGetAdAccounts requestSendBillToAddressField () {
return this.requestSendBillToAddressField(true);
}
public APIRequestGetAdAccounts requestSendBillToAddressField (boolean value) {
this.requestField("send_bill_to_address", value);
return this;
}
public APIRequestGetAdAccounts requestShowCheckoutExperienceField () {
return this.requestShowCheckoutExperienceField(true);
}
public APIRequestGetAdAccounts requestShowCheckoutExperienceField (boolean value) {
this.requestField("show_checkout_experience", value);
return this;
}
public APIRequestGetAdAccounts requestSoldToAddressField () {
return this.requestSoldToAddressField(true);
}
public APIRequestGetAdAccounts requestSoldToAddressField (boolean value) {
this.requestField("sold_to_address", value);
return this;
}
public APIRequestGetAdAccounts requestSpendCapField () {
return this.requestSpendCapField(true);
}
public APIRequestGetAdAccounts requestSpendCapField (boolean value) {
this.requestField("spend_cap", value);
return this;
}
public APIRequestGetAdAccounts requestTaxIdField () {
return this.requestTaxIdField(true);
}
public APIRequestGetAdAccounts requestTaxIdField (boolean value) {
this.requestField("tax_id", value);
return this;
}
public APIRequestGetAdAccounts requestTaxIdStatusField () {
return this.requestTaxIdStatusField(true);
}
public APIRequestGetAdAccounts requestTaxIdStatusField (boolean value) {
this.requestField("tax_id_status", value);
return this;
}
public APIRequestGetAdAccounts requestTaxIdTypeField () {
return this.requestTaxIdTypeField(true);
}
public APIRequestGetAdAccounts requestTaxIdTypeField (boolean value) {
this.requestField("tax_id_type", value);
return this;
}
public APIRequestGetAdAccounts requestTimezoneIdField () {
return this.requestTimezoneIdField(true);
}
public APIRequestGetAdAccounts requestTimezoneIdField (boolean value) {
this.requestField("timezone_id", value);
return this;
}
public APIRequestGetAdAccounts requestTimezoneNameField () {
return this.requestTimezoneNameField(true);
}
public APIRequestGetAdAccounts requestTimezoneNameField (boolean value) {
this.requestField("timezone_name", value);
return this;
}
public APIRequestGetAdAccounts requestTimezoneOffsetHoursUtcField () {
return this.requestTimezoneOffsetHoursUtcField(true);
}
public APIRequestGetAdAccounts requestTimezoneOffsetHoursUtcField (boolean value) {
this.requestField("timezone_offset_hours_utc", value);
return this;
}
public APIRequestGetAdAccounts requestTosAcceptedField () {
return this.requestTosAcceptedField(true);
}
public APIRequestGetAdAccounts requestTosAcceptedField (boolean value) {
this.requestField("tos_accepted", value);
return this;
}
public APIRequestGetAdAccounts requestUserAccessExpireTimeField () {
return this.requestUserAccessExpireTimeField(true);
}
public APIRequestGetAdAccounts requestUserAccessExpireTimeField (boolean value) {
this.requestField("user_access_expire_time", value);
return this;
}
public APIRequestGetAdAccounts requestUserTasksField () {
return this.requestUserTasksField(true);
}
public APIRequestGetAdAccounts requestUserTasksField (boolean value) {
this.requestField("user_tasks", value);
return this;
}
public APIRequestGetAdAccounts requestUserTosAcceptedField () {
return this.requestUserTosAcceptedField(true);
}
public APIRequestGetAdAccounts requestUserTosAcceptedField (boolean value) {
this.requestField("user_tos_accepted", value);
return this;
}
public APIRequestGetAdAccounts requestViewableBusinessField () {
return this.requestViewableBusinessField(true);
}
public APIRequestGetAdAccounts requestViewableBusinessField (boolean value) {
this.requestField("viewable_business", value);
return this;
}
}
public static class APIRequestGetAdSets extends APIRequest {
APINodeList lastResponse = null;
@Override
public APINodeList getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
};
public static final String[] FIELDS = {
"account_id",
"adlabels",
"adset_schedule",
"asset_feed_id",
"attribution_spec",
"bid_adjustments",
"bid_amount",
"bid_constraints",
"bid_info",
"bid_strategy",
"billing_event",
"brand_safety_config",
"budget_remaining",
"campaign",
"campaign_active_time",
"campaign_attribution",
"campaign_id",
"configured_status",
"created_time",
"creative_sequence",
"daily_budget",
"daily_min_spend_target",
"daily_spend_cap",
"destination_type",
"dsa_beneficiary",
"dsa_payor",
"effective_status",
"end_time",
"existing_customer_budget_percentage",
"frequency_control_specs",
"full_funnel_exploration_mode",
"id",
"instagram_actor_id",
"is_budget_schedule_enabled",
"is_dynamic_creative",
"issues_info",
"learning_stage_info",
"lifetime_budget",
"lifetime_imps",
"lifetime_min_spend_target",
"lifetime_spend_cap",
"multi_optimization_goal_weight",
"name",
"optimization_goal",
"optimization_sub_event",
"pacing_type",
"promoted_object",
"recommendations",
"recurring_budget_semantics",
"regional_regulated_categories",
"regional_regulation_identities",
"review_feedback",
"rf_prediction_id",
"source_adset",
"source_adset_id",
"start_time",
"status",
"targeting",
"targeting_optimization_types",
"time_based_ad_rotation_id_blocks",
"time_based_ad_rotation_intervals",
"updated_time",
"use_new_app_click",
};
@Override
public APINodeList parseResponse(String response, String header) throws APIException {
return AdSet.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 APIRequestGetAdSets.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestGetAdSets(String nodeId, APIContext context) {
super(context, nodeId, "/adsets", "GET", Arrays.asList(PARAMS));
}
@Override
public APIRequestGetAdSets setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestGetAdSets setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestGetAdSets requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestGetAdSets requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetAdSets requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestGetAdSets requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetAdSets requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestGetAdSets requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
public APIRequestGetAdSets requestAccountIdField () {
return this.requestAccountIdField(true);
}
public APIRequestGetAdSets requestAccountIdField (boolean value) {
this.requestField("account_id", value);
return this;
}
public APIRequestGetAdSets requestAdlabelsField () {
return this.requestAdlabelsField(true);
}
public APIRequestGetAdSets requestAdlabelsField (boolean value) {
this.requestField("adlabels", value);
return this;
}
public APIRequestGetAdSets requestAdsetScheduleField () {
return this.requestAdsetScheduleField(true);
}
public APIRequestGetAdSets requestAdsetScheduleField (boolean value) {
this.requestField("adset_schedule", value);
return this;
}
public APIRequestGetAdSets requestAssetFeedIdField () {
return this.requestAssetFeedIdField(true);
}
public APIRequestGetAdSets requestAssetFeedIdField (boolean value) {
this.requestField("asset_feed_id", value);
return this;
}
public APIRequestGetAdSets requestAttributionSpecField () {
return this.requestAttributionSpecField(true);
}
public APIRequestGetAdSets requestAttributionSpecField (boolean value) {
this.requestField("attribution_spec", value);
return this;
}
public APIRequestGetAdSets requestBidAdjustmentsField () {
return this.requestBidAdjustmentsField(true);
}
public APIRequestGetAdSets requestBidAdjustmentsField (boolean value) {
this.requestField("bid_adjustments", value);
return this;
}
public APIRequestGetAdSets requestBidAmountField () {
return this.requestBidAmountField(true);
}
public APIRequestGetAdSets requestBidAmountField (boolean value) {
this.requestField("bid_amount", value);
return this;
}
public APIRequestGetAdSets requestBidConstraintsField () {
return this.requestBidConstraintsField(true);
}
public APIRequestGetAdSets requestBidConstraintsField (boolean value) {
this.requestField("bid_constraints", value);
return this;
}
public APIRequestGetAdSets requestBidInfoField () {
return this.requestBidInfoField(true);
}
public APIRequestGetAdSets requestBidInfoField (boolean value) {
this.requestField("bid_info", value);
return this;
}
public APIRequestGetAdSets requestBidStrategyField () {
return this.requestBidStrategyField(true);
}
public APIRequestGetAdSets requestBidStrategyField (boolean value) {
this.requestField("bid_strategy", value);
return this;
}
public APIRequestGetAdSets requestBillingEventField () {
return this.requestBillingEventField(true);
}
public APIRequestGetAdSets requestBillingEventField (boolean value) {
this.requestField("billing_event", value);
return this;
}
public APIRequestGetAdSets requestBrandSafetyConfigField () {
return this.requestBrandSafetyConfigField(true);
}
public APIRequestGetAdSets requestBrandSafetyConfigField (boolean value) {
this.requestField("brand_safety_config", value);
return this;
}
public APIRequestGetAdSets requestBudgetRemainingField () {
return this.requestBudgetRemainingField(true);
}
public APIRequestGetAdSets requestBudgetRemainingField (boolean value) {
this.requestField("budget_remaining", value);
return this;
}
public APIRequestGetAdSets requestCampaignField () {
return this.requestCampaignField(true);
}
public APIRequestGetAdSets requestCampaignField (boolean value) {
this.requestField("campaign", value);
return this;
}
public APIRequestGetAdSets requestCampaignActiveTimeField () {
return this.requestCampaignActiveTimeField(true);
}
public APIRequestGetAdSets requestCampaignActiveTimeField (boolean value) {
this.requestField("campaign_active_time", value);
return this;
}
public APIRequestGetAdSets requestCampaignAttributionField () {
return this.requestCampaignAttributionField(true);
}
public APIRequestGetAdSets requestCampaignAttributionField (boolean value) {
this.requestField("campaign_attribution", value);
return this;
}
public APIRequestGetAdSets requestCampaignIdField () {
return this.requestCampaignIdField(true);
}
public APIRequestGetAdSets requestCampaignIdField (boolean value) {
this.requestField("campaign_id", value);
return this;
}
public APIRequestGetAdSets requestConfiguredStatusField () {
return this.requestConfiguredStatusField(true);
}
public APIRequestGetAdSets requestConfiguredStatusField (boolean value) {
this.requestField("configured_status", value);
return this;
}
public APIRequestGetAdSets requestCreatedTimeField () {
return this.requestCreatedTimeField(true);
}
public APIRequestGetAdSets requestCreatedTimeField (boolean value) {
this.requestField("created_time", value);
return this;
}
public APIRequestGetAdSets requestCreativeSequenceField () {
return this.requestCreativeSequenceField(true);
}
public APIRequestGetAdSets requestCreativeSequenceField (boolean value) {
this.requestField("creative_sequence", value);
return this;
}
public APIRequestGetAdSets requestDailyBudgetField () {
return this.requestDailyBudgetField(true);
}
public APIRequestGetAdSets requestDailyBudgetField (boolean value) {
this.requestField("daily_budget", value);
return this;
}
public APIRequestGetAdSets requestDailyMinSpendTargetField () {
return this.requestDailyMinSpendTargetField(true);
}
public APIRequestGetAdSets requestDailyMinSpendTargetField (boolean value) {
this.requestField("daily_min_spend_target", value);
return this;
}
public APIRequestGetAdSets requestDailySpendCapField () {
return this.requestDailySpendCapField(true);
}
public APIRequestGetAdSets requestDailySpendCapField (boolean value) {
this.requestField("daily_spend_cap", value);
return this;
}
public APIRequestGetAdSets requestDestinationTypeField () {
return this.requestDestinationTypeField(true);
}
public APIRequestGetAdSets requestDestinationTypeField (boolean value) {
this.requestField("destination_type", value);
return this;
}
public APIRequestGetAdSets requestDsaBeneficiaryField () {
return this.requestDsaBeneficiaryField(true);
}
public APIRequestGetAdSets requestDsaBeneficiaryField (boolean value) {
this.requestField("dsa_beneficiary", value);
return this;
}
public APIRequestGetAdSets requestDsaPayorField () {
return this.requestDsaPayorField(true);
}
public APIRequestGetAdSets requestDsaPayorField (boolean value) {
this.requestField("dsa_payor", value);
return this;
}
public APIRequestGetAdSets requestEffectiveStatusField () {
return this.requestEffectiveStatusField(true);
}
public APIRequestGetAdSets requestEffectiveStatusField (boolean value) {
this.requestField("effective_status", value);
return this;
}
public APIRequestGetAdSets requestEndTimeField () {
return this.requestEndTimeField(true);
}
public APIRequestGetAdSets requestEndTimeField (boolean value) {
this.requestField("end_time", value);
return this;
}
public APIRequestGetAdSets requestExistingCustomerBudgetPercentageField () {
return this.requestExistingCustomerBudgetPercentageField(true);
}
public APIRequestGetAdSets requestExistingCustomerBudgetPercentageField (boolean value) {
this.requestField("existing_customer_budget_percentage", value);
return this;
}
public APIRequestGetAdSets requestFrequencyControlSpecsField () {
return this.requestFrequencyControlSpecsField(true);
}
public APIRequestGetAdSets requestFrequencyControlSpecsField (boolean value) {
this.requestField("frequency_control_specs", value);
return this;
}
public APIRequestGetAdSets requestFullFunnelExplorationModeField () {
return this.requestFullFunnelExplorationModeField(true);
}
public APIRequestGetAdSets requestFullFunnelExplorationModeField (boolean value) {
this.requestField("full_funnel_exploration_mode", value);
return this;
}
public APIRequestGetAdSets requestIdField () {
return this.requestIdField(true);
}
public APIRequestGetAdSets requestIdField (boolean value) {
this.requestField("id", value);
return this;
}
public APIRequestGetAdSets requestInstagramActorIdField () {
return this.requestInstagramActorIdField(true);
}
public APIRequestGetAdSets requestInstagramActorIdField (boolean value) {
this.requestField("instagram_actor_id", value);
return this;
}
public APIRequestGetAdSets requestIsBudgetScheduleEnabledField () {
return this.requestIsBudgetScheduleEnabledField(true);
}
public APIRequestGetAdSets requestIsBudgetScheduleEnabledField (boolean value) {
this.requestField("is_budget_schedule_enabled", value);
return this;
}
public APIRequestGetAdSets requestIsDynamicCreativeField () {
return this.requestIsDynamicCreativeField(true);
}
public APIRequestGetAdSets requestIsDynamicCreativeField (boolean value) {
this.requestField("is_dynamic_creative", value);
return this;
}
public APIRequestGetAdSets requestIssuesInfoField () {
return this.requestIssuesInfoField(true);
}
public APIRequestGetAdSets requestIssuesInfoField (boolean value) {
this.requestField("issues_info", value);
return this;
}
public APIRequestGetAdSets requestLearningStageInfoField () {
return this.requestLearningStageInfoField(true);
}
public APIRequestGetAdSets requestLearningStageInfoField (boolean value) {
this.requestField("learning_stage_info", value);
return this;
}
public APIRequestGetAdSets requestLifetimeBudgetField () {
return this.requestLifetimeBudgetField(true);
}
public APIRequestGetAdSets requestLifetimeBudgetField (boolean value) {
this.requestField("lifetime_budget", value);
return this;
}
public APIRequestGetAdSets requestLifetimeImpsField () {
return this.requestLifetimeImpsField(true);
}
public APIRequestGetAdSets requestLifetimeImpsField (boolean value) {
this.requestField("lifetime_imps", value);
return this;
}
public APIRequestGetAdSets requestLifetimeMinSpendTargetField () {
return this.requestLifetimeMinSpendTargetField(true);
}
public APIRequestGetAdSets requestLifetimeMinSpendTargetField (boolean value) {
this.requestField("lifetime_min_spend_target", value);
return this;
}
public APIRequestGetAdSets requestLifetimeSpendCapField () {
return this.requestLifetimeSpendCapField(true);
}
public APIRequestGetAdSets requestLifetimeSpendCapField (boolean value) {
this.requestField("lifetime_spend_cap", value);
return this;
}
public APIRequestGetAdSets requestMultiOptimizationGoalWeightField () {
return this.requestMultiOptimizationGoalWeightField(true);
}
public APIRequestGetAdSets requestMultiOptimizationGoalWeightField (boolean value) {
this.requestField("multi_optimization_goal_weight", value);
return this;
}
public APIRequestGetAdSets requestNameField () {
return this.requestNameField(true);
}
public APIRequestGetAdSets requestNameField (boolean value) {
this.requestField("name", value);
return this;
}
public APIRequestGetAdSets requestOptimizationGoalField () {
return this.requestOptimizationGoalField(true);
}
public APIRequestGetAdSets requestOptimizationGoalField (boolean value) {
this.requestField("optimization_goal", value);
return this;
}
public APIRequestGetAdSets requestOptimizationSubEventField () {
return this.requestOptimizationSubEventField(true);
}
public APIRequestGetAdSets requestOptimizationSubEventField (boolean value) {
this.requestField("optimization_sub_event", value);
return this;
}
public APIRequestGetAdSets requestPacingTypeField () {
return this.requestPacingTypeField(true);
}
public APIRequestGetAdSets requestPacingTypeField (boolean value) {
this.requestField("pacing_type", value);
return this;
}
public APIRequestGetAdSets requestPromotedObjectField () {
return this.requestPromotedObjectField(true);
}
public APIRequestGetAdSets requestPromotedObjectField (boolean value) {
this.requestField("promoted_object", value);
return this;
}
public APIRequestGetAdSets requestRecommendationsField () {
return this.requestRecommendationsField(true);
}
public APIRequestGetAdSets requestRecommendationsField (boolean value) {
this.requestField("recommendations", value);
return this;
}
public APIRequestGetAdSets requestRecurringBudgetSemanticsField () {
return this.requestRecurringBudgetSemanticsField(true);
}
public APIRequestGetAdSets requestRecurringBudgetSemanticsField (boolean value) {
this.requestField("recurring_budget_semantics", value);
return this;
}
public APIRequestGetAdSets requestRegionalRegulatedCategoriesField () {
return this.requestRegionalRegulatedCategoriesField(true);
}
public APIRequestGetAdSets requestRegionalRegulatedCategoriesField (boolean value) {
this.requestField("regional_regulated_categories", value);
return this;
}
public APIRequestGetAdSets requestRegionalRegulationIdentitiesField () {
return this.requestRegionalRegulationIdentitiesField(true);
}
public APIRequestGetAdSets requestRegionalRegulationIdentitiesField (boolean value) {
this.requestField("regional_regulation_identities", value);
return this;
}
public APIRequestGetAdSets requestReviewFeedbackField () {
return this.requestReviewFeedbackField(true);
}
public APIRequestGetAdSets requestReviewFeedbackField (boolean value) {
this.requestField("review_feedback", value);
return this;
}
public APIRequestGetAdSets requestRfPredictionIdField () {
return this.requestRfPredictionIdField(true);
}
public APIRequestGetAdSets requestRfPredictionIdField (boolean value) {
this.requestField("rf_prediction_id", value);
return this;
}
public APIRequestGetAdSets requestSourceAdsetField () {
return this.requestSourceAdsetField(true);
}
public APIRequestGetAdSets requestSourceAdsetField (boolean value) {
this.requestField("source_adset", value);
return this;
}
public APIRequestGetAdSets requestSourceAdsetIdField () {
return this.requestSourceAdsetIdField(true);
}
public APIRequestGetAdSets requestSourceAdsetIdField (boolean value) {
this.requestField("source_adset_id", value);
return this;
}
public APIRequestGetAdSets requestStartTimeField () {
return this.requestStartTimeField(true);
}
public APIRequestGetAdSets requestStartTimeField (boolean value) {
this.requestField("start_time", value);
return this;
}
public APIRequestGetAdSets requestStatusField () {
return this.requestStatusField(true);
}
public APIRequestGetAdSets requestStatusField (boolean value) {
this.requestField("status", value);
return this;
}
public APIRequestGetAdSets requestTargetingField () {
return this.requestTargetingField(true);
}
public APIRequestGetAdSets requestTargetingField (boolean value) {
this.requestField("targeting", value);
return this;
}
public APIRequestGetAdSets requestTargetingOptimizationTypesField () {
return this.requestTargetingOptimizationTypesField(true);
}
public APIRequestGetAdSets requestTargetingOptimizationTypesField (boolean value) {
this.requestField("targeting_optimization_types", value);
return this;
}
public APIRequestGetAdSets requestTimeBasedAdRotationIdBlocksField () {
return this.requestTimeBasedAdRotationIdBlocksField(true);
}
public APIRequestGetAdSets requestTimeBasedAdRotationIdBlocksField (boolean value) {
this.requestField("time_based_ad_rotation_id_blocks", value);
return this;
}
public APIRequestGetAdSets requestTimeBasedAdRotationIntervalsField () {
return this.requestTimeBasedAdRotationIntervalsField(true);
}
public APIRequestGetAdSets requestTimeBasedAdRotationIntervalsField (boolean value) {
this.requestField("time_based_ad_rotation_intervals", value);
return this;
}
public APIRequestGetAdSets requestUpdatedTimeField () {
return this.requestUpdatedTimeField(true);
}
public APIRequestGetAdSets requestUpdatedTimeField (boolean value) {
this.requestField("updated_time", value);
return this;
}
public APIRequestGetAdSets requestUseNewAppClickField () {
return this.requestUseNewAppClickField(true);
}
public APIRequestGetAdSets requestUseNewAppClickField (boolean value) {
this.requestField("use_new_app_click", value);
return this;
}
}
public static class APIRequestGetCampaigns extends APIRequest {
APINodeList lastResponse = null;
@Override
public APINodeList getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
};
public static final String[] FIELDS = {
"account_id",
"adlabels",
"bid_strategy",
"boosted_object_id",
"brand_lift_studies",
"budget_rebalance_flag",
"budget_remaining",
"buying_type",
"campaign_group_active_time",
"can_create_brand_lift_study",
"can_use_spend_cap",
"configured_status",
"created_time",
"daily_budget",
"effective_status",
"has_secondary_skadnetwork_reporting",
"id",
"is_budget_schedule_enabled",
"is_skadnetwork_attribution",
"issues_info",
"last_budget_toggling_time",
"lifetime_budget",
"name",
"objective",
"pacing_type",
"primary_attribution",
"promoted_object",
"recommendations",
"smart_promotion_type",
"source_campaign",
"source_campaign_id",
"source_recommendation_type",
"special_ad_categories",
"special_ad_category",
"special_ad_category_country",
"spend_cap",
"start_time",
"status",
"stop_time",
"topline_id",
"updated_time",
};
@Override
public APINodeList parseResponse(String response, String header) throws APIException {
return Campaign.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 APIRequestGetCampaigns.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestGetCampaigns(String nodeId, APIContext context) {
super(context, nodeId, "/campaigns", "GET", Arrays.asList(PARAMS));
}
@Override
public APIRequestGetCampaigns setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestGetCampaigns setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestGetCampaigns requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestGetCampaigns requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetCampaigns requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestGetCampaigns requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestGetCampaigns requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestGetCampaigns requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
public APIRequestGetCampaigns requestAccountIdField () {
return this.requestAccountIdField(true);
}
public APIRequestGetCampaigns requestAccountIdField (boolean value) {
this.requestField("account_id", value);
return this;
}
public APIRequestGetCampaigns requestAdlabelsField () {
return this.requestAdlabelsField(true);
}
public APIRequestGetCampaigns requestAdlabelsField (boolean value) {
this.requestField("adlabels", value);
return this;
}
public APIRequestGetCampaigns requestBidStrategyField () {
return this.requestBidStrategyField(true);
}
public APIRequestGetCampaigns requestBidStrategyField (boolean value) {
this.requestField("bid_strategy", value);
return this;
}
public APIRequestGetCampaigns requestBoostedObjectIdField () {
return this.requestBoostedObjectIdField(true);
}
public APIRequestGetCampaigns requestBoostedObjectIdField (boolean value) {
this.requestField("boosted_object_id", value);
return this;
}
public APIRequestGetCampaigns requestBrandLiftStudiesField () {
return this.requestBrandLiftStudiesField(true);
}
public APIRequestGetCampaigns requestBrandLiftStudiesField (boolean value) {
this.requestField("brand_lift_studies", value);
return this;
}
public APIRequestGetCampaigns requestBudgetRebalanceFlagField () {
return this.requestBudgetRebalanceFlagField(true);
}
public APIRequestGetCampaigns requestBudgetRebalanceFlagField (boolean value) {
this.requestField("budget_rebalance_flag", value);
return this;
}
public APIRequestGetCampaigns requestBudgetRemainingField () {
return this.requestBudgetRemainingField(true);
}
public APIRequestGetCampaigns requestBudgetRemainingField (boolean value) {
this.requestField("budget_remaining", value);
return this;
}
public APIRequestGetCampaigns requestBuyingTypeField () {
return this.requestBuyingTypeField(true);
}
public APIRequestGetCampaigns requestBuyingTypeField (boolean value) {
this.requestField("buying_type", value);
return this;
}
public APIRequestGetCampaigns requestCampaignGroupActiveTimeField () {
return this.requestCampaignGroupActiveTimeField(true);
}
public APIRequestGetCampaigns requestCampaignGroupActiveTimeField (boolean value) {
this.requestField("campaign_group_active_time", value);
return this;
}
public APIRequestGetCampaigns requestCanCreateBrandLiftStudyField () {
return this.requestCanCreateBrandLiftStudyField(true);
}
public APIRequestGetCampaigns requestCanCreateBrandLiftStudyField (boolean value) {
this.requestField("can_create_brand_lift_study", value);
return this;
}
public APIRequestGetCampaigns requestCanUseSpendCapField () {
return this.requestCanUseSpendCapField(true);
}
public APIRequestGetCampaigns requestCanUseSpendCapField (boolean value) {
this.requestField("can_use_spend_cap", value);
return this;
}
public APIRequestGetCampaigns requestConfiguredStatusField () {
return this.requestConfiguredStatusField(true);
}
public APIRequestGetCampaigns requestConfiguredStatusField (boolean value) {
this.requestField("configured_status", value);
return this;
}
public APIRequestGetCampaigns requestCreatedTimeField () {
return this.requestCreatedTimeField(true);
}
public APIRequestGetCampaigns requestCreatedTimeField (boolean value) {
this.requestField("created_time", value);
return this;
}
public APIRequestGetCampaigns requestDailyBudgetField () {
return this.requestDailyBudgetField(true);
}
public APIRequestGetCampaigns requestDailyBudgetField (boolean value) {
this.requestField("daily_budget", value);
return this;
}
public APIRequestGetCampaigns requestEffectiveStatusField () {
return this.requestEffectiveStatusField(true);
}
public APIRequestGetCampaigns requestEffectiveStatusField (boolean value) {
this.requestField("effective_status", value);
return this;
}
public APIRequestGetCampaigns requestHasSecondarySkadnetworkReportingField () {
return this.requestHasSecondarySkadnetworkReportingField(true);
}
public APIRequestGetCampaigns requestHasSecondarySkadnetworkReportingField (boolean value) {
this.requestField("has_secondary_skadnetwork_reporting", value);
return this;
}
public APIRequestGetCampaigns requestIdField () {
return this.requestIdField(true);
}
public APIRequestGetCampaigns requestIdField (boolean value) {
this.requestField("id", value);
return this;
}
public APIRequestGetCampaigns requestIsBudgetScheduleEnabledField () {
return this.requestIsBudgetScheduleEnabledField(true);
}
public APIRequestGetCampaigns requestIsBudgetScheduleEnabledField (boolean value) {
this.requestField("is_budget_schedule_enabled", value);
return this;
}
public APIRequestGetCampaigns requestIsSkadnetworkAttributionField () {
return this.requestIsSkadnetworkAttributionField(true);
}
public APIRequestGetCampaigns requestIsSkadnetworkAttributionField (boolean value) {
this.requestField("is_skadnetwork_attribution", value);
return this;
}
public APIRequestGetCampaigns requestIssuesInfoField () {
return this.requestIssuesInfoField(true);
}
public APIRequestGetCampaigns requestIssuesInfoField (boolean value) {
this.requestField("issues_info", value);
return this;
}
public APIRequestGetCampaigns requestLastBudgetTogglingTimeField () {
return this.requestLastBudgetTogglingTimeField(true);
}
public APIRequestGetCampaigns requestLastBudgetTogglingTimeField (boolean value) {
this.requestField("last_budget_toggling_time", value);
return this;
}
public APIRequestGetCampaigns requestLifetimeBudgetField () {
return this.requestLifetimeBudgetField(true);
}
public APIRequestGetCampaigns requestLifetimeBudgetField (boolean value) {
this.requestField("lifetime_budget", value);
return this;
}
public APIRequestGetCampaigns requestNameField () {
return this.requestNameField(true);
}
public APIRequestGetCampaigns requestNameField (boolean value) {
this.requestField("name", value);
return this;
}
public APIRequestGetCampaigns requestObjectiveField () {
return this.requestObjectiveField(true);
}
public APIRequestGetCampaigns requestObjectiveField (boolean value) {
this.requestField("objective", value);
return this;
}
public APIRequestGetCampaigns requestPacingTypeField () {
return this.requestPacingTypeField(true);
}
public APIRequestGetCampaigns requestPacingTypeField (boolean value) {
this.requestField("pacing_type", value);
return this;
}
public APIRequestGetCampaigns requestPrimaryAttributionField () {
return this.requestPrimaryAttributionField(true);
}
public APIRequestGetCampaigns requestPrimaryAttributionField (boolean value) {
this.requestField("primary_attribution", value);
return this;
}
public APIRequestGetCampaigns requestPromotedObjectField () {
return this.requestPromotedObjectField(true);
}
public APIRequestGetCampaigns requestPromotedObjectField (boolean value) {
this.requestField("promoted_object", value);
return this;
}
public APIRequestGetCampaigns requestRecommendationsField () {
return this.requestRecommendationsField(true);
}
public APIRequestGetCampaigns requestRecommendationsField (boolean value) {
this.requestField("recommendations", value);
return this;
}
public APIRequestGetCampaigns requestSmartPromotionTypeField () {
return this.requestSmartPromotionTypeField(true);
}
public APIRequestGetCampaigns requestSmartPromotionTypeField (boolean value) {
this.requestField("smart_promotion_type", value);
return this;
}
public APIRequestGetCampaigns requestSourceCampaignField () {
return this.requestSourceCampaignField(true);
}
public APIRequestGetCampaigns requestSourceCampaignField (boolean value) {
this.requestField("source_campaign", value);
return this;
}
public APIRequestGetCampaigns requestSourceCampaignIdField () {
return this.requestSourceCampaignIdField(true);
}
public APIRequestGetCampaigns requestSourceCampaignIdField (boolean value) {
this.requestField("source_campaign_id", value);
return this;
}
public APIRequestGetCampaigns requestSourceRecommendationTypeField () {
return this.requestSourceRecommendationTypeField(true);
}
public APIRequestGetCampaigns requestSourceRecommendationTypeField (boolean value) {
this.requestField("source_recommendation_type", value);
return this;
}
public APIRequestGetCampaigns requestSpecialAdCategoriesField () {
return this.requestSpecialAdCategoriesField(true);
}
public APIRequestGetCampaigns requestSpecialAdCategoriesField (boolean value) {
this.requestField("special_ad_categories", value);
return this;
}
public APIRequestGetCampaigns requestSpecialAdCategoryField () {
return this.requestSpecialAdCategoryField(true);
}
public APIRequestGetCampaigns requestSpecialAdCategoryField (boolean value) {
this.requestField("special_ad_category", value);
return this;
}
public APIRequestGetCampaigns requestSpecialAdCategoryCountryField () {
return this.requestSpecialAdCategoryCountryField(true);
}
public APIRequestGetCampaigns requestSpecialAdCategoryCountryField (boolean value) {
this.requestField("special_ad_category_country", value);
return this;
}
public APIRequestGetCampaigns requestSpendCapField () {
return this.requestSpendCapField(true);
}
public APIRequestGetCampaigns requestSpendCapField (boolean value) {
this.requestField("spend_cap", value);
return this;
}
public APIRequestGetCampaigns requestStartTimeField () {
return this.requestStartTimeField(true);
}
public APIRequestGetCampaigns requestStartTimeField (boolean value) {
this.requestField("start_time", value);
return this;
}
public APIRequestGetCampaigns requestStatusField () {
return this.requestStatusField(true);
}
public APIRequestGetCampaigns requestStatusField (boolean value) {
this.requestField("status", value);
return this;
}
public APIRequestGetCampaigns requestStopTimeField () {
return this.requestStopTimeField(true);
}
public APIRequestGetCampaigns requestStopTimeField (boolean value) {
this.requestField("stop_time", value);
return this;
}
public APIRequestGetCampaigns requestToplineIdField () {
return this.requestToplineIdField(true);
}
public APIRequestGetCampaigns requestToplineIdField (boolean value) {
this.requestField("topline_id", value);
return this;
}
public APIRequestGetCampaigns requestUpdatedTimeField () {
return this.requestUpdatedTimeField(true);
}
public APIRequestGetCampaigns requestUpdatedTimeField (boolean value) {
this.requestField("updated_time", value);
return this;
}
}
public static class APIRequestGet extends APIRequest {
AdStudyCell lastResponse = null;
@Override
public AdStudyCell getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
};
public static final String[] FIELDS = {
"ad_entities_count",
"control_percentage",
"id",
"name",
"treatment_percentage",
};
@Override
public AdStudyCell parseResponse(String response, String header) throws APIException {
return AdStudyCell.parseResponse(response, getContext(), this, header).head();
}
@Override
public AdStudyCell execute() throws APIException {
return execute(new HashMap());
}
@Override
public AdStudyCell 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 AdStudyCell 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 requestAdEntitiesCountField () {
return this.requestAdEntitiesCountField(true);
}
public APIRequestGet requestAdEntitiesCountField (boolean value) {
this.requestField("ad_entities_count", value);
return this;
}
public APIRequestGet requestControlPercentageField () {
return this.requestControlPercentageField(true);
}
public APIRequestGet requestControlPercentageField (boolean value) {
this.requestField("control_percentage", value);
return this;
}
public APIRequestGet requestIdField () {
return this.requestIdField(true);
}
public APIRequestGet requestIdField (boolean value) {
this.requestField("id", value);
return this;
}
public APIRequestGet requestNameField () {
return this.requestNameField(true);
}
public APIRequestGet requestNameField (boolean value) {
this.requestField("name", value);
return this;
}
public APIRequestGet requestTreatmentPercentageField () {
return this.requestTreatmentPercentageField(true);
}
public APIRequestGet requestTreatmentPercentageField (boolean value) {
this.requestField("treatment_percentage", value);
return this;
}
}
public static class APIRequestUpdate extends APIRequest {
AdStudyCell lastResponse = null;
@Override
public AdStudyCell getLastResponse() {
return lastResponse;
}
public static final String[] PARAMS = {
"adaccounts",
"adsets",
"campaigns",
"creation_template",
"description",
"name",
};
public static final String[] FIELDS = {
};
@Override
public AdStudyCell parseResponse(String response, String header) throws APIException {
return AdStudyCell.parseResponse(response, getContext(), this, header).head();
}
@Override
public AdStudyCell execute() throws APIException {
return execute(new HashMap());
}
@Override
public AdStudyCell 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 AdStudyCell apply(ResponseWrapper result) {
try {
return APIRequestUpdate.this.parseResponse(result.getBody(), result.getHeader());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
},
MoreExecutors.directExecutor()
);
};
public APIRequestUpdate(String nodeId, APIContext context) {
super(context, nodeId, "/", "POST", Arrays.asList(PARAMS));
}
@Override
public APIRequestUpdate setParam(String param, Object value) {
setParamInternal(param, value);
return this;
}
@Override
public APIRequestUpdate setParams(Map params) {
setParamsInternal(params);
return this;
}
public APIRequestUpdate setAdaccounts (List adaccounts) {
this.setParam("adaccounts", adaccounts);
return this;
}
public APIRequestUpdate setAdaccounts (String adaccounts) {
this.setParam("adaccounts", adaccounts);
return this;
}
public APIRequestUpdate setAdsets (List adsets) {
this.setParam("adsets", adsets);
return this;
}
public APIRequestUpdate setAdsets (String adsets) {
this.setParam("adsets", adsets);
return this;
}
public APIRequestUpdate setCampaigns (List campaigns) {
this.setParam("campaigns", campaigns);
return this;
}
public APIRequestUpdate setCampaigns (String campaigns) {
this.setParam("campaigns", campaigns);
return this;
}
public APIRequestUpdate setCreationTemplate (AdStudyCell.EnumCreationTemplate creationTemplate) {
this.setParam("creation_template", creationTemplate);
return this;
}
public APIRequestUpdate setCreationTemplate (String creationTemplate) {
this.setParam("creation_template", creationTemplate);
return this;
}
public APIRequestUpdate setDescription (String description) {
this.setParam("description", description);
return this;
}
public APIRequestUpdate setName (String name) {
this.setParam("name", name);
return this;
}
public APIRequestUpdate requestAllFields () {
return this.requestAllFields(true);
}
public APIRequestUpdate requestAllFields (boolean value) {
for (String field : FIELDS) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestUpdate requestFields (List fields) {
return this.requestFields(fields, true);
}
@Override
public APIRequestUpdate requestFields (List fields, boolean value) {
for (String field : fields) {
this.requestField(field, value);
}
return this;
}
@Override
public APIRequestUpdate requestField (String field) {
this.requestField(field, true);
return this;
}
@Override
public APIRequestUpdate requestField (String field, boolean value) {
this.requestFieldInternal(field, value);
return this;
}
}
public static enum EnumCreationTemplate {
@SerializedName("AUTOMATIC_PLACEMENTS")
VALUE_AUTOMATIC_PLACEMENTS("AUTOMATIC_PLACEMENTS"),
@SerializedName("BRAND_AWARENESS")
VALUE_BRAND_AWARENESS("BRAND_AWARENESS"),
@SerializedName("FACEBOOK")
VALUE_FACEBOOK("FACEBOOK"),
@SerializedName("FACEBOOK_AUDIENCE_NETWORK")
VALUE_FACEBOOK_AUDIENCE_NETWORK("FACEBOOK_AUDIENCE_NETWORK"),
@SerializedName("FACEBOOK_INSTAGRAM")
VALUE_FACEBOOK_INSTAGRAM("FACEBOOK_INSTAGRAM"),
@SerializedName("FACEBOOK_NEWS_FEED")
VALUE_FACEBOOK_NEWS_FEED("FACEBOOK_NEWS_FEED"),
@SerializedName("FACEBOOK_NEWS_FEED_IN_STREAM_VIDEO")
VALUE_FACEBOOK_NEWS_FEED_IN_STREAM_VIDEO("FACEBOOK_NEWS_FEED_IN_STREAM_VIDEO"),
@SerializedName("HIGH_FREQUENCY")
VALUE_HIGH_FREQUENCY("HIGH_FREQUENCY"),
@SerializedName("INSTAGRAM")
VALUE_INSTAGRAM("INSTAGRAM"),
@SerializedName("IN_STREAM_VIDEO")
VALUE_IN_STREAM_VIDEO("IN_STREAM_VIDEO"),
@SerializedName("LOW_FREQUENCY")
VALUE_LOW_FREQUENCY("LOW_FREQUENCY"),
@SerializedName("MEDIUM_FREQUENCY")
VALUE_MEDIUM_FREQUENCY("MEDIUM_FREQUENCY"),
@SerializedName("MOBILE_OPTIMIZED_VIDEO")
VALUE_MOBILE_OPTIMIZED_VIDEO("MOBILE_OPTIMIZED_VIDEO"),
@SerializedName("PAGE_POST_ENGAGEMENT")
VALUE_PAGE_POST_ENGAGEMENT("PAGE_POST_ENGAGEMENT"),
@SerializedName("REACH")
VALUE_REACH("REACH"),
@SerializedName("TV_COMMERCIAL")
VALUE_TV_COMMERCIAL("TV_COMMERCIAL"),
@SerializedName("TV_FACEBOOK")
VALUE_TV_FACEBOOK("TV_FACEBOOK"),
@SerializedName("VIDEO_VIEW_OPTIMIZATION")
VALUE_VIDEO_VIEW_OPTIMIZATION("VIDEO_VIEW_OPTIMIZATION"),
;
private String value;
private EnumCreationTemplate(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 AdStudyCell copyFrom(AdStudyCell instance) {
this.mAdEntitiesCount = instance.mAdEntitiesCount;
this.mControlPercentage = instance.mControlPercentage;
this.mId = instance.mId;
this.mName = instance.mName;
this.mTreatmentPercentage = instance.mTreatmentPercentage;
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 AdStudyCell.parseResponse(response, context, request, header);
}
};
}
}