com.microsoft.bingads.v13.bulk.entities.BulkCampaignNegativeSite 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

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.

There is a newer version: 13.0.22.1

Show newest version

package com.microsoft.bingads.v13.bulk.entities;

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.internal.bulk.entities.BulkCampaignNegativeSitesIdentifier;
import com.microsoft.bingads.v13.internal.bulk.entities.MultiRecordBulkEntity;

/**
 * 
 * Represents a negative site that is 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 {@link BulkCampaignNegativeSites} has one or more
 * {@link BulkCampaignNegativeSite}. Each {@link BulkCampaignNegativeSite}
 * instance corresponds to one Campaign Negative Site record in the bulk file.
 * If you upload a {@link BulkCampaignNegativeSites}, then you are effectively
 * replacing any existing negative sites assigned to the campaign.
 * 
 *
 * @see BulkServiceManager
 * @see BulkOperation
 * @see BulkFileReader
 * @see BulkFileWriter
 */
public class BulkCampaignNegativeSite extends BulkNegativeSite {

    /**
     * Gets the identifier of the campaign that the negative site is assigned.
     *
     * 
     *      Corresponds to the 'Parent Id' field in the bulk file.
     * 
     */
    public long getCampaignId() {
        return this.getIdentifier().getCampaignId();
    }

    /**
     * Sets the identifier of the campaign that the negative site is assigned.
     *
     * 
     *      Corresponds to the 'Parent Id' field in the bulk file.
     * 
     */
    public void setCampaignId(long value) {
        this.getIdentifier().setCampaignId(value);
    }

    /**
     * Gets the name of the ad group that the negative site is assigned.
     *
     * 
     *     Corresponds to the 'Ad Group' field in the bulk file.
     * 
     */
    public String getCampaignName() {
        return this.getIdentifier().getCampaignName();
    }

    /**
     * Sets the name of the ad group that the negative site is assigned.
     *
     * 
     *     Corresponds to the 'Ad Group' field in the bulk file.
     * 
     */
    public void setCampaignName(String value) {
        this.getIdentifier().setCampaignName(value);
    }

    /**
     * Initializes a new instance of the BulkCampaignNegativeSite class.
     */
    public BulkCampaignNegativeSite() {
        super(new BulkCampaignNegativeSitesIdentifier());
    }

    @Override
    MultiRecordBulkEntity createNegativeSitesWithThisNegativeSite() {
        return new BulkCampaignNegativeSites(this);
    }
}