com.microsoft.bingads.v13.bulk.entities

Class BulkCampaignNegativeSites

java.lang.Object

com.microsoft.bingads.v13.internal.bulk.BulkObject

com.microsoft.bingads.v13.bulk.entities.BulkEntity

com.microsoft.bingads.v13.internal.bulk.entities.MultiRecordBulkEntity

com.microsoft.bingads.v13.bulk.entities.BulkCampaignNegativeSites

public class BulkCampaignNegativeSites
extends MultiRecordBulkEntity

Represents one or more negative sites that are assigned to a campaign. Each negative site can be read or written in a bulk file. This class exposes properties that can be read and written as fields of the Campaign Negative Site record in a bulk file.

For more information, see Campaign Negative Site at https://go.microsoft.com/fwlink/?linkid=846127

One BulkCampaignNegativeSites has one or more BulkCampaignNegativeSite. Each BulkCampaignNegativeSite instance corresponds to one Campaign Negative Site record in the bulk file. If you upload a BulkCampaignNegativeSites, then you are effectively replacing any existing negative sites assigned to the campaign.

See Also:

BulkServiceManager, BulkOperation, BulkFileReader, BulkFileWriter

Constructor Summary

Constructors

Constructor and Description
BulkCampaignNegativeSites() Initializes a new instance of the BulkCampaignNegativeSites class.
BulkCampaignNegativeSites(BulkCampaignNegativeSitesIdentifier identifier)

Method Summary

Modifier and Type	Method and Description
boolean	allChildrenPresent()
protected Iterable<BulkCampaignNegativeSite>	convertApiToBulkNegativeSites() Reserved for internal use.
protected BulkCampaignNegativeSitesIdentifier	createIdentifier() Reserved for internal use.
String	getCampaignName() Gets the name of the campaign that the negative site is assigned.
CampaignNegativeSites	getCampaignNegativeSites() Gets the CampaignNegativeSites Data Object of the Campaign Management Service.
List<? extends BulkEntity>	getChildEntities() The child entities that this multi record entity contains.
List<TNegativeSite>	getNegativeSites()
Status	getStatus()
void	readRelatedData(BulkRecordReader reader) Reads object data from consecutive rows.
protected void	reconstructApiObjects() Reserved for internal use.
void	setCampaignName(String campaignName) Sets the name of the campaign that the negative site is assigned.
void	setCampaignNegativeSites(CampaignNegativeSites campaignNegativeSites) Sets the CampaignNegativeSites Data Object of the Campaign Management Service.
void	setStatus(Status status)
protected void	validatePropertiesNotNull() Reserved for internal use.
void	write(BulkObjectWriter rowWriter, boolean excludeReadonlyData) Writes object data to consecutive rows.

Methods inherited from class com.microsoft.bingads.v13.internal.bulk.entities.MultiRecordBulkEntity

getLastModifiedTime, hasErrors

Methods inherited from class com.microsoft.bingads.v13.bulk.entities.BulkEntity

validateListNotNullOrEmpty, validatePropertyNotNull

Methods inherited from class com.microsoft.bingads.v13.internal.bulk.BulkObject

canEncloseInMultilineEntity, encloseInMultilineEntity, readFromRowValues, writeToRowValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkCampaignNegativeSites

public BulkCampaignNegativeSites()

Initializes a new instance of the BulkCampaignNegativeSites class.

BulkCampaignNegativeSites

public BulkCampaignNegativeSites(BulkCampaignNegativeSitesIdentifier identifier)

Method Detail

getCampaignNegativeSites

public CampaignNegativeSites getCampaignNegativeSites()

Gets the CampaignNegativeSites Data Object of the Campaign Management Service. A subset of CampaignNegativeSites properties are available in the Campaign Negative Site record.

For more information, see Campaign Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

setCampaignNegativeSites

public void setCampaignNegativeSites(CampaignNegativeSites campaignNegativeSites)

Sets the CampaignNegativeSites Data Object of the Campaign Management Service. A subset of CampaignNegativeSites properties are available in the Campaign Negative Site record.

For more information, see Campaign Negative Site at https://go.microsoft.com/fwlink/?linkid=846127.

getCampaignName

public String getCampaignName()

Gets the name of the campaign that the negative site is assigned.

Corresponds to the 'Campaign' field in the bulk file.

setCampaignName

public void setCampaignName(String campaignName)

Sets the name of the campaign that the negative site is assigned.

Corresponds to the 'Campaign' field in the bulk file.

convertApiToBulkNegativeSites

protected Iterable<BulkCampaignNegativeSite> convertApiToBulkNegativeSites()

Reserved for internal use.

reconstructApiObjects

protected void reconstructApiObjects()

Reserved for internal use.

createIdentifier

protected BulkCampaignNegativeSitesIdentifier createIdentifier()

Reserved for internal use.

validatePropertiesNotNull

protected void validatePropertiesNotNull()

Reserved for internal use.

getStatus

public Status getStatus()

setStatus

public void setStatus(Status status)

getNegativeSites

public List<TNegativeSite> getNegativeSites()

getChildEntities

public List<? extends BulkEntity> getChildEntities()

Description copied from class: MultiRecordBulkEntity

The child entities that this multi record entity contains.

Specified by:

getChildEntities in class MultiRecordBulkEntity

write

public void write(BulkObjectWriter rowWriter,
                  boolean excludeReadonlyData)
           throws IOException

Description copied from class: BulkObject

Writes object data to consecutive rows.

• SingleLineBulkEntity: writes entity.
• MultilineBulkEntity: writes child entities.
• BulkEntityIdentifier: writes identifier information (Id, status etc.)

Overrides:

write in class BulkObject

Throws:

IOException

readRelatedData

public void readRelatedData(BulkRecordReader reader)

Description copied from class: BulkObject

Reads object data from consecutive rows.

• SingleLineBulkEntity: reads entity errors.
• MultilineBulkEntity: reads child entities.

Overrides:

readRelatedData in class BulkObject

allChildrenPresent

public boolean allChildrenPresent()

Specified by:

allChildrenPresent in class MultiRecordBulkEntity

Returns:

True, if the object is fully constructed (contains all of its children), determined by the presence of delete all row, false otherwise