com.microsoft.bingads.v10.bulk.entities.BulkAdGroupDeviceOsTarget 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.23.2

Show newest version

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

import com.microsoft.bingads.v10.bulk.BulkServiceManager;
import com.microsoft.bingads.v10.bulk.BulkFileReader;
import com.microsoft.bingads.v10.bulk.BulkFileWriter;
import com.microsoft.bingads.v10.bulk.BulkOperation;

/**
 * Represents a device OS target that is associated with an ad group.
 *
 * This class exposes the {@link BulkDeviceOsTarget#setDeviceOsTarget} and {@link BulkDeviceOsTarget#getDeviceOsTarget}
 * methods that can be used to read and write fields of the Ad Group DeviceOS Target record in a bulk file.
 *
 * 
 *     One {@link BulkAdGroupDeviceOsTarget} exposes a read only list of {@link BulkAdGroupDeviceOsTargetBid}.
 *     Each {@link BulkAdGroupDeviceOsTargetBid} instance corresponds to one Ad Group DeviceOS Target record in the bulk file.
 *     If you upload a {@link BulkAdGroupDeviceOsTarget},
 *     then you are effectively replacing any existing bids for the corresponding device OS target.
 * 
 *
 * 
 *     For more information, see Ad Group DeviceOS Target at
 *     http://go.microsoft.com/fwlink/?LinkID=620259.
 * 
 *
 * @see BulkServiceManager
 * @see BulkOperation
 * @see BulkFileReader
 * @see BulkFileWriter
 */
public class BulkAdGroupDeviceOsTarget extends BulkDeviceOsTarget {

    /**
     * Initializes a new instanced of the BulkAdGroupDeviceOsTarget class.
     */
    public BulkAdGroupDeviceOsTarget() {
        super(BulkAdGroupDeviceOsTargetBid.class);
    }

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

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

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

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

    /**
     * Gets the name of the campaign that target is associated.
     *
     * 
     *     Corresponds to the 'Campaign' field in the bulk file.
     * 
     */
    public String getCampaignName() {
        return getParentEntityName();
    }

    /**
     * Sets the name of the campaign that target is associated.
     *
     * 
     *     Corresponds to the 'Campaign' field in the bulk file.
     * 
     */
    public void setCampaignName(String campaignName) {
        setParentEntityName(campaignName);
    }

    /**
     * Reserved for internal use.
     */
    @Override
    BulkAdGroupDeviceOsTargetBid createBid() {
        return new BulkAdGroupDeviceOsTargetBid();
    }    
}