public class BulkAdGroupNegativeSite extends SingleRecordBulkEntity
Represents a negative site that is assigned to an ad group. 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 Ad Group Negative Site record in a bulk file.
For more information, see Ad Group Negative Site at https://go.microsoft.com/fwlink/?linkid=846127
One BulkAdGroupNegativeSites
exposes a read only list of
BulkAdGroupNegativeSite
. Each BulkAdGroupNegativeSite
instance corresponds to one Ad Group Negative Site record in the bulk file.
If you upload a BulkAdGroupNegativeSites
, then you are effectively
replacing any existing negative sites assigned to the ad group.
BulkServiceManager
,
BulkOperation
,
BulkFileReader
,
BulkFileWriter
Constructor and Description |
---|
BulkAdGroupNegativeSite()
Initializes a new instance of the BulkAdGroupNegativeSite class.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canEncloseInMultilineEntity() |
MultiRecordBulkEntity |
encloseInMultilineEntity() |
long |
getAdGroupId()
Gets the identifier of the ad group that the negative site is assigned.
|
String |
getAdGroupName()
Gets the name of the ad group that the negative site is assigned.
|
String |
getCampaignName()
Gets the name of the ad group that the negative site is assigned.
|
TIdentifier |
getIdentifier() |
Status |
getStatus()
Gets the status of the negative site association.
|
String |
getWebsite()
Gets the URL of a website on which you do not want your ads displayed.
|
void |
processMappingsFromRowValues(RowValues values)
Process specific entity mappings from CSV values.
|
void |
processMappingsToRowValues(RowValues values,
boolean excludeReadonlyData)
Process specific entity mappings to CSV values.
|
void |
setAdGroupId(long value)
Sets the identifier of the ad group that the negative site is assigned.
|
void |
setAdGroupName(String value)
Sets the name of the ad group that the negative site is assigned.
|
void |
setCampaignName(String value)
Sets the name of the ad group that the negative site is assigned.
|
void |
setIdentifier(TIdentifier identifier) |
void |
setStatus(Status status)
Sets the status of the negative site association.
|
void |
setWebsite(String website)
Sets the URL of a website on which you do not want your ads displayed.
|
getClientId, getErrors, getLastModifiedTime, hasErrors, readAdditionalData, readFromRowValues, readRelatedData, setClientId, write, writeAdditionalData, writeToRowValues
validateListNotNullOrEmpty, validatePropertyNotNull
public BulkAdGroupNegativeSite()
public long getAdGroupId()
Corresponds to the 'Parent Id' field in the bulk file.
public void setAdGroupId(long value)
Corresponds to the 'Parent Id' field in the bulk file.
public String getAdGroupName()
Corresponds to the 'Ad Group' field in the bulk file.
public void setAdGroupName(String value)
Corresponds to the 'Ad Group' field in the bulk file.
public String getCampaignName()
Corresponds to the 'Ad Group' field in the bulk file.
public void setCampaignName(String value)
Corresponds to the 'Ad Group' field in the bulk file.
public TIdentifier getIdentifier()
public void setIdentifier(TIdentifier identifier)
public Status getStatus()
The value is Active if the negative site is assigned to the parent entity identified by the EntityId. The value is Deleted if the negative site is removed from the parent entity, or should be removed in a subsequent upload operation. Corresponds to the 'Status' field in the bulk file.
public void setStatus(Status status)
The value is Active if the negative site is assigned to the parent entity identified by the EntityId. The value is Deleted if the negative site is removed from the parent entity, or should be removed in a subsequent upload operation. Corresponds to the 'Status' field in the bulk file.
public String getWebsite()
Corresponds to the 'Website' field in the bulk file.
public void setWebsite(String website)
Corresponds to the 'Website' field in the bulk file.
public void processMappingsFromRowValues(RowValues values)
SingleRecordBulkEntity
processMappingsFromRowValues
in class SingleRecordBulkEntity
values
- Set of values and mappings corresponding to one row/single line entitypublic void processMappingsToRowValues(RowValues values, boolean excludeReadonlyData)
SingleRecordBulkEntity
processMappingsToRowValues
in class SingleRecordBulkEntity
values
- Row valuesexcludeReadonlyData
- indicates whether readonly data should be written (such as errors, performance data etc.)public boolean canEncloseInMultilineEntity()
canEncloseInMultilineEntity
in class BulkObject
public MultiRecordBulkEntity encloseInMultilineEntity()
encloseInMultilineEntity
in class BulkObject
Copyright © 2024. All rights reserved.