com.microsoft.bingads.v10.bulk.SubmitDownloadParameters 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;

import java.util.Calendar;
import java.util.Collection;
import java.util.List;

import com.microsoft.bingads.v10.bulk.BulkDownloadEntity;
import com.microsoft.bingads.v10.bulk.DataScope;
import com.microsoft.bingads.v10.bulk.DownloadFileType;
import com.microsoft.bingads.v10.bulk.PerformanceStatsDateRange;

/**
 * Describes the service request parameters such as the type of entities and data scope that you want to download.
 */
public class SubmitDownloadParameters {

    private Collection dataScope;

    private Collection entities;

    private DownloadFileType fileType;

    private List campaignIds;

    private Calendar lastSyncTimeInUTC;

    private PerformanceStatsDateRange performanceStatsDateRange;

    //Deleted in v10
    //private String locationTargetVersion;

    /**
     * Gets the scope or types of data to download. For possible values, see
     * DataScope Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620271
     */
    public Collection getDataScope() {
        return dataScope;
    }
    
    public void setDataScope(Collection value) {
        dataScope = value;
    }

    /**
     * Gets the type of entities to download. For possible values, see
     * BulkDownloadEntity Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620272
     */
    public void setEntities(Collection value) {
        entities = value;
    }

    /**
     * Gets the campaigns to download. You can specify a maximum of 1,000 campaigns.
     * The campaigns that you specify must belong to the same account.
     */
    public List getCampaignIds() {
        return this.campaignIds;
    }

    /**
     * Sets the campaigns to download. You can specify a maximum of 1,000 campaigns.
     * The campaigns that you specify must belong to the same account.
     */
    public void setCampaignIds(List campaignIds) {
        this.campaignIds = campaignIds;
    }

    /**
     * Gets the extension type of the downloaded file. For possible values, see
     * DownloadFileType Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620273
     */
    public DownloadFileType getFileType() {
        return fileType;
    }

    /**
     * Sets the extension type of the downloaded file. For possible values, see
     * DownloadFileType Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620273
     */
    public void setFileType(DownloadFileType fileType) {
        this.fileType = fileType;
    }

    /**
     * Gets the last time that you requested a download. The date and time is
     * expressed in Coordinated Universal Time (UTC). Typically, you request a
     * full download the first time you call the operation by setting this
     * element to null. On all subsequent calls you set the last sync time to
     * the time stamp of the previous download. The download file contains the
     * time stamp of the download in the SyncTime column of the Account record.
     * Use the time stamp to set LastSyncTimeInUTC the next time that you
     * request a download. If you specify the last sync time, only those
     * entities that have changed (been updated or deleted) since the specified
     * date and time will be downloaded. However, if the campaign data has not
     * been previously downloaded, the operation performs a full download.     
     */
    public Calendar getLastSyncTimeInUTC() {
        return lastSyncTimeInUTC;
    }

    /**
     * Sets the last time that you requested a download. The date and time is
     * expressed in Coordinated Universal Time (UTC). Typically, you request a
     * full download the first time you call the operation by setting this
     * element to null. On all subsequent calls you set the last sync time to
     * the time stamp of the previous download. The download file contains the
     * time stamp of the download in the SyncTime column of the Account record.
     * Use the time stamp to set LastSyncTimeInUTC the next time that you
     * request a download. If you specify the last sync time, only those
     * entities that have changed (been updated or deleted) since the specified
     * date and time will be downloaded. However, if the campaign data has not
     * been previously downloaded, the operation performs a full download.
     */
    public void setLastSyncTimeInUTC(Calendar lastSyncTimeInUTC) {
        this.lastSyncTimeInUTC = lastSyncTimeInUTC;
    }

    /**
     * Gets the date range values for the requested performance data in a bulk
     * download. For possible values, see PerformanceStatsDateRange Data Object
     * at http://go.microsoft.com/fwlink/?LinkId=620274
     */
    public PerformanceStatsDateRange getPerformanceStatsDateRange() {
        return performanceStatsDateRange;
    }

    /**
     * Sets the date range values for the requested performance data in a bulk
     * download. For possible values, see PerformanceStatsDateRange Data Object
     * at http://go.microsoft.com/fwlink/?LinkId=620274
     */
    public void setPerformanceStatsDateRange(
            PerformanceStatsDateRange performanceStatsDateRange) {
        this.performanceStatsDateRange = performanceStatsDateRange;
    }
}