com.microsoft.bingads.v13.bulk.entities.BulkAdGroupNegativeKeyword 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.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.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.StringTable;

/**
 * Represents a negative keyword that is assigned to an ad group. Each negative keyword can be read or written in a bulk file.
 * This class exposes the {@link #setNegativeKeyword} and {@link #getNegativeKeyword} methods that can be used to read and write
 * fields of the Ad Group Negative Keyword record in a bulk file.
 *
 * 
 *     For more information, see Ad Group Negative Keyword at
 *     https://go.microsoft.com/fwlink/?linkid=846127.
 * 
 *
 * @see BulkServiceManager
 * @see BulkOperation
 * @see BulkFileReader
 * @see BulkFileWriter
 */
public class BulkAdGroupNegativeKeyword extends BulkEntityNegativeKeyword {

    private String campaignName;

    private static final List> MAPPINGS;

    static {
        List> m = new ArrayList>();

        m.add(new SimpleBulkMapping(StringTable.Campaign,
                new Function() {
                    @Override
                    public String apply(BulkAdGroupNegativeKeyword c) {
                        return c.getCampaignName();
                    }
                },
                new BiConsumer() {
                    @Override
                    public void accept(String v, BulkAdGroupNegativeKeyword c) {
                        c.setCampaignName(v);
                    }
                }
        ));

        MAPPINGS = Collections.unmodifiableList(m);
    }

    /**
     * Gets the identifier of the ad group that the negative keyword is assigned.
     *
     * 
     *     Corresponds to the 'Parent Id' field in the bulk file.
     * 
     */
    public Long getAdGroupId() {
        return getParentId();
    }

    /**
     * Sets the identifier of the ad group that the negative keyword is assigned.
     *
     * 
     *     Corresponds to the 'Parent Id' field in the bulk file.
     * 
     */
    public void setAdGroupId(Long adGroupId) {
        setParentId(adGroupId);
    }

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

    /**
     * Sets the name of the ad group that the negative keyword is assigned.
     *
     * 
     *     Corresponds to the 'Ad Group' field in the bulk file.
     * 
     */
    public void setAdGroupName(String adGroupName) {
        setEntityName(adGroupName);
    }

    /**
     * Gets the name of the campaign that the negative keyword 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 keyword is assigned.
     *
     * 
     *     Corresponds to the 'Campaign' field in the bulk file.
     * 
     */
    public void setCampaignName(String campaignName) {
        this.campaignName = campaignName;
    }

    @Override
    public void processMappingsFromRowValues(RowValues values) {
        super.processMappingsFromRowValues(values);

        MappingHelpers.convertToEntity(values, MAPPINGS, this);
    }

    @Override
    public void processMappingsToRowValues(RowValues values, boolean excludeReadonlyData) {
        super.processMappingsToRowValues(values, excludeReadonlyData);

        MappingHelpers.convertToValues(this, values, MAPPINGS);
    }

    @Override
    String getEntityColumnName() {
        return StringTable.AdGroup;
    }
}