twitter4jads.impl.TwitterAdsLineItemApiImpl Maven / Gradle / Ivy
The newest version!
package twitter4jads.impl;
import com.google.gson.reflect.TypeToken;
import twitter4jads.*;
import twitter4jads.api.TwitterAdsLineItemApi;
import twitter4jads.models.ads.*;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;;
import twitter4jads.internal.http.HttpParameter;
import twitter4jads.internal.http.HttpResponse;
import twitter4jads.internal.models4j.TwitterException;
import twitter4jads.models.ads.sort.LineItemsSortByField;
import twitter4jads.models.ads.sort.PromotedAccountsSortByField;
import twitter4jads.models.media.TwitterMediaCallToAction;
import twitter4jads.models.video.AssociateMediaCreativeResponse;
import twitter4jads.models.video.TwitterCallToActionType;
import twitter4jads.util.TwitterAdUtil;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.*;
/**
*
* Date: 4/4/16
* Time: 8:01 PM
*/
public class TwitterAdsLineItemApiImpl implements TwitterAdsLineItemApi {
private static final Integer MAX_REQUEST_PARAMETER_SIZE = 200;
private final TwitterAdsClient twitterAdsClient;
public TwitterAdsLineItemApiImpl(TwitterAdsClient twitterAdsClient) {
this.twitterAdsClient = twitterAdsClient;
}
@Override
public BaseAdsResponse createLineItem(String accountId, LineItem lineItem) throws TwitterException {
final String campaignId = lineItem.getCampaignId();
final boolean automaticallySelectBid = lineItem.isAutomaticallySelectBid();
Long bidAmountLocalMicro = null;
BidType bidType;
if (!automaticallySelectBid) {
bidAmountLocalMicro = lineItem.getBidAmtInMicro();
bidType = lineItem.getBidType();
} else {
bidType = BidType.AUTO;
}
final Sentiments includeSentiment = lineItem.getSentiment();
final Boolean matchRelevantPopularQueries = lineItem.getMatchRelevantPopularQueries();
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
final List params =
validateCreateLineItemParameters(Optional.ofNullable(campaignId), bidType, Optional.ofNullable(bidAmountLocalMicro),
automaticallySelectBid, Optional.ofNullable(lineItem.getProductType()),
lineItem.getPlacements(), lineItem.getStatus(), Optional.ofNullable(includeSentiment),
Optional.ofNullable(matchRelevantPopularQueries), Optional.ofNullable(lineItem.getObjective()),
Optional.ofNullable(lineItem.getChargeBy()), Optional.ofNullable(lineItem.getBidUnit()),
Optional.ofNullable(lineItem.getOptimization()), Optional.ofNullable(lineItem.getAdvertiserDomain()),
lineItem.getCategories(), lineItem.getWebEventTag(), lineItem.getName(),
Optional.ofNullable(lineItem.getStartTime()), Optional.ofNullable(lineItem.getEndTime()),
lineItem.getTargetCpaLocalMicro(), lineItem.getBudget(), lineItem.getTrackingTags(), lineItem.getAudienceExpansion());
HttpParameter[] parameters = null;
if (!params.isEmpty()) {
parameters = params.toArray(new HttpParameter[params.size()]);
}
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEMS;
final HttpResponse httpResponse = twitterAdsClient.postRequest(baseUrl, parameters);
try {
Type type = new TypeToken>() {
}.getType();
return TwitterAdUtil.constructBaseAdsResponse(httpResponse, httpResponse.asString(), type);
} catch (IOException e) {
throw new TwitterException("Failed to parse line item.");
}
}
@Override
public BaseAdsResponse updateLineItem(String accountId, String lineItemId, BidType bidType, boolean automaticallySelectBid,
Optional bidAmountLocalMicro, EntityStatus status, Optional includeSentiment,
Optional matchRelevantPopularQueries, Optional chargeBy,
Optional bidUnit, Optional advertiserDomain, String optimization,
String[] iabCategories, String startTime, String endTime, String name,
Long targetCPA, Long budget, String trackingTags, String twitterAudienceExpansion) throws TwitterException {
if (automaticallySelectBid) {
bidAmountLocalMicro = null;
bidType = BidType.AUTO;
}
final List params =
validateUpdateLineItemParameters(accountId, lineItemId, bidType, automaticallySelectBid, bidAmountLocalMicro, status,
includeSentiment, matchRelevantPopularQueries, chargeBy, bidUnit, optimization, advertiserDomain, iabCategories, budget, name, startTime, endTime, targetCPA, trackingTags, twitterAudienceExpansion);
String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEMS +
lineItemId;
Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, params.toArray(new HttpParameter[params.size()]), type, HttpVerb.PUT);
}
@Override
public BaseAdsResponse deleteLineItem(String accountId, String lineItemId) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemId, TwitterAdsConstants.LINE_ITEM_ID);
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEMS + lineItemId;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, null, type, HttpVerb.DELETE);
}
@Override
public BaseAdsListResponseIterable getAllLineItems(String accountId, Optional> campaignIds, Optional> lineItemIds,
Optional> fundingInstrumentIds, Optional count, boolean withDeleted,
String cursor, Optional sortByField, Optional q) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
String campaignIdsAsString = null;
String lineItemIdsAsString = null;
String fundingInstrumentIdsAsString = null;
if (campaignIds != null && campaignIds.isPresent()) {
TwitterAdUtil.ensureMaxSize(campaignIds.get(), MAX_REQUEST_PARAMETER_SIZE);
campaignIdsAsString = TwitterAdUtil.getCsv(campaignIds.get());
}
if (lineItemIds != null && lineItemIds.isPresent()) {
TwitterAdUtil.ensureMaxSize(lineItemIds.get(), MAX_REQUEST_PARAMETER_SIZE);
lineItemIdsAsString = TwitterAdUtil.getCsv(lineItemIds.get());
}
if (lineItemIds != null && fundingInstrumentIds.isPresent()) {
TwitterAdUtil.ensureMaxSize(fundingInstrumentIds.get(), MAX_REQUEST_PARAMETER_SIZE);
fundingInstrumentIdsAsString = TwitterAdUtil.getCsv(fundingInstrumentIds.get());
}
final List params =
validateLineItemParameters(accountId, campaignIdsAsString, lineItemIdsAsString, fundingInstrumentIdsAsString, count, withDeleted,
cursor, q);
if (sortByField != null && sortByField.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_SORT_BY, sortByField.get().getField()));
}
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEMS;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpListRequest(baseUrl, params, type);
}
@Override
public BaseAdsResponse getLineItemById(String accountId, String lineItemId, boolean withDeleted) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemId, TwitterAdsConstants.LINE_ITEM_ID);
String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEMS + lineItemId;
HttpParameter[] params = new HttpParameter[]{new HttpParameter(TwitterAdsConstants.PARAM_WITH_DELETED, withDeleted)};
Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, params, type, HttpVerb.GET);
}
@Override
public BaseAdsResponse createPromotedAccounts(String accountId, String lineItemId, String userId) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemId, TwitterAdsConstants.LINE_ITEM_ID);
TwitterAdUtil.ensureNotNull(userId, "User Id");
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_ID, lineItemId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_USER_ID, userId));
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_PROMOTED_ACCOUNTS;
final HttpResponse httpResponse = twitterAdsClient.postRequest(baseUrl, params.toArray(new HttpParameter[params.size()]));
try {
final Type type = new TypeToken>() {
}.getType();
return TwitterAdUtil.constructBaseAdsResponse(httpResponse, httpResponse.asString(), type);
} catch (IOException e) {
throw new TwitterException("Failed to parse promoted accounts.");
}
}
@Override
public BaseAdsResponse createCallToActionDetails(String accountId, String lineItemId,
TwitterCallToActionType twitterCallToActionType,
String callToActionUrl) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemId, TwitterAdsConstants.LINE_ITEM_ID);
TwitterAdUtil.ensureNotNull(callToActionUrl, "Call To Action Url");
TwitterAdUtil.ensureNotNull(twitterCallToActionType, "Call To Action Type");
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_ID, lineItemId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ACCOUNT_ID, accountId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CALL_TO_ACTION, twitterCallToActionType.name()));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CALL_TO_ACTION_URL, callToActionUrl));
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PRE_ROLL_CALL_TO_ACTION;
final HttpResponse httpResponse = twitterAdsClient.postRequest(baseUrl, params.toArray(new HttpParameter[params.size()]));
try {
final Type type = new TypeToken>() {
}.getType();
return TwitterAdUtil.constructBaseAdsResponse(httpResponse, httpResponse.asString(), type);
} catch (IOException e) {
throw new TwitterException("Failed to parse call to action response.");
}
}
//landing url is the url of the media creative
@Override
public BaseAdsResponse associateMediaCreativeWithAccount(String accountId, String lineItemId,
String accountMediaId, String landingUrl)
throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemId, TwitterAdsConstants.LINE_ITEM_ID);
TwitterAdUtil.ensureNotNull(accountMediaId, "Account Media Id");
TwitterAdUtil.ensureNotNull(landingUrl, " Landing Url");
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ACCOUNT_ID, accountId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_ID, lineItemId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ACCOUNT_MEDIA_ID, accountMediaId));
if (TwitterAdUtil.isNotNullOrEmpty(landingUrl)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LANDING_URL, landingUrl));
}
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_MEDIA_CREATIVES;
final HttpResponse httpResponse = twitterAdsClient.postRequest(baseUrl, params.toArray(new HttpParameter[params.size()]));
try {
final Type type = new TypeToken>() {
}.getType();
return TwitterAdUtil.constructBaseAdsResponse(httpResponse, httpResponse.asString(), type);
} catch (IOException e) {
throw new TwitterException("Failed to parse response for associate media to account", e);
}
}
@Deprecated
@Override
public BaseAdsListResponseIterable getPromotedAccounts(String accountId, Optional> promotedAccountIds,
String lineItemId, boolean withDeleted,
PromotedAccountsSortByField sortByField) throws TwitterException {
final Set lineItemIds = new HashSet<>();
if (TwitterAdUtil.isNotNullOrEmpty(lineItemId)) {
lineItemIds.add(lineItemId);
}
return getPromotedAccounts(accountId, promotedAccountIds, Optional.of(lineItemIds), withDeleted, sortByField);
}
@SuppressWarnings("Duplicates")
@Override
public BaseAdsListResponseIterable getPromotedAccounts(String accountId, Optional> promotedAccountIds,
Optional> lineItemIds, boolean withDeleted,
PromotedAccountsSortByField sortByField) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, "accountId");
String promotedAccountsIdsAsString = null;
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_WITH_DELETED, withDeleted));
if (promotedAccountIds != null && promotedAccountIds.isPresent() && TwitterAdUtil.isNotEmpty(promotedAccountIds.get())) {
TwitterAdUtil.ensureMaxSize(promotedAccountIds.get(), MAX_REQUEST_PARAMETER_SIZE);
promotedAccountsIdsAsString = TwitterAdUtil.getCsv(promotedAccountIds.get());
}
if (lineItemIds != null && lineItemIds.isPresent() && TwitterAdUtil.isNotEmpty(lineItemIds.get())) {
TwitterAdUtil.ensureMaxSize(lineItemIds.get(), TwitterAdsConstants.MAX_LINE_ITEM_IDS_REQUEST_SIZE);
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_IDS, TwitterAdUtil.getCsv(lineItemIds.get())));
}
if (TwitterAdUtil.isNotNullOrEmpty(promotedAccountsIdsAsString)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_PROMOTED_ACCOUNTS_IDS, promotedAccountsIdsAsString));
}
if (sortByField != null) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_SORT_BY, sortByField.getField()));
}
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_PROMOTED_ACCOUNTS;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpListRequest(baseUrl, params, type);
}
@Override
public BaseAdsResponse updateCallToAction(String accountId, String channelId, String callToActionUrl,
TwitterCallToActionType twitterCallToActionType) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(channelId, "Channel Id");
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ID, channelId));
if (StringUtils.isNotBlank(callToActionUrl)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CALL_TO_ACTION_URL, callToActionUrl));
}
if (twitterCallToActionType != null) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CALL_TO_ACTION, twitterCallToActionType.name()));
}
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PRE_ROLL_CALL_TO_ACTION + "/" + channelId;
final HttpResponse httpResponse = twitterAdsClient.putRequest(baseUrl, params.toArray(new HttpParameter[params.size()]));
try {
final Type type = new TypeToken>() {
}.getType();
return TwitterAdUtil.constructBaseAdsResponse(httpResponse, httpResponse.asString(), type);
} catch (IOException e) {
throw new TwitterException("Failed to parse call to action response.");
}
}
@Override
public BaseAdsResponse deleteCallToAction(String accountId, String channelId) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(channelId, "Channel Id");
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ID, channelId));
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PRE_ROLL_CALL_TO_ACTION + "/" + channelId;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, params.toArray(new HttpParameter[params.size()]), type, HttpVerb.DELETE);
}
@Override
public BaseAdsResponse publishApp(String accountId, String lineItemId, String appStoreIdentifier,
TwitterOSType twitterOSType) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemId, TwitterAdsConstants.LINE_ITEM_ID);
TwitterAdUtil.ensureNotNull(appStoreIdentifier, "App Store Identifier");
TwitterAdUtil.ensureNotNull(twitterOSType, "Twitter OS Type");
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ACCOUNT_ID, accountId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_ID, lineItemId));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_APP_STORE_IDENTIFIER, appStoreIdentifier));
params.add(new HttpParameter(TwitterAdsConstants.PARAM_OS_TYPE, twitterOSType.name()));
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEM_APPS;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, params.toArray(new HttpParameter[params.size()]), type, HttpVerb.POST);
}
@Override
public BaseAdsResponse getForLineItemAppId(String accountId, String lineItemAppId) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemAppId, "Line Item App Id");
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEM_APPS + "/" + lineItemAppId;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, null, type, HttpVerb.GET);
}
@Deprecated
@Override
public BaseAdsListResponseIterable getForLineItemAppIds(String accountId, String lineItemId, List lineItemAppIds,
Integer count, String cursor, boolean withDeleted)
throws TwitterException {
final Set lineItemIds = new HashSet<>();
if (TwitterAdUtil.isNotNullOrEmpty(lineItemId)) {
lineItemIds.add(lineItemId);
}
return getForLineItemAppIds(accountId, lineItemIds, lineItemAppIds, count, cursor, withDeleted);
}
@Override
public BaseAdsListResponseIterable getForLineItemAppIds(String accountId, Collection lineItemIds,
List lineItemAppIds,
Integer count, String cursor, boolean withDeleted)
throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
if (TwitterAdUtil.isEmpty(lineItemIds) && CollectionUtils.isEmpty(lineItemAppIds) && StringUtils.isBlank(cursor)) {
throw new TwitterException("Details for fetching Apps are missing, either Line Item Id or App Ids or Cursor should be provided");
}
final List params = new ArrayList<>();
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ACCOUNT_ID, accountId));
if (TwitterAdUtil.isNotEmpty(lineItemIds)) {
TwitterAdUtil.ensureMaxSize(lineItemIds, TwitterAdsConstants.MAX_LINE_ITEM_IDS_REQUEST_SIZE);
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_IDS, TwitterAdUtil.getCsv(lineItemIds)));
}
if (StringUtils.isNotBlank(cursor)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CURSOR, cursor));
}
if (CollectionUtils.isNotEmpty(lineItemAppIds)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_APP_IDS, TwitterAdUtil.getCsv(lineItemAppIds)));
}
if (count != null) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_COUNT, count.toString()));
}
params.add(new HttpParameter(TwitterAdsConstants.PARAM_WITH_DELETED, withDeleted));
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEM_APPS;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpListRequest(baseUrl, params, type);
}
@Override
public BaseAdsResponse deleteLineItemApp(String accountId, String lineItemAppId) throws TwitterException {
TwitterAdUtil.ensureNotNull(accountId, TwitterAdsConstants.ACCOUNT_ID);
TwitterAdUtil.ensureNotNull(lineItemAppId, "Line Item App Id");
final String baseUrl = twitterAdsClient.getBaseAdsAPIUrl() + TwitterAdsConstants.PREFIX_ACCOUNTS_URI + accountId + TwitterAdsConstants.PATH_LINE_ITEM_APPS + "/" + lineItemAppId;
final Type type = new TypeToken>() {
}.getType();
return twitterAdsClient.executeHttpRequest(baseUrl, null, type, HttpVerb.DELETE);
}
// -------------------------------------------------------------------- PRIVATE METHODS ---------------------------------------------------------
private List validateCreateLineItemParameters(Optional campaignId, BidType bidType, Optional bidAmountLocalMicro,
boolean automaticallySelectBid, Optional productType, List placements,
EntityStatus status, Optional includeSentiment, Optional matchRelevantPopularQueries,
Optional objective, Optional chargeBy, Optional bidUnit, Optional optimization,
Optional advertiserDomain, String[] categories, String webEventTag, String name,
Optional startTime, Optional endTime,
Long targetCpaLocalMicro, Long budget, List trackingTags, String twitterAudienceExpansion) {
if (bidType == BidType.TARGET || bidType == BidType.MAX) {
TwitterAdUtil.ensureNotNull(bidAmountLocalMicro, "Bid amount cannot be null for TARGET or MAX Bid Type");
}
final List params = new ArrayList<>();
if (campaignId != null && campaignId.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CAMPAIGN_ID, campaignId.get()));
}
if (TwitterAdUtil.isNotNull(bidAmountLocalMicro) && bidAmountLocalMicro.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_AMOUNT_LOCAL_MICRO, bidAmountLocalMicro.get()));
if (bidType != null) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_TYPE, bidType.name()));
}
}
if (chargeBy != null && chargeBy.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CHARGE_BY, chargeBy.get()));
}
if (bidUnit != null && bidUnit.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_UNIT, bidUnit.get()));
}
if (optimization != null && optimization.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_OPTIMIZATION, optimization.get()));
}
if (StringUtils.isNotEmpty(webEventTag)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_PRIMARY_WEB_EVENT_TAG, webEventTag));
}
if (status != null) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ENTITY_STATUS, status.name()));
}
if (includeSentiment != null && includeSentiment.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_INCLUDE_SENTIMENT, includeSentiment.get().name()));
}
if (matchRelevantPopularQueries != null && matchRelevantPopularQueries.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_MATCH_RELEVANT_POPULAR_QUERIES, matchRelevantPopularQueries.get()));
}
if (TwitterAdUtil.isNotEmpty(trackingTags)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_TRACKING_TAGS, TwitterAdUtil.getTrackingTagString(trackingTags)));
}
if (objective != null && objective.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_OBJECTIVE, objective.get()));
// Twitter Audience Platform is supported for these objectives only
if (TwitterAdUtil.ENGAGEMENTS.equals(objective.get()) || TwitterAdUtil.VIDEO_VIEWS.equals(objective.get()) ||
TwitterAdUtil.WEBSITE_CLICKS.equals(objective.get())) {
if (advertiserDomain != null && advertiserDomain.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ADVERTISER_DOMAIN, advertiserDomain.get()));
}
if (categories != null && TwitterAdUtil.isNotEmpty(Arrays.asList(categories))) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CATEGORIES, TwitterAdUtil.getCsv(Arrays.asList(categories))));
}
}
}
if (objective != null && objective.isPresent() &&
TwitterAdUtil.TARGET_CPA_SUPPORTED_OBJECTIVES.contains(TwitterAdObjective.valueOf(objective.get()))) {
if (TwitterAdUtil.isNotNull(targetCpaLocalMicro)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_TARGET_CPA_LOCAL_MICRO, targetCpaLocalMicro));
}
}
if (startTime != null && startTime.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_START_TIME, String.valueOf(startTime)));
}
if (endTime != null && endTime.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_END_TIME, String.valueOf(endTime)));
}
if (TwitterAdUtil.isNotNull(budget)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_TOTAL_BUDGET_AMOUNT_LOCAL_MICRO, budget));
}
if (productType != null && productType.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_PRODUCT_TYPE, productType.get().name()));
}
if (TwitterAdUtil.isNotEmpty(placements)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_PLACEMENTS, TwitterAdUtil.getCsv(placements)));
}
if (TwitterAdUtil.isNotNullOrEmpty(twitterAudienceExpansion)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_AUDIENCE_EXPANSION, twitterAudienceExpansion));
}
return params;
}
private List validateUpdateLineItemParameters(String accountId, String lineItemId, BidType bidType, Boolean automaticallySelectBid,
Optional bidAmountLocalMicro, EntityStatus status, Optional includeSentiment,
Optional matchRelevantPopularQueries, Optional chargeBy, Optional bidUnit, String optimization,
Optional advertiserDomain, String[] iabCategories, Long budget, String name,
String startTime, String endTime, Long targetCPA, String trackingTags, String twitterAudienceExpansion) {
TwitterAdUtil.ensureNotNull(accountId, "AccountId");
TwitterAdUtil.ensureNotNull(lineItemId, "Line Item Id");
TwitterAdUtil.ensureNotNull(bidType, "Bid Type");
if (bidType == BidType.TARGET || bidType == BidType.MAX) {
TwitterAdUtil.ensureNotNull(bidAmountLocalMicro, "Bid amount cannot be null for TARGET or MAX Bid Type");
}
final List params = new ArrayList<>();
if (TwitterAdUtil.isNotNull(bidAmountLocalMicro) && bidAmountLocalMicro.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_AMOUNT_LOCAL_MICRO, bidAmountLocalMicro.get()));
}
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_TYPE, bidType.name()));
if (chargeBy != null && chargeBy.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CHARGE_BY, chargeBy.get()));
}
if (bidUnit != null && bidUnit.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_UNIT, bidUnit.get()));
}
if (TwitterAdUtil.isNotNullOrEmpty(name)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_NAME, name));
}
if (TwitterAdUtil.isNotNull(targetCPA)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_TARGET_CPA_LOCAL_MICRO, targetCPA));
}
if (startTime != null && !startTime.isEmpty()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_START_TIME, String.valueOf(startTime)));
}
if (endTime != null && !endTime.isEmpty()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_END_TIME, String.valueOf(endTime)));
}
if (TwitterAdUtil.isNotNullOrEmpty(optimization)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_OPTIMIZATION, optimization));
}
if (TwitterAdUtil.isNotNullOrEmpty(twitterAudienceExpansion)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_AUDIENCE_EXPANSION, twitterAudienceExpansion));
}
if (bidType == BidType.AUTO) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_BID_AMOUNT_LOCAL_MICRO, "null"));
}
if (status != null) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ENTITY_STATUS, status.name()));
}
if (includeSentiment != null && includeSentiment.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_INCLUDE_SENTIMENT, includeSentiment.get().name()));
}
if (matchRelevantPopularQueries != null && matchRelevantPopularQueries.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_MATCH_RELEVANT_POPULAR_QUERIES, matchRelevantPopularQueries.get()));
}
if (TwitterAdUtil.isNotNull(trackingTags)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_TRACKING_TAGS, trackingTags));
}
String budgetStr = budget == null ? "null" : String.valueOf(budget);
params.add(new HttpParameter(TwitterAdsConstants.PARAM_TOTAL_BUDGET_AMOUNT_LOCAL_MICRO, budgetStr));
// Twitter Audience Platform is supported for these objectives only
if (advertiserDomain != null && advertiserDomain.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_ADVERTISER_DOMAIN, advertiserDomain.get()));
}
if (iabCategories != null && TwitterAdUtil.isNotEmpty(Arrays.asList(iabCategories))) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CATEGORIES, TwitterAdUtil.getCsv(Arrays.asList(iabCategories))));
}
return params;
}
private List validateLineItemParameters(String accountId, String campaignIds, String lineItemIds, String fundingInstrumentIds,
Optional count, boolean withDeleted, String cursor, Optional q) {
TwitterAdUtil.ensureNotNull(accountId, "accountId");
List params = new ArrayList<>();
if (StringUtils.isNotBlank(campaignIds)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CAMPAIGN_IDS, campaignIds));
}
if (StringUtils.isNotBlank(lineItemIds)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_LINE_ITEM_IDS, lineItemIds));
}
if (StringUtils.isNotBlank(fundingInstrumentIds)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_FUNDING_INSTRUMENT_IDS, fundingInstrumentIds));
}
params.add(new HttpParameter(TwitterAdsConstants.PARAM_WITH_DELETED, withDeleted));
if (count != null && count.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_COUNT, count.get()));
}
if (StringUtils.isNotBlank(cursor)) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_CURSOR, cursor));
}
if (q != null && q.isPresent()) {
params.add(new HttpParameter(TwitterAdsConstants.PARAM_Q, q.get()));
}
return params;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy