com.microsoft.bingads.v13.bulk.DownloadParameters 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
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.
package com.microsoft.bingads.v13.bulk;
import java.io.File;
import java.util.Calendar;
import java.util.Collection;
import java.util.List;
/**
* Describes the available parameters when performing a download, such as the type of entities and data scope that you want to download.
*/
public class DownloadParameters {
private SubmitDownloadParameters submitDownloadParameters;
private File resultFileDirectory;
private String resultFileName;
private boolean autoDeleteTempFile;
/**
* Gets or sets a value indicating whether the local result file should be
* overwritten if it already exists.
*/
private boolean overwriteResultFile;
public DownloadParameters() {
this.submitDownloadParameters = new SubmitDownloadParameters();
}
SubmitDownloadParameters getSubmitDownloadParameters() {
return submitDownloadParameters;
}
void setSubmitDownloadParameters(SubmitDownloadParameters submitParams) {
this.submitDownloadParameters = submitParams;
}
/**
* Gets the extension type of the downloaded file. For possible values, see
* DownloadFileType Value Set at
* https://go.microsoft.com/fwlink/?linkid=846127.
*/
public DownloadFileType getFileType() {
return this.submitDownloadParameters.getFileType();
}
/**
* Sets the extension type of the downloaded file. For possible values, see
* DownloadFileType Value Set at
* https://go.microsoft.com/fwlink/?linkid=846127.
*/
public void setFileType(DownloadFileType fileType) {
this.submitDownloadParameters.setFileType(fileType);
}
/**
* Gets the scope or types of data to download. For possible values, see
* DataScope Value Set at
* https://go.microsoft.com/fwlink/?linkid=846127.
*/
public Collection getDataScope() {
return this.submitDownloadParameters.getDataScope();
}
/**
* Sets the scope or types of data to download. For possible values, see
* DataScope Value Set at
* https://go.microsoft.com/fwlink/?linkid=846127.
*/
public void setDataScope(Collection value) {
this.submitDownloadParameters.setDataScope(value);
}
/**
* Gets the Ids of 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.submitDownloadParameters.getCampaignIds();
}
/**
* Sets the Ids of 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.submitDownloadParameters.setCampaignIds(campaignIds);
}
/**
* 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 this.submitDownloadParameters.getLastSyncTimeInUTC();
}
/**
* 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.submitDownloadParameters.setLastSyncTimeInUTC(lastSyncTimeInUTC);
}
/**
* Gets the directory where the file will be downloaded.
*/
public File getResultFileDirectory() {
return resultFileDirectory;
}
/**
* Sets the directory where the file will be downloaded.
*/
public void setResultFileDirectory(File resultFileDirectory) {
this.resultFileDirectory = resultFileDirectory;
}
/**
* Gets the name of the local download result file.
*/
public String getResultFileName() {
return resultFileName;
}
/**
* Sets the name of the local download result file.
*/
public void setResultFileName(String resultFileName) {
this.resultFileName = resultFileName;
}
/**
* Gets whether the local result file should be overwritten if it already exists.
*/
public boolean getOverwriteResultFile() {
return overwriteResultFile;
}
/**
* Sets whether the local result file should be overwritten if it already exists.
*/
public void setOverwriteResultFile(boolean overwriteResultFile) {
this.overwriteResultFile = overwriteResultFile;
}
public ArrayOfDownloadEntity getDownloadEntities() {
return this.submitDownloadParameters.getDownloadEntities();
}
public void setDownloadEntities(ArrayOfDownloadEntity entities) {
submitDownloadParameters.setDownloadEntities(entities);
}
/**
* Gets whether the temporary upload file should be deleted.
*/
public boolean getAutoDeleteTempFile() {
return autoDeleteTempFile;
}
/**
* Sets whether the temporary upload file should be deleted.
*/
public void setAutoDeleteTempFile(boolean autoDeleteTempFile) {
this.autoDeleteTempFile = autoDeleteTempFile;
}
}