com.microsoft.bingads.v13.bulk.entities.BulkCustomAudience Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsoft.bingads Show documentation
Show all versions of microsoft.bingads Show documentation
The Bing Ads Java SDK is a library improving developer experience when working with the Bing Ads services by providing high-level access to features such as Bulk API, OAuth Authorization and SOAP API.
package com.microsoft.bingads.v13.bulk.entities;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import com.microsoft.bingads.internal.functionalinterfaces.BiConsumer;
import com.microsoft.bingads.internal.functionalinterfaces.Function;
import com.microsoft.bingads.v13.bulk.BulkFileReader;
import com.microsoft.bingads.v13.bulk.BulkFileWriter;
import com.microsoft.bingads.v13.bulk.BulkOperation;
import com.microsoft.bingads.v13.bulk.BulkServiceManager;
import com.microsoft.bingads.v13.campaignmanagement.CustomAudience;
import com.microsoft.bingads.v13.campaignmanagement.EntityScope;
import com.microsoft.bingads.v13.internal.bulk.BulkMapping;
import com.microsoft.bingads.v13.internal.bulk.MappingHelpers;
import com.microsoft.bingads.v13.internal.bulk.RowValues;
import com.microsoft.bingads.v13.internal.bulk.SimpleBulkMapping;
import com.microsoft.bingads.v13.internal.bulk.StringExtensions;
import com.microsoft.bingads.v13.internal.bulk.StringTable;
import com.microsoft.bingads.v13.internal.bulk.entities.SingleRecordBulkEntity;
/**
* Represents a custom audience that can be read or written in a bulk file.
*
* This class exposes the {@link BulkCustomAudience#setCustomAudience} and {@link BulkCustomAudience#getCustomAudience}
* methods that can be used to read and write fields of the Custom Audience record in a bulk file.
*
*
* For more information, see Custom Audience at
* https://go.microsoft.com/fwlink/?linkid=846127.
*
*
* @see BulkServiceManager
* @see BulkOperation
* @see BulkFileReader
* @see BulkFileWriter
*/
public class BulkCustomAudience extends SingleRecordBulkEntity {
private CustomAudience customAudience;
private Status status;
private static final List> MAPPINGS;
static {
List> m = new ArrayList>();
m.add(new SimpleBulkMapping(StringTable.Status,
new Function() {
@Override
public String apply(BulkCustomAudience c) {
return c.getStatus() != null ? c.getStatus().value() : null;
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.setStatus(StringExtensions.parseOptional(v, new Function() {
@Override
public Status apply(String value) {
return Status.fromValue(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.Id,
new Function() {
@Override
public Long apply(BulkCustomAudience c) {
return c.getCustomAudience().getId();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setId(StringExtensions.parseOptional(v, new Function() {
@Override
public Long apply(String value) {
return Long.parseLong(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.ParentId,
new Function() {
@Override
public Long apply(BulkCustomAudience c) {
return c.getCustomAudience().getParentId();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setParentId(StringExtensions.parseOptional(v, new Function() {
@Override
public Long apply(String value) {
return Long.parseLong(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.Audience,
new Function() {
@Override
public String apply(BulkCustomAudience c) {
return c.getCustomAudience().getName();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setName(v);
}
}
));
m.add(new SimpleBulkMapping(StringTable.AudienceSearchSize,
new Function() {
@Override
public Long apply(BulkCustomAudience c) {
return c.getCustomAudience().getSearchSize();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setSearchSize(StringExtensions.parseOptional(v, new Function() {
@Override
public Long apply(String value) {
return Long.parseLong(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.Description,
new Function() {
@Override
public String apply(BulkCustomAudience c) {
return c.getCustomAudience().getDescription();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setDescription(v);
}
}
));
m.add(new SimpleBulkMapping(StringTable.MembershipDuration,
new Function() {
@Override
public Integer apply(BulkCustomAudience c) {
return c.getCustomAudience().getMembershipDuration();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setMembershipDuration(StringExtensions.parseOptional(v, new Function() {
@Override
public Integer apply(String value) {
return Integer.parseInt(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.Scope,
new Function() {
@Override
public String apply(BulkCustomAudience c) {
return c.getCustomAudience().getScope() != null ? c.getCustomAudience().getScope().value() : null;
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setScope(StringExtensions.parseOptional(v, new Function() {
@Override
public EntityScope apply(String value) {
return EntityScope.fromValue(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.AudienceNetworkSize,
new Function() {
@Override
public Long apply(BulkCustomAudience c) {
return c.getCustomAudience().getAudienceNetworkSize();
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setAudienceNetworkSize(StringExtensions.parseOptional(v, new Function() {
@Override
public Long apply(String value) {
return Long.parseLong(value);
}
}));
}
}
));
m.add(new SimpleBulkMapping(StringTable.SupportedCampaignTypes,
new Function() {
@Override
public String apply(BulkCustomAudience c) {
return StringExtensions.writeArrayOfstring(c.getCustomAudience().getSupportedCampaignTypes(), ";");
}
},
new BiConsumer() {
@Override
public void accept(String v, BulkCustomAudience c) {
c.getCustomAudience().setSupportedCampaignTypes(StringExtensions.parseArrayOfString(v));
}
}
));
MAPPINGS = Collections.unmodifiableList(m);
}
@Override
public void processMappingsFromRowValues(RowValues values) {
this.setCustomAudience(new CustomAudience());
MappingHelpers.convertToEntity(values, MAPPINGS, this);
}
@Override
public void processMappingsToRowValues(RowValues values, boolean excludeReadonlyData) {
validatePropertyNotNull(getCustomAudience(), "CustomAudience");
MappingHelpers.convertToValues(this, values, MAPPINGS);
}
/**
* Gets the custom audience.
*/
public CustomAudience getCustomAudience() {
return this.customAudience;
}
/**
* Sets the custom audience.
*/
public void setCustomAudience(CustomAudience customAudience) {
this.customAudience = customAudience;
}
/**
* Gets the status of the custom audience.
*
*
* The value is Active if the custom audience is available in the account's shared library.
* The value is Deleted if the custom audience is deleted from the library,
* or should be deleted in a subsequent upload operation.
* Corresponds to the 'Status' field in the bulk file.
*
*/
public Status getStatus() {
return status;
}
/**
* Sets the status of the custom audience.
*
*
* The value is Active if the custom audience is available to be associated with an ad group.
* The value is Deleted if the custom audience is deleted, or should be deleted
* in a subsequent upload operation.
* Corresponds to the 'Status' field in the bulk file.
*
*/
public void setStatus(Status status) {
this.status = status;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy