package com.microsoft.bingads.v11.bulk.entities;
import com.microsoft.bingads.v11.bulk.BulkFileReader;
import com.microsoft.bingads.v11.bulk.BulkFileWriter;
import com.microsoft.bingads.v11.bulk.BulkOperation;
import com.microsoft.bingads.v11.bulk.BulkServiceManager;
import com.microsoft.bingads.v11.campaignmanagement.*;
import com.microsoft.bingads.v11.internal.bulk.StringExtensions;
import com.microsoft.bingads.v11.internal.bulk.StringTable;
import com.microsoft.bingads.internal.UncheckedParseException;
import com.microsoft.bingads.v11.internal.bulk.BulkMapping;
import com.microsoft.bingads.v11.internal.bulk.MappingHelpers;
import com.microsoft.bingads.v11.internal.bulk.RowValues;
import com.microsoft.bingads.v11.internal.bulk.SimpleBulkMapping;
import com.microsoft.bingads.v11.internal.bulk.entities.SingleRecordBulkEntity;
import com.microsoft.bingads.internal.functionalinterfaces.BiConsumer;
import com.microsoft.bingads.internal.functionalinterfaces.Function;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Represents an Ad Group.
* <p/>
* <p>
* This class exposes the {@link #setAdGroup} and {@link #getAdGroup} that can be used to read and write
* fields of the Ad Group record in a bulk file.
* </p>
* <p/>
* <p>
* For more information, see Ad Group at
* <a href="https://go.microsoft.com/fwlink/?linkid=846127">https://go.microsoft.com/fwlink/?linkid=846127</a>.
* </p>
*
* @see BulkServiceManager
* @see BulkOperation
* @see BulkFileReader
* @see BulkFileWriter
*/
public class BulkAdGroup extends SingleRecordBulkEntity {
private Long campaignId;
private String campaignName;
private AdGroup adGroup;
private QualityScoreData qualityScoreData;
private PerformanceData performanceData;
private boolean isExpired;
private static final List<BulkMapping<BulkAdGroup>> MAPPINGS;
private static final BiConsumer<String, BulkAdGroup> orSearchAdDistribution = new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
if (StringTable.On.equals(v)) {
c.getAdGroup().getAdDistribution().add(AdDistribution.SEARCH);
}
}
};
private static final BiConsumer<String, BulkAdGroup> orContentAdDistribution = new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
if (StringTable.On.equals(v)) {
c.getAdGroup().getAdDistribution().add(AdDistribution.CONTENT);
}
}
};
static {
List<BulkMapping<BulkAdGroup>> m = new ArrayList<BulkMapping<BulkAdGroup>>();
m.add(new SimpleBulkMapping<BulkAdGroup, Long>(StringTable.Id,
new Function<BulkAdGroup, Long>() {
@Override
public Long apply(BulkAdGroup c) {
return c.getAdGroup().getId();
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setId(StringExtensions.nullOrLong(v));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.Status,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
if (c.getIsExpired()) {
return "Expired";
}
return c.getAdGroup().getStatus() != null ? c.getAdGroup().getStatus().value() : null;
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
if (v.equals("Expired")) {
c.getAdGroup().setStatus(AdGroupStatus.EXPIRED);
c.setIsExpired(true);
} else {
c.getAdGroup().setStatus(StringExtensions.parseOptional(v, new Function<String, AdGroupStatus>() {
@Override
public AdGroupStatus apply(String value) {
return AdGroupStatus.fromValue(value);
}
}));
}
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, Long>(StringTable.ParentId,
new Function<BulkAdGroup, Long>() {
@Override
public Long apply(BulkAdGroup c) {
return c.getCampaignId();
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.setCampaignId(StringExtensions.parseOptional(v, new Function<String, Long>() {
@Override
public Long apply(String value) {
return Long.parseLong(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.Campaign,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return c.getCampaignName();
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.setCampaignName(v);
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.AdGroup,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return c.getAdGroup().getName();
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setName(v);
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.StartDate,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toDateBulkString(c.getAdGroup().getStartDate());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
try {
c.getAdGroup().setStartDate(StringExtensions.parseDate(v));
} catch (ParseException ex) {
throw new UncheckedParseException(ex);
}
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.EndDate,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toDateBulkString(c.getAdGroup().getEndDate());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
try {
c.getAdGroup().setEndDate(StringExtensions.parseDate(v));
} catch (ParseException ex) {
throw new UncheckedParseException(ex);
}
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.NetworkDistribution,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return c.getAdGroup().getNetwork() != null ? c.getAdGroup().getNetwork().value() : null;
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setNetwork(StringExtensions.parseOptional(v, new Function<String, Network>() {
@Override
public Network apply(String value) {
return Network.fromValue(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.PricingModel,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return c.getAdGroup().getPricingModel() != null ? c.getAdGroup().getPricingModel().value() : null;
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setPricingModel(StringExtensions.parseOptionalUpperCase(v, new Function<String, PricingModel>() {
@Override
public PricingModel apply(String value) {
return PricingModel.fromValue(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.AdRotation,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toAdRotationBulkString(c.getAdGroup().getAdRotation());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setAdRotation(StringExtensions.parseAdRotation(v));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.SearchNetwork,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.isOnOrOff(c.getAdGroup().getAdDistribution(), AdDistribution.SEARCH);
}
},
orSearchAdDistribution
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.ContentNetwork,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.isOnOrOff(c.getAdGroup().getAdDistribution(), AdDistribution.CONTENT);
}
},
orContentAdDistribution
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.SearchBid,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toAdGroupBidBulkString(c.getAdGroup().getSearchBid());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setSearchBid(StringExtensions.parseAdGroupBid(v));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.ContentBid,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toAdGroupBidBulkString(c.getAdGroup().getContentMatchBid());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setContentMatchBid(StringExtensions.parseAdGroupBid(v));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.Language,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return c.getAdGroup().getLanguage();
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setLanguage(v);
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, Integer>(StringTable.BidAdjustment,
new Function<BulkAdGroup, Integer>() {
@Override
public Integer apply(BulkAdGroup c) {
return c.getAdGroup().getNativeBidAdjustment();
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setNativeBidAdjustment(StringExtensions.parseOptionalInteger(v));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.TrackingTemplate,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toOptionalBulkString(c.getAdGroup().getTrackingUrlTemplate());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setTrackingUrlTemplate(StringExtensions.getValueOrEmptyString(v));
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.CustomParameter,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return StringExtensions.toCustomParaBulkString(c.getAdGroup().getUrlCustomParameters());
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
try {
c.getAdGroup().setUrlCustomParameters(StringExtensions.parseCustomParameters(v));
} catch (Exception e) {
e.printStackTrace();
}
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.BidStrategyType,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
try {
return StringExtensions.toBiddingSchemeBulkString(c.getAdGroup().getBiddingScheme());
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
try {
c.getAdGroup().setBiddingScheme(StringExtensions.parseBiddingScheme(v));
} catch (Exception e) {
e.printStackTrace();
}
}
}
));
m.add(new SimpleBulkMapping<BulkAdGroup, String>(StringTable.RemarketingTargetingSetting,
new Function<BulkAdGroup, String>() {
@Override
public String apply(BulkAdGroup c) {
return c.getAdGroup().getRemarketingTargetingSetting() != null ? c.getAdGroup().getRemarketingTargetingSetting().value() : null;
}
},
new BiConsumer<String, BulkAdGroup>() {
@Override
public void accept(String v, BulkAdGroup c) {
c.getAdGroup().setRemarketingTargetingSetting(StringExtensions.parseOptional(v, new Function<String, RemarketingTargetingSetting>() {
@Override
public RemarketingTargetingSetting apply(String value) {
return RemarketingTargetingSetting.fromValue(value);
}
}));
}
}
));
MAPPINGS = Collections.unmodifiableList(m);
}
@Override
public void processMappingsFromRowValues(RowValues values) {
this.setAdGroup(new AdGroup());
getAdGroup().setAdDistribution(new ArrayList<AdDistribution>(2));
MappingHelpers.convertToEntity(values, MAPPINGS, this);
qualityScoreData = QualityScoreData.readFromRowValuesOrNull(values);
performanceData = PerformanceData.readFromRowValuesOrNull(values);
}
@Override
public void processMappingsToRowValues(RowValues values, boolean excludeReadonlyData) {
validatePropertyNotNull(getAdGroup(), "AdGroup");
MappingHelpers.convertToValues(this, values, MAPPINGS);
if (!excludeReadonlyData) {
QualityScoreData.writeToRowValuesIfNotNull(qualityScoreData, values);
PerformanceData.writeToRowValuesIfNotNull(performanceData, values);
}
}
/**
* Gets the identifier of the campaign that contains the ad group.
* <p/>
* <p>
* Corresponds to the 'Parent Id' field in the bulk file.
* </p>
*/
public Long getCampaignId() {
return campaignId;
}
/**
* Sets the identifier of the campaign that contains the ad group.
* <p/>
* <p>
* Corresponds to the 'Parent Id' field in the bulk file.
* </p>
*/
public void setCampaignId(Long campaignId) {
this.campaignId = campaignId;
}
/**
* Gets the name of the campaign that contains the ad group.
* <p/>
* <p>
* Corresponds to the 'Campaign' field in the bulk file.
* </p>
*/
public String getCampaignName() {
return campaignName;
}
/**
* Sets the name of the campaign that contains the ad group.
* <p/>
* <p>
* Corresponds to the 'Campaign' field in the bulk file.
* </p>
*/
public void setCampaignName(String campaignName) {
this.campaignName = campaignName;
}
/**
* Gets the AdGroup Data Object of the Campaign Management Service.
* <p/>
* <p>
* A subset of AdGroup properties are available in the Ad Group record.
* For more information, see Ad Group at
* <a href="https://go.microsoft.com/fwlink/?linkid=846127">https://go.microsoft.com/fwlink/?linkid=846127</a>.
* </p>
*/
public AdGroup getAdGroup() {
return adGroup;
}
/**
* Sets the AdGroup Data Object of the Campaign Management Service.
* <p/>
* <p>
* A subset of AdGroup properties are available in the Ad Group record.
* For more information, see Ad Group at
* <a href="https://go.microsoft.com/fwlink/?linkid=846127">https://go.microsoft.com/fwlink/?linkid=846127</a>.
* </p>
*/
public void setAdGroup(AdGroup adGroup) {
this.adGroup = adGroup;
}
/**
* Gets the quality score data for the ad group.
*/
public QualityScoreData getQualityScoreData() {
return qualityScoreData;
}
/**
* Gets the historical performance data for the ad group.
*/
public PerformanceData getPerformanceData() {
return performanceData;
}
/**
* Gets whether the AdGroup is expired.
*/
public boolean getIsExpired() {
return isExpired;
}
/**
* Sets whether the AdGroup is expired.
*/
private void setIsExpired(boolean isExpired) {
this.isExpired = isExpired;
}
}