com.microsoft.bingads.v10.bulk.entities.BulkAdGroupLocationTarget 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.campaignmanagement.CityTargetBid;
import com.microsoft.bingads.v10.campaignmanagement.IntentOption;
import com.microsoft.bingads.v10.campaignmanagement.LocationTarget;
import com.microsoft.bingads.v10.bulk.BulkFileReader;
import com.microsoft.bingads.v10.bulk.BulkFileWriter;
import com.microsoft.bingads.v10.bulk.BulkOperation;
import com.microsoft.bingads.internal.functionalinterfaces.Function;
import com.microsoft.bingads.internal.functionalinterfaces.Consumer;

/**
 * Represents a location target that is associated with an ad group.
 *
 * This class exposes the
 * {@link BulkLocationTargetWithStringLocation#getCityTarget},
 * {@link BulkLocationTargetWithStringLocation#setCityTarget}
 * {@link BulkLocationTargetWithStringLocation#getCountryTarget},
 * {@link BulkLocationTargetWithStringLocation#setCountryTarget},
 * {@link BulkLocationTargetWithStringLocation#getMetroAreaTarget},
 * {@link BulkLocationTargetWithStringLocation#setMetroAreaTarget},
 * {@link BulkLocationTargetWithStringLocation#getPostalCodeTarget},
 * {@link BulkLocationTargetWithStringLocation#setPostalCodeTarget},
 * {@link BulkLocationTargetWithStringLocation#getStateTarget},
 * and {@link BulkLocationTargetWithStringLocation#setStateTarget} methods,
 *
 * that represent geographical location sub types.
 * Each sub type can be read and written as fields of the Ad Group Location Target record in a bulk file.
 *
 * 
 *    Each location sub type contains a list of bids. For example {@link BulkLocationTargetWithStringLocation#getCityTarget}
 *    contains a list of {@link CityTargetBid}. Each {@link CityTargetBid} instance
 *    corresponds to one Ad Group Location Target record in the bulk file.
 *    If you upload a {@link BulkLocationTargetWithStringLocation#getCityTarget},
 *    then you are effectively replacing any existing city bids for the corresponding location target.
 * 
 *
 * 
 *     The {@link BulkLocationTargetBidWithStringLocation#getLocationType} methods determines the geographical location sub type.
 * 
 *
 * 
 *     For more information, see Ad Group Location Target at
 *     http://go.microsoft.com/fwlink/?LinkID=620255.
 * 
 *
 * @see BulkServiceManager
 * @see BulkOperation
 * @see BulkFileReader
 * @see BulkFileWriter
 */
public class BulkAdGroupLocationTarget extends BulkLocationTarget {

    /**
     * Initializes a new instanced of the BulkAdGroupLocationTarget class.
     */
    public BulkAdGroupLocationTarget() {
        super(BulkAdGroupLocationTargetBid.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 thecampaign that target is associated.
     *
     * 
     *     Corresponds to the 'Campaign' field in the bulk file.
     * 
     */
    public void setCampaignName(String campaignName) {
        setParentEntityName(campaignName);
    }

    /**
     * Gets intent options for location targeting.
     */
    public IntentOption getIntentOption() {
        return getLocationProperty(new Function() {
            @Override
            public IntentOption apply(LocationTarget t) {
                return t.getIntentOption();
            }
        });
    }

    /**
     * Sets intent options for location targeting.
     */
    public void setIntentOption(final IntentOption intentOption) {
        setLocationProperty(new Consumer() {
            @Override
            public void accept(LocationTarget locationTarget) {
                locationTarget.setIntentOption(intentOption);
            }
        });
    }

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