com.microsoft.bingads.v13.bulk.entities.BulkAdGroupNegativeSites 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 java.util.ArrayList;
import java.util.List;

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.AdGroupNegativeSites;
import com.microsoft.bingads.v13.campaignmanagement.ArrayOfstring;
import com.microsoft.bingads.v13.internal.bulk.entities.BulkAdGroupNegativeSitesIdentifier;

/**
 * 
 * Represents one or more negative sites that are 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 {@link BulkAdGroupNegativeSites} has one or more
 * {@link BulkAdGroupNegativeSite}. Each {@link BulkAdGroupNegativeSite}
 * instance corresponds to one Ad Group Negative Site record in the bulk file.
 * If you upload a {@link BulkAdGroupNegativeSites}, then you are effectively
 * replacing any existing negative sites assigned to the ad group.
 * 
 *
 * @see BulkServiceManager
 * @see BulkOperation
 * @see BulkFileReader
 * @see BulkFileWriter
 */
public class BulkAdGroupNegativeSites extends BulkNegativeSites {

    private AdGroupNegativeSites adGroupNegativeSites;// { get; set; }

    /**
     * Gets the AdGroupNegativeSites Data Object of the Campaign Management Service.
     *
     * 
     * A subset of AdGroupNegativeSites properties are available in the Ad Group
     * Negative Site record. For more information, see Ad Group Negative Site at
     * https://go.microsoft.com/fwlink/?linkid=846127.
     * 
     */
    public AdGroupNegativeSites getAdGroupNegativeSites() {
        return adGroupNegativeSites;
    }

    /**
     * Sets the AdGroupNegativeSites Data Object of the Campaign Management Service.
     *
     * 
     * A subset of AdGroupNegativeSites properties are available in the Ad Group
     * Negative Site record. For more information, see Ad Group Negative Site at
     * https://go.microsoft.com/fwlink/?linkid=846127.
     * 
     */
    public void setAdGroupNegativeSites(AdGroupNegativeSites adGroupNegativeSites) {
        this.adGroupNegativeSites = adGroupNegativeSites;
    }

    private String adGroupName;

    /**
     * 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 getAdGroupName() {
        return adGroupName;
    }

    /**
     * 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 setAdGroupName(String adGroupName) {
        this.adGroupName = adGroupName;
    }

    private String campaignName;

    /**
     * Gets the name of the campaign that the negative site is assigned.
     *
     * 
     *     Corresponds to the 'Campaign' field in the bulk file.
     * 
     */
    public String getCampaignName() {
        return campaignName;
    }

    /**
     * Sets the name of the campaign that the negative site is assigned.
     *
     * 
     *     Corresponds to the 'Campaign' field in the bulk file.
     * 
     */
    public void setCampaignName(String campaignName) {
        this.campaignName = campaignName;
    }

    /**
     * Initializes a new instance of the BulkAdGroupNegativeSites class.
     */
    public BulkAdGroupNegativeSites() {
    }

    BulkAdGroupNegativeSites(BulkAdGroupNegativeSite site) {
        super(site, BulkAdGroupNegativeSite.class, BulkAdGroupNegativeSitesIdentifier.class);
        setDataFromIdentifier(site.getIdentifier());
    }

    /**
     * Reserved for internal use.
     */
    public BulkAdGroupNegativeSites(BulkAdGroupNegativeSitesIdentifier identifier) {
        super(identifier, BulkAdGroupNegativeSite.class, BulkAdGroupNegativeSitesIdentifier.class);
        setDataFromIdentifier(identifier);
    }

    private void setDataFromIdentifier(BulkAdGroupNegativeSitesIdentifier identifier) {
        this.adGroupNegativeSites = new AdGroupNegativeSites();
        this.adGroupNegativeSites.setAdGroupId(identifier.getAdGroupId());

        this.adGroupName = identifier.getAdGroupName();
        this.campaignName = identifier.getCampaignName();
    }

    /**
     * Reserved for internal use.
     */
    @Override
    protected Iterable convertApiToBulkNegativeSites() {
        validateListNotNullOrEmpty(this.adGroupNegativeSites.getNegativeSites(), "AdGroupNegativeSites.NegativeSites");

        List bulkSites = new ArrayList();

        List negativeSites = adGroupNegativeSites.getNegativeSites().getStrings();

        for (String negativeSite : negativeSites) {
            BulkAdGroupNegativeSite bulkSite = new BulkAdGroupNegativeSite();

            if (adGroupNegativeSites.getAdGroupId() != null) {
                bulkSite.setAdGroupId(adGroupNegativeSites.getAdGroupId());
            }
            
            bulkSite.setWebsite(negativeSite);
            bulkSite.setAdGroupName(getAdGroupName());
            bulkSite.setCampaignName(getCampaignName());

            bulkSites.add(bulkSite);
        }

        return bulkSites;
    }

    /**
     * Reserved for internal use.
     */
    private void validateListNotNullOrEmpty(ArrayOfstring negativeSites, String propertyName) {
        super.validateListNotNullOrEmpty(negativeSites, negativeSites.getStrings(), propertyName);
    }

    @Override
    protected void reconstructApiObjects() {
        ArrayOfstring websitesArray = new ArrayOfstring();

        for (BulkAdGroupNegativeSite bulkNegativeSite : getNegativeSites()) {
            websitesArray.getStrings().add(bulkNegativeSite.getWebsite());
        }

        this.adGroupNegativeSites.setNegativeSites(websitesArray);
    }

    /**
     * Reserved for internal use.
     */
    @Override
    protected BulkAdGroupNegativeSitesIdentifier createIdentifier() {
        BulkAdGroupNegativeSitesIdentifier identifier = new BulkAdGroupNegativeSitesIdentifier();
        
        if (adGroupNegativeSites.getAdGroupId() != null) {
            identifier.setAdGroupId(this.adGroupNegativeSites.getAdGroupId());
        }
        
        identifier.setAdGroupName(this.adGroupName);
        identifier.setCampaignName(this.campaignName);

        return identifier;
    }

    /**
     * Reserved for internal use.
     */
    @Override
    protected void validatePropertiesNotNull() {
        validatePropertyNotNull(adGroupNegativeSites, "AdGroupNegativeSites");
    }
}