Massen Service Manager
Nutzen Sie den Massendienst , um Anzeigengruppen und Anzeigen für alle Kampagnen in einem Konto effizient zu verwalten. Die Bing Ads.NET-, Java- und Python-SDKs bieten Klassen, um die Produktivität für das Herunterladen und Hochladen von Massendatensätzen zu beschleunigen. Beispielsweise sendet der BulkServiceManager Ihre Downloadanforderung an den Massendienst, fragt den Dienst ab, bis er abgeschlossen ist, und lädt die Datei in Ihr lokales Verzeichnis herunter. Der BulkServiceManager verarbeitet auch allgemeine Anforderungsheaderfelder für Sie, sodass die Eigenschaften Authentication, CustomerId, AccountId und DeveloperToken im AuthorizationData-Objekt einmal für jeden Dienst angegeben werden können. Weitere Informationen finden Sie unter Verwenden von AuthorizationData und im Codebeispiel für Massenanforderungen .
Hinweis
BulkServiceManager ist nur mit den Bing Ads.NET-, Java- und Python-SDKs verfügbar. Unabhängig davon, ob Sie ein SDK verwenden, können Sie den Massendienst direkt verwenden. Weitere Informationen finden Sie unter Massendownload und -upload.
Massendateileser und -writer
Sie müssen keinen eigenen Dateiparser implementieren, um die Massendatei zu lesen und zu schreiben. Sie können BulkFileReader - und BulkFileWriter-Objekte verwenden, um von BulkEntity abgeleitete Klassen zu lesen und zu schreiben.
Hinweis
Der BulkServiceManager verwendet einen BulkFileReader und BulkFileWriter im Hintergrund, wenn Sie Entitäten anstelle von Dateien hochladen und herunterladen. Temporäre Dateien werden im Hintergrund verwendet. Weitere Informationen finden Sie unter Arbeitsverzeichnis und BulkServiceManager.
Angenommen, Sie möchten den folgenden Erweiterten Textanzeigendatensatz in eine Massendatei schreiben.
Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Title,Text,Text Part 2,Display Url,Destination Url,Promotion,Device Preference,Ad Format Preference,Name,App Platform,App Id,Final Url,Mobile Final Url,Tracking Template,Custom Parameter,Title Part 1,Title Part 2,Title Part 3,Path 1,Path 2
Format Version,,,,,,,,,,,,,,,6.0,,,,,,,,,,,
Expanded Text Ad,Active,,-1111,ParentCampaignNameGoesHere,AdGroupNameGoesHere,ClientIdGoesHere,,,Find New Customers & Increase Sales!,Start Advertising on Contoso Today.,,,,,False,,,,https://www.contoso.com/womenshoesale,https://mobile.contoso.com/womenshoesale,,{_promoCode}=PROMO1; {_season}=summer,Contoso,Quick & Easy Setup,Seemless Integration,seattle,shoe sale
Erstellen Sie zunächst das BulkExpandedTextAd-Objekt, wie unten in Bulk and Campaign Management Entity Map gezeigt. Anschließend können Sie bulkExpandedTextAd wie hier gezeigt in eine Datei mit BulkFileWriter schreiben.
var bulkFileWriter = new BulkFileWriter(
filePath: FileDirectory + UploadFileName
);
bulkFileWriter.WriteEntity(bulkExpandedTextAd);
bulkFileWriter.Dispose();
BulkFileWriter bulkFileWriter = new BulkFileWriter(
new File(FileDirectory + UploadFileName)
);
bulkFileWriter.writeEntity(bulkExpandedTextAd);
bulkFileWriter.close();
bulk_file_writer=BulkFileWriter(
file_path=FILE_DIRECTORY+UPLOAD_FILE_NAME
)
bulk_file_writer.write_entity(bulk_expanded_text_ad)
bulk_file_writer.close()
Hier ist ein Beispiel für das Lesen der Massenupload-Ergebnisdatei aus einem lokalen Verzeichnis mit BulkFileReader. Sie können eine Massendatei mit dem BulkFileReader lesen, unabhängig davon, ob die Ergebnisse vollständig heruntergeladen, teilweise heruntergeladen oder hochgeladen werden.
var bulkFileReader = new BulkFileReader(
filePath: bulkFilePath, // Path to the Bulk file
resultFileType: ResultFileType.Upload, // FullDownload, PartialDownload, or Upload
fileFormat: DownloadFileType.Csv // Csv or Tsv
);
var resultEntities = bulkFileReader.ReadEntities().ToList();
var expandedTextAdResults = resultEntities.OfType<BulkExpandedTextAd>().ToList();
OutputBulkExpandedTextAds(expandedTextAdResults);
bulkFileReader.Dispose();
BulkFileReader bulkFileReader = new BulkFileReader(
bulkFilePath, // Path to the Bulk file
ResultFileType.UPLOAD, // FULL_DOWNLOAD, PARTIAL_DOWNLOAD, or UPLOAD
DownloadFileType.CSV // Csv or Tsv
);
BulkEntityIterable resultEntities = bulkFileReader.getEntities();
for (BulkEntity entity : resultEntities) {
if (entity instanceof BulkExpandedTextAd) {
outputBulkBulkExpandedTextAds(Arrays.asList((BulkExpandedTextAd) entity));
}
}
resultEntities.close();
bulkFileReader.close();
def read_entities_from_bulk_file(file_path, result_file_type, file_type):
with BulkFileReader(file_path=file_path, result_file_type=result_file_type, file_type=file_type) as reader:
for entity in reader:
yield entity
def main():
result_entities=[]
entities_generator=read_entities_from_bulk_file(
file_path=bulk_file_path, # Path to the Bulk file
result_file_type=ResultFileType.upload, # full_download, partial_download, or upload
file_type='Csv' # Csv or Tsv
)
for entity in entities_generator:
result_entities.append(entity)
for entity in download_entities:
if isinstance(entity, BulkExpandedTextAd):
output_bulk_expanded_text_ads([entity])
Massen- und Kampagnenverwaltungsentitätszuordnung
Alle Objekte, die über BulkServiceManager, BulkFileReader, BulkFileWriter aus BulkServiceManager gelesen und in Massendateien geschrieben werden, werden von der BulkEntity-Basisklasse abgeleitet, z. B. BulkCampaign, BulkAdGroup und BulkExpandedTextAd. Nach Möglichkeit nutzen die Massenobjekte Campaign Management-Objekte und -Wertsätze, z. B. enthält der folgende BulkExpandedTextAd das ExpandedTextAd-Objekt der Kampagnenverwaltungs-API.
var uploadEntities = new List<BulkEntity>();
// Map properties in the Bulk file to the BulkExpandedTextAd
var bulkExpandedTextAd = new BulkExpandedTextAd
{
// 'Parent Id' column header in the Bulk file
AdGroupId = adGroupIdKey,
// 'Ad Group' column header in the Bulk file
AdGroupName = "AdGroupNameGoesHere",
// 'Campaign' column header in the Bulk file
CampaignName = "ParentCampaignNameGoesHere",
// 'Client Id' column header in the Bulk file
ClientId = "ClientIdGoesHere",
// Map properties in the Bulk file to the
// ExpandedTextAd object of the Campaign Management service.
ExpandedTextAd = new ExpandedTextAd
{
// 'Ad Format Preference' column header in the Bulk file
AdFormatPreference = "All",
// 'Mobile Final Url' column header in the Bulk file
FinalMobileUrls = new[] {
// Each Url is delimited by a semicolon (;) in the Bulk file
"https://mobile.contoso.com/womenshoesale"
},
// 'Final Url' column header in the Bulk file
FinalUrls = new[] {
// Each Url is delimited by a semicolon (;) in the Bulk file
"https://www.contoso.com/womenshoesale"
},
// 'Id' column header in the Bulk file
Id = null,
// 'Path 1' column header in the Bulk file
Path1 = "seattle",
// 'Path 2' column header in the Bulk file
Path2 = "shoe sale",
// 'Status' column header in the Bulk file
Status = AdStatus.Active,
// 'Text' column header in the Bulk file
Text = "Find New Customers & Increase Sales!",
// 'Text Part 2' column header in the Bulk file
TextPart2 = "Start Advertising on Contoso Today.",
// 'Title Part 1' column header in the Bulk file
TitlePart1 = "Contoso",
// 'Title Part 2' column header in the Bulk file
TitlePart2 = "Quick & Easy Setup",
// 'Title Part 3' column header in the Bulk file
TitlePart3 = "Seemless Integration",
// 'Tracking Template' column header in the Bulk file
TrackingUrlTemplate = null,
// 'Custom Parameter' column header in the Bulk file
UrlCustomParameters = new CustomParameters
{
// Each custom parameter is delimited by a semicolon (;) in the Bulk file
Parameters = new[] {
new CustomParameter(){
Key = "promoCode",
Value = "PROMO1"
},
new CustomParameter(){
Key = "season",
Value = "summer"
},
}
},
},
};
uploadEntities.Add(bulkExpandedTextAd);
var entityUploadParameters = new EntityUploadParameters
{
Entities = uploadEntities,
ResponseMode = ResponseMode.ErrorsAndResults,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true,
};
var uploadResultEntities = (await bulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();
List<BulkEntity> uploadEntities = new ArrayList<BulkEntity>();
// Map properties in the Bulk file to the BulkExpandedTextAd
BulkExpandedTextAd bulkExpandedTextAd = new BulkExpandedTextAd();
// 'Parent Id' column header in the Bulk file
bulkExpandedTextAd.setAdGroupId(adGroupIdKey);
// 'Ad Group' column header in the Bulk file
bulkExpandedTextAd.setAdGroupName("AdGroupNameGoesHere");
// 'Campaign' column header in the Bulk file
bulkExpandedTextAd.setCampaignName("ParentCampaignNameGoesHere");
// 'Client Id' column header in the Bulk file
bulkExpandedTextAd.setClientId("ClientIdGoesHere");
// Map properties in the Bulk file to the
// ExpandedTextAd object of the Campaign Management service.
ExpandedTextAd expandedTextAd = new ExpandedTextAd();
// 'Ad Format Preference' column header in the Bulk file
expandedTextAd.setAdFormatPreference("All");
// 'Mobile Final Url' column header in the Bulk file
// Each Url is delimited by a semicolon (;) in the Bulk file
ArrayOfstring mobileFinalUrls = new ArrayOfstring();
mobileFinalUrls.getStrings().add("https://mobile.contoso.com/womenshoesale");
expandedTextAd.setFinalMobileUrls(mobileFinalUrls);
// 'Final Url' column header in the Bulk file
// Each Url is delimited by a semicolon (;) in the Bulk file
ArrayOfstring finalUrls = new ArrayOfstring();
finalUrls.getStrings().add("https://www.contoso.com/womenshoesale");
expandedTextAd.setFinalUrls(finalUrls);
// 'Id' column header in the Bulk file
expandedTextAd.setId(null);
// 'Path 1' column header in the Bulk file
expandedTextAd.setPath1("seattle");
// 'Path 2' column header in the Bulk file
expandedTextAd.setPath2("shoe sale");
// 'Status' column header in the Bulk file
expandedTextAd.setStatus(AdStatus.ACTIVE);
// 'Text' column header in the Bulk file
expandedTextAd.setText("Find New Customers & Increase Sales!");
// 'Text Part 2' column header in the Bulk file
expandedTextAd.setTextPart2("Start Advertising on Contoso Today.");
// 'Title Part 1' column header in the Bulk file
expandedTextAd.setTitlePart1("Contoso");
// 'Title Part 2' column header in the Bulk file
expandedTextAd.setTitlePart2("Quick & Easy Setup");
// 'Title Part 3' column header in the Bulk file
expandedTextAd.setTitlePart3("Seemless Integration");
// 'Tracking Template' column header in the Bulk file
expandedTextAd.setTrackingUrlTemplate(null);
// 'Custom Parameter' column header in the Bulk file
// Each custom parameter is delimited by a semicolon (;) in the Bulk file
CustomParameters customParameters = new CustomParameters();
ArrayOfCustomParameter arrayOfCustomParameter = new ArrayOfCustomParameter();
CustomParameter customParameterA = new CustomParameter();
customParameterA.setKey("promoCode");
customParameterA.setValue("PROMO1");
arrayOfCustomParameter.getCustomParameters().add(customParameterA);
CustomParameter customParameterB = new CustomParameter();
customParameterB.setKey("season");
customParameterB.setValue("summer");
arrayOfCustomParameter.getCustomParameters().add(customParameterB);
customParameters.setParameters(arrayOfCustomParameter);
expandedTextAd.setUrlCustomParameters(customParameters);
bulkExpandedTextAd.setExpandedTextAd(expandedTextAd);
uploadEntities.add(bulkExpandedTextAd);
EntityUploadParameters entityUploadParameters = new EntityUploadParameters();
entityUploadParameters.setEntities(uploadEntities);
entityUploadParameters.setOverwriteResultFile(true);
entityUploadParameters.setResultFileDirectory(new File(FileDirectory));
entityUploadParameters.setResultFileName(ResultFileName);
entityUploadParameters.setResponseMode(ResponseMode.ERRORS_AND_RESULTS);
BulkEntityIterable uploadResultEntities = bulkServiceManager.uploadEntitiesAsync(
entityUploadParameters,
null,
null
).get();
# Map properties in the Bulk file to the BulkExpandedTextAd
bulk_expanded_text_ad=BulkExpandedTextAd()
# 'Parent Id' column header in the Bulk file
bulk_expanded_text_ad.ad_group_id=AD_GROUP_ID_KEY
# 'Ad Group' column header in the Bulk file
bulk_expanded_text_ad.AdGroupName='AdGroupNameGoesHere'
# 'Campaign' column header in the Bulk file
bulk_expanded_text_ad.CampaignName='ParentCampaignNameGoesHere'
# 'Client Id' column header in the Bulk file
bulk_expanded_text_ad.ClientId='ClientIdGoesHere'
# Map properties in the Bulk file to the
# ExpandedTextAd object of the Campaign Management service.
expanded_text_ad=set_elements_to_none(campaign_service.factory.create('ExpandedTextAd'))
# 'Ad Format Preference' column header in the Bulk file
expanded_text_ad.AdFormatPreference='All'
# 'Mobile Final Url' column header in the Bulk file
# Each Url is delimited by a semicolon (;) in the Bulk file
mobile_final_urls=campaign_service.factory.create('ns3:ArrayOfstring')
mobile_final_urls.string.append('https://mobile.contoso.com/womenshoesale')
expanded_text_ad.FinalUrls=mobile_final_urls
# 'Final Url' column header in the Bulk file
# Each Url is delimited by a semicolon (;) in the Bulk file
final_urls=campaign_service.factory.create('ns3:ArrayOfstring')
final_urls.string.append('https://www.contoso.com/womenshoesale')
expanded_text_ad.FinalUrls=final_urls
# 'Id' column header in the Bulk file
expanded_text_ad.Id=None
# 'Path 1' column header in the Bulk file
expanded_text_ad.Path1='seattle'
# 'Path 2' column header in the Bulk file
expanded_text_ad.Path2='shoe sale'
# 'Status' column header in the Bulk file
expanded_text_ad.Status='Active'
# 'Text' column header in the Bulk file
expanded_text_ad.Text='Find New Customers & Increase Sales!'
# 'Text Part 2' column header in the Bulk file
expanded_text_ad.TextPart2='Start Advertising on Contoso Today.'
# 'Title Part 1' column header in the Bulk file
expanded_text_ad.TitlePart1='Contoso'
# 'Title Part 2' column header in the Bulk file
expanded_text_ad.TitlePart2='Quick & Easy Setup'
# 'Title Part 3' column header in the Bulk file
expanded_text_ad.TitlePart3='Seemless Integration'
# 'Tracking Template' column header in the Bulk file
expanded_text_ad.TrackingUrlTemplate=None
# 'Custom Parameter' column header in the Bulk file
# Each custom parameter is delimited by a semicolon (;) in the Bulk file
custom_parameters=set_elements_to_none(campaign_service.factory.create('CustomParameters'))
array_of_custom_parameter=campaign_service.factory.create('ArrayOfCustomParameter')
custom_parameter_a=set_elements_to_none(campaign_service.factory.create('CustomParameter'))
custom_parameter_a.Key='promoCode'
custom_parameter_a.Value='PROMO1'
array_of_custom_parameter.CustomParameter.append(custom_parameter_a)
custom_parameter_b=set_elements_to_none(campaign_service.factory.create('CustomParameter'))
custom_parameter_b.Key='season'
custom_parameter_b.Value='summer'
array_of_custom_parameter.CustomParameter.append(custom_parameter_b)
custom_parameters.Parameters=array_of_custom_parameter
expanded_text_ad.UrlCustomParameters=custom_parameters
bulk_expanded_text_ad.ad=expanded_text_ad
upload_entities.append(bulk_expanded_text_ad)
entity_upload_parameters=EntityUploadParameters(
entities=upload_entities,
overwrite_result_file=True,
result_file_directory=FILE_DIRECTORY,
result_file_name=RESULT_FILE_NAME,
response_mode='ErrorsAndResults'
)
upload_result_entities=bulk_service_manager.upload_entities(
entity_upload_parameters=entity_upload_parameters,
progress=None
)
Aktualisieren mit delete_value
Um eine vorhandene Einstellung zu entfernen, sollten Sie keine leere Zeichenfolge ("") in die Massendatei schreiben, da solche Zeichenfolgen vom Massendienst ignoriert werden. Verwenden Sie die reservierte Zeichenfolge "delete_value", um den Wert eines optionalen Felds zu löschen oder zurückzusetzen. Wenn Sie die reservierte Zeichenfolge "delete_value" in einem optionalen Feld verwenden, wird die vorherige Einstellung gelöscht. Wenn Sie beispielsweise das Feld Benutzerdefinierter Parameter des Datensatzes für erweiterte Textanzeigen auf "delete_value" festlegen, werden alle vorherigen benutzerdefinierten Parameter aus der erweiterten Textanzeige gelöscht. Wenn Sie das Feld Nachverfolgungsvorlage des Datensatzes für erweiterte Textanzeigen auf "delete_value" festlegen, wird die vorherige Nachverfolgungsvorlage aus der erweiterten Textanzeige gelöscht. Weitere Informationen zu "delete_value" finden Sie unter Massendateischema – Aktualisieren mit delete_value.
Der BulkFileWriter schreibt ggf. automatisch "delete_value". Da das SDK Kampagnenverwaltungs-API-Objekte dem Inhalt einer Massendatei zuordnet , können Sie die Zeichenfolge "delete_value" für Eigenschaften mit anderen Datentypen nicht explizit festlegen. In diesen Fällen können Sie dieselbe Syntax verwenden, die Sie zum Aktualisieren des Objekts über die Kampagnenverwaltungs-API verwenden würden. Im folgenden Beispiel schreibt das SDK durch Festlegen von UrlCustomParameters auf ein leeres CustomParameters-Objekt "delete_value" in das Feld Benutzerdefinierter Parameter des Datensatzes für erweiterte Textanzeigen . Indem TrackingUrlTemplate auf eine leere Zeichenfolge festgelegt wird, schreibt das SDK "delete_value" in das Feld Nachverfolgungsvorlage des Datensatzes für erweiterte Textanzeigen . Die Beispielsyntax innerhalb des ExpandedTextAd-Objekts ist identisch mit der Vorgehensweise zum Löschen von previus-Einstellungen über den UpdateAds-Dienstvorgang über die Kampagnenverwaltungs-API.
Wichtig
Verwenden Sie keine leeren Zeichenfolgen ("") oder die Syntax "delete_value", wenn Sie eine Massenentität erstellen. Die reservierte Zeichenfolge "delete_value" gilt nur für die Aktualisierung von Massendatensätzen. Entweder sollten Sie die -Eigenschaft nicht oder auf eine NULL-Entsprechung festlegen.
var bulkExpandedTextAd = new BulkExpandedTextAd
{
AdGroupId = adGroupIdKey,
ExpandedTextAd = new ExpandedTextAd
{
Id = expandedTextAdIdKey,
TrackingUrlTemplate = "",
UrlCustomParameters = new CustomParameters { }
},
};
BulkExpandedTextAd bulkExpandedTextAd = new BulkExpandedTextAd();
bulkExpandedTextAd.setAdGroupId(expandedTextAdIdKey);
ExpandedTextAd expandedTextAd = new ExpandedTextAd();
expandedTextAd.setId(adIdKey);
expandedTextAd.setTrackingUrlTemplate("");
CustomParameters customParameters = new CustomParameters();
expandedTextAd.setUrlCustomParameters(customParameters);
bulkExpandedTextAd.setExpandedTextAd(expandedTextAd);
bulk_expanded_text_ad=BulkExpandedTextAd()
bulk_expanded_text_ad.ad_group_id=AD_GROUP_ID_KEY
expanded_text_ad=set_elements_to_none(campaign_service.factory.create('ExpandedTextAd'))
expanded_text_ad.Id=EXPANDED_TEXT_AD_ID_KEY
expanded_text_ad.TrackingUrlTemplate=''
custom_parameters=set_elements_to_none(campaign_service.factory.create('CustomParameters'))
expanded_text_ad.UrlCustomParameters=custom_parameters
bulk_expanded_text_ad.ad=expanded_text_ad
Herunterladen und Hochladen
BulkServiceManager unterstützt flexible Massendownload- und Uploadworkflows.
Sie können eine Download- oder Uploadanforderung erstellen. BulkServiceManager sendet Ihre Downloadanforderung an den Massendienst, fragt den Dienst ab, bis der Vorgang abgeschlossen ist, und lädt die Datei in Ihr lokales Verzeichnis herunter. Weitere Informationen finden Sie z. B. unter Vervollständigung im Hintergrund mit BulkServiceManager.
Sie können eine Download- oder Uploadanforderung übermitteln und dann abfragen, bis die Ergebnisdatei zum Herunterladen bereit ist. Weitere Informationen finden Sie z. B. unter Übermitteln und Herunterladen mit BulkServiceManager.
Wenn Sie aus irgendeinem Grund aus einem früheren Anwendungszustand fortfahren müssen, können Sie einen vorhandenen Download- oder Upload-Anforderungsbezeichner verwenden und diesen zum Herunterladen der Ergebnisdatei verwenden. Weitere Informationen finden Sie beispielsweise unter Herunterladen von Ergebnissen mit BulkServiceManager.
Unabhängig davon, ob Sie Entitäten im Arbeitsspeicher herunterladen und hochladen oder sie selbst in einer Datei lesen und schreiben, liest der BulkServiceManager eine temporäre Datei und schreibt sie in eine temporäre Datei.
Vervollständigung im Hintergrund mit BulkServiceManager
Sie können eine Download- oder Uploadanforderung erstellen. BulkServiceManager sendet Ihre Downloadanforderung an den Massendienst, fragt den Dienst ab, bis der Vorgang abgeschlossen ist, und lädt die Datei in Ihr lokales Verzeichnis herunter.
public async Task RunAsync(AuthorizationData authorizationData)
{
var bulkServiceManager = new BulkServiceManager(authorizationData);
var progress = new Progress<BulkOperationProgressInfo>(x =>
Console.WriteLine(String.Format("{0} % Complete", x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
var downloadParameters = new DownloadParameters
{
CampaignIds = null,
DataScope = DataScope.EntityData,
Entities = DownloadEntity.Keywords,
FileType = DownloadFileType.Csv,
LastSyncTimeInUTC = null,
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = false // Set this value true if you want to overwrite the same file.
};
// Sets the time interval in milliseconds between two status polling attempts. The default value is 5000 (5 seconds).
bulkServiceManager.StatusPollIntervalInMilliseconds = 5000;
// Sets the timeout of the HttpClient download operation. The default value is 100000 (100s).
bulkServiceManager.DownloadHttpTimeout = new TimeSpan(0, 0, 100);
// You may optionally cancel the DownloadFileAsync operation after a specified time interval.
// Pass this object to the DownloadFileAsync operation or specify CancellationToken.None.
var tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(3600000);
// The BulkServiceManager will submit your download request to the Bulk service,
// poll the service until completed, and download the file to your local directory.
var resultFile = await bulkServiceManager.DownloadFileAsync(
parameters: downloadParameters,
progress: progress,
cancellationToken: tokenSource.Token
);
Console.WriteLine(string.Format("Download result file: {0}\n", resultFile));
}
BulkServiceManager bulkServiceManager = new BulkServiceManager(authorizationData);
Progress<BulkOperationProgressInfo> progress = new Progress<BulkOperationProgressInfo>() {
@Override
public void report(BulkOperationProgressInfo value) {
System.out.println(value.getPercentComplete() + "% Complete\n");
}
};
DownloadParameters downloadParameters = new DownloadParameters();
downloadParameters.setCampaignIds(null);
ArrayList<DataScope> dataScope = new ArrayList<DataScope>();
dataScope.add(DataScope.ENTITY_DATA);
downloadParameters.setDataScope(dataScope);
downloadParameters.setFileType(FileType);
downloadParameters.setLastSyncTimeInUTC(null);
ArrayList<DownloadEntity> bulkDownloadEntities = new ArrayList<DownloadEntity>();
bulkDownloadEntities.add(DownloadEntity.KEYWORDS);
downloadParameters.setEntities(bulkDownloadEntities);
downloadParameters.setResultFileDirectory(new File(FileDirectory));
downloadParameters.setResultFileName(ResultFileName);
downloadParameters.setOverwriteResultFile(true); // Set this value true if you want to overwrite the same file.
// Sets the time interval in milliseconds between two status polling attempts. The default value is 5000 (5 seconds).
bulkServiceManager.setStatusPollIntervalInMilliseconds(5000);
// Sets the timeout of the HttpClient download operation. The default value is 100000 (100s).
bulkServiceManager.setDownloadHttpTimeoutInMilliseconds(100000);
// The BulkServiceManager will submit your download request to the Bulk service,
// poll the service until completed, and download the file to your local directory.
// You may optionally cancel the downloadFileAsync operation after a specified time interval.
File resultFile = bulkServiceManager.downloadFileAsync(
downloadParameters,
progress,
null
).get(3600000, TimeUnit.MILLISECONDS);
System.out.printf("Download result file: %s\n", resultFile.getName());
bulk_service_manager = BulkServiceManager(
authorization_data=authorization_data,
# Sets the time interval in milliseconds between two status polling attempts.
# The default value is 5000 (5 seconds).
poll_interval_in_milliseconds = 5000,
environment = ENVIRONMENT,
)
download_parameters = DownloadParameters(
campaign_ids=None,
data_scope=['EntityData'],
entities=entities,
file_type=FILE_TYPE,
last_sync_time_in_utc=None,
result_file_directory = FILE_DIRECTORY,
result_file_name = DOWNLOAD_FILE_NAME,
# Set this value true if you want to overwrite the same file.
overwrite_result_file = True,
# You may optionally cancel the download after a specified time interval.
timeout_in_milliseconds=3600000
)
# The BulkServiceManager will submit your download request to the Bulk service,
# poll the service until completed, and download the file to your local directory.
result_file_path = bulk_service_manager.download_file(
download_parameters=download_parameters,
progress = None
)
print("Download result file: {0}\n".format(result_file_path))
Übermitteln und Herunterladen mit BulkServiceManager
Übermitteln Sie die Downloadanforderung, und verwenden Sie dann das Ergebnis BulkDownloadOperation, um die status nachzuverfolgen.
public async Task RunAsync(AuthorizationData authorizationData)
{
var bulkServiceManager = new BulkServiceManager(authorizationData);
var submitDownloadParameters = new SubmitDownloadParameters
{
CampaignIds = null,
DataScope = DataScope.EntityData,
Entities = DownloadEntity.Keywords,
FileType = DownloadFileType.Csv,
LastSyncTimeInUTC = null
};
var bulkDownloadOperation = await bulkServiceManager.SubmitDownloadAsync(submitDownloadParameters);
// You may optionally cancel the TrackAsync operation after a specified time interval.
var tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(3600000);
BulkOperationStatus<DownloadStatus> downloadStatus = await bulkDownloadOperation.TrackAsync(
null,
tokenSource.Token
);
var resultFilePath = await bulkDownloadOperation.DownloadResultFileAsync(
FileDirectory,
ResultFileName,
decompress: true,
overwrite: true // Set this value true if you want to overwrite the same file.
);
Console.WriteLine(String.Format("Download result file: {0}\n", resultFilePath));
}
BulkServiceManager bulkServiceManager = new BulkServiceManager(authorizationData);
SubmitDownloadParameters submitDownloadParameters = new SubmitDownloadParameters();
submitDownloadParameters.setCampaignIds(null);
ArrayList<DataScope> dataScope = new ArrayList<DataScope>();
dataScope.add(DataScope.ENTITY_DATA);
submitDownloadParameters.setDataScope(dataScope);
submitDownloadParameters.setFileType(FileType);
submitDownloadParameters.setLastSyncTimeInUTC(null);
ArrayList<DownloadEntity> bulkDownloadEntities = new ArrayList<DownloadEntity>();
bulkDownloadEntities.add(DownloadEntity.KEYWORDS);
submitDownloadParameters.setEntities(bulkDownloadEntities);
// Submit the download request. You can use the BulkDownloadOperation result to track status yourself using getStatusAsync,
// or use trackAsync to indicate that the application should wait until the download status is completed.
BulkDownloadOperation bulkDownloadOperation = bulkServiceManager.submitDownloadAsync(
submitDownloadParameters,
null
).get();
// You may optionally cancel the trackAsync operation after a specified time interval.
BulkOperationStatus<DownloadStatus> downloadStatus = bulkDownloadOperation.trackAsync(
null
).get(3600000, TimeUnit.MILLISECONDS);
File resultFile = bulkDownloadOperation.downloadResultFileAsync(
new File(FileDirectory),
ResultFileName,
true, // Set this value to true if you want to decompress the ZIP file.
true, // Set this value true if you want to overwrite the named file.
null
).get();
System.out.println(String.format("Download result file: %s\n", resultFile.getName()));
bulk_service_manager = BulkServiceManager(
authorization_data=authorization_data,
poll_interval_in_milliseconds = 5000,
environment = ENVIRONMENT,
)
submit_download_parameters = SubmitDownloadParameters(
data_scope = [ 'EntityData' ],
entities = [ 'Campaigns', 'AdGroups', 'Keywords', 'Ads' ],
file_type = 'Csv',
campaign_ids = None,
last_sync_time_in_utc = None,
performance_stats_date_range = None
)
bulk_download_operation = bulk_service_manager.submit_download(submit_download_parameters)
# You may optionally cancel the track() operation after a specified time interval.
download_status = bulk_download_operation.track(timeout_in_milliseconds=3600000)
result_file_path = bulk_download_operation.download_result_file(
result_file_directory = FILE_DIRECTORY,
result_file_name = DOWNLOAD_FILE_NAME,
decompress = True,
overwrite = True, # Set this value true if you want to overwrite the same file.
timeout_in_milliseconds=3600000 # You may optionally cancel the download after a specified time interval.
)
print("Download result file: {0}\n".format(result_file_path))
Herunterladen von Ergebnissen mit BulkServiceManager
Wenn Sie aus irgendeinem Grund aus einem früheren Anwendungszustand fortfahren müssen, können Sie einen vorhandenen Download- oder Upload-Anforderungsbezeichner verwenden und diesen zum Herunterladen der Ergebnisdatei verwenden. Verfolgen Sie das Ergebnis nach, um sicherzustellen, dass der Download status abgeschlossen ist.
public async Task RunAsync(AuthorizationData authorizationData)
{
var bulkServiceManager = new BulkServiceManager(authorizationData);
var progress = new Progress<BulkOperationProgressInfo>(x =>
Console.WriteLine(String.Format("{0} % Complete", x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
// You may optionally cancel the TrackAsync operation after a specified time interval.
var tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(3600000);
var bulkDownloadOperation = new BulkDownloadOperation(requestId, authorizationData);
// Use TrackAsync to indicate that the application should wait to ensure that
// the download status is completed.
var bulkOperationStatus = await bulkDownloadOperation.TrackAsync(null, tokenSource.Token);
var resultFilePath = await bulkDownloadOperation.DownloadResultFileAsync(
FileDirectory,
ResultFileName,
decompress: true,
overwrite: true // Set this value true if you want to overwrite the same file.
);
Console.WriteLine(String.Format("Download result file: {0}", resultFilePath));
Console.WriteLine(String.Format("Status: {0}", bulkOperationStatus.Status));
Console.WriteLine(String.Format("TrackingId: {0}\n", bulkOperationStatus.TrackingId));
}
Progress<BulkOperationProgressInfo> progress = new Progress<BulkOperationProgressInfo>() {
@Override
public void report(BulkOperationProgressInfo value) {
System.out.println(value.getPercentComplete() + "% Complete\n");
}
};
java.lang.String requestId = RequestIdGoesHere;
BulkDownloadOperation bulkDownloadOperation = new BulkDownloadOperation(requestId, authorizationData);
// You may optionally cancel the trackAsync operation after a specified time interval.
BulkOperationStatus<DownloadStatus> downloadStatus = bulkDownloadOperation.trackAsync(
progress,
null
).get(3600000, TimeUnit.MILLISECONDS);
System.out.printf(
"Download Status:\nPercentComplete: %s\nResultFileUrl: %s\nStatus: %s\n",
downloadStatus.getPercentComplete(), downloadStatus.getResultFileUrl(), downloadStatus.getStatus()
);
File resultFile = bulkDownloadOperation.downloadResultFileAsync(
new File(FileDirectory),
ResultFileName,
true, // Set this value to true if you want to decompress the ZIP file
true, // Set this value true if you want to overwrite the same file.
null
).get();
System.out.println(String.format("Download result file: %s", resultFile.getName()));
System.out.println(String.format("Status: %s", downloadStatus.getStatus()));
System.out.println(String.format("TrackingId: %s\n", downloadStatus.getTrackingId()));
request_id = RequestIdGoesHere
bulk_download_operation = BulkDownloadOperation(
request_id = request_id,
authorization_data = authorization_data,
poll_interval_in_milliseconds = 5000,
environment = ENVIRONMENT
)
# Use track() to indicate that the application should wait to ensure that the download status is completed.
# You may optionally cancel the track() operation after a specified time interval.
bulk_operation_status = bulk_download_operation.track(timeout_in_milliseconds=3600000)
result_file_path = bulk_download_operation.download_result_file(
result_file_directory = FILE_DIRECTORY,
result_file_name = DOWNLOAD_FILE_NAME,
decompress = True,
overwrite = True, # Set this value true if you want to overwrite the same file.
timeout_in_milliseconds=3600000 # You may optionally cancel the download after a specified time interval.
)
print("Download result file: {0}\n".format(result_file))
print("Status: {0}\n".format(bulk_operation_status.status))
Abfragen und Wiederholen
Laden Sie die Ergebnisse in angemessenen Abständen herunter, und laden Sie sie hoch. Sie kennen Ihre Daten besser als jeder andere. Wenn Sie beispielsweise ein Konto herunterladen, das deutlich weniger als eine Million Schlüsselwörter enthält, sollten Sie die Abfrage in Intervallen von 5 bis 20 Sekunden in Erwägung ziehen. Wenn das Konto etwa eine Million Schlüsselwörter enthält, sollten Sie nach fünf Minuten Wartezeit einen Abruf in Intervallen von einer Minute in Erwägung ziehen. Für Konten mit etwa vier Millionen Schlüsselwörtern sollten Sie nach 10 Minuten Wartezeit einen Abruf in Intervallen von einer Minute in Erwägung ziehen.
Der BulkServiceManager fragt die Ergebnisdatei automatisch in Intervallen von 1000 Millisekunden für die ersten fünf Versuche ab, und dieses Verhalten ist nicht konfigurierbar. Die StatusPollIntervalInMilliseconds-Eigenschaft bestimmt das Zeitintervall zwischen den einzelnen Abrufversuchen nach den ersten fünf Versuchen. Ein Beispiel finden Sie oben unter Abschluss des Hintergrunds . Der Standardwert ist 5000. Wenn Sie diesen Wert nicht festlegen, ruft der BulkServiceManager in der folgenden Sequenz von Minuten ab: 1, 2, 3, 4, 5, 10, 15, 20 usw. Wenn Sie diesen Wert auf 10000 festlegen, ruft der BulkServiceManager in der folgenden Sequenz ab: 1, 2, 3, 4, 5, 15, 25, 35 usw. Das mindeste Abrufintervall ist 1000, und wenn Sie einen Wert kleiner als 1000 angeben, wird eine Ausnahme ausgelöst.
Der BulkServiceManager wiederholt automatisch Upload-, Download- und Abrufvorgänge bis zur von Ihnen festgelegten maximalen Timeoutdauer. Sie können die maximale Dauer des Wiederholungstimeouts festlegen. Wenn kein Timeout angegeben wird, versucht der BulkServiceManager weiterhin, bis der Server ein Timeout oder einen internen Fehler zurückgibt. Wenn Sie große Dateien hochladen oder herunterladen, sollten Sie die Eigenschaften UploadHttpTimeout oder DownloadHttpTimeout festlegen.
Arbeitsverzeichnis und BulkServiceManager
Mit den Bing Ads.NET- und Java-SDKs können Sie das Arbeitsverzeichnis festlegen, in dem BulkServiceManager temporäre Massendateien speichern soll. Wenn Sie beispielsweise Entitäten mit dem Bing Ads .NET SDK herunterladen, obwohl Sie nur direkt mit BulkEntity-Objekten arbeiten, wird eine Massendatei in das Arbeitsverzeichnis heruntergeladen. Ebenso wird beim Hochladen von Entitäten eine temporäre Datei in das Arbeitsverzeichnis geschrieben und dann in den Massendienst hochgeladen. Das temporäre Systemverzeichnis wird verwendet, wenn kein anderes Arbeitsverzeichnis angegeben wird.
Wenn Sie einen gehosteten Dienst wie Microsoft Azure verwenden, sollten Sie sicherstellen, dass die Grenzwerte für temporäre Verzeichnisse nicht überschritten werden. Es kann andere Gründe für die Verwendung eines benutzerdefinierten Arbeitsverzeichnisses geben. Sie können ein anderes Arbeitsverzeichnis für jede BulkServiceManager-instance angeben, indem Sie die WorkingDirectory-Eigenschaft festlegen. Sie sind auch für das Erstellen und Entfernen von Verzeichnissen verantwortlich. Nachdem Sie die Massenentitäten durchlaufen haben, können Sie die Dateien aus dem Arbeitsverzeichnis sauber.
Wichtig
Die CleanupTempFiles-Methode entfernt alle Dateien (jedoch keine Unterverzeichnisse) innerhalb des Arbeitsverzeichnisses, unabhängig davon, ob die Dateien vom aktuellen BulkServiceManager-instance erstellt wurden oder nicht.
public async Task RunAsync(AuthorizationData authorizationData)
{
var bulkServiceManager = new BulkServiceManager(authorizationData);
var progress = new Progress<BulkOperationProgressInfo>(x =>
Console.WriteLine(String.Format("{0} % Complete", x.PercentComplete.ToString(CultureInfo.InvariantCulture)))
);
var downloadParameters = new DownloadParameters
{
CampaignIds = null,
DataScope = DataScope.EntityData,
Entities = DownloadEntity.Keywords,
FileType = DownloadFileType.Csv,
LastSyncTimeInUTC = null,
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = false // Set this value true if you want to overwrite the same file.
};
// The system temp directory will be used if another working directory is not specified. If you are
// using a hosted service such as Microsoft Azure you'll want to ensure you do not exceed the file or directory limits.
// You can specify a different working directory for each BulkServiceManager instance.
bulkServiceManager.WorkingDirectory = FileDirectory;
// The DownloadEntitiesAsync method returns IEnumerable<BulkEntity>, so the download file will not
// be accessible e.g. for CleanupTempFiles until you iterate over the result e.g. via ToList().
var resultEntities = (await bulkServiceManager.DownloadEntitiesAsync(
downloadParameters
)).ToList();
// The CleanupTempFiles method removes all files (but not sub-directories) within the working directory,
// whether or not the files were created by this BulkServiceManager instance.
bulkServiceManager.CleanupTempFiles();
}
BulkServiceManager bulkServiceManager = new BulkServiceManager(authorizationData);
Progress<BulkOperationProgressInfo> progress = new Progress<BulkOperationProgressInfo>() {
@Override
public void report(BulkOperationProgressInfo value) {
System.out.println(value.getPercentComplete() + "% Complete\n");
}
};
DownloadParameters downloadParameters = new DownloadParameters();
downloadParameters.setCampaignIds(null);
ArrayList<DataScope> dataScope = new ArrayList<DataScope>();
dataScope.add(DataScope.ENTITY_DATA);
downloadParameters.setDataScope(dataScope);
downloadParameters.setFileType(FileType);
downloadParameters.setLastSyncTimeInUTC(null);
ArrayList<DownloadEntity> bulkDownloadEntities = new ArrayList<DownloadEntity>();
bulkDownloadEntities.add(DownloadEntity.KEYWORDS);
downloadParameters.setEntities(bulkDownloadEntities);
downloadParameters.setResultFileDirectory(new File(FileDirectory));
downloadParameters.setResultFileName(ResultFileName);
downloadParameters.setOverwriteResultFile(true); // Set this value true if you want to overwrite the same file.
// The system temp directory will be used if another working directory is not specified. If you are
// using a cloud service such as Microsoft Azure you'll want to ensure you do not exceed the file or directory limits.
// You can specify a different working directory for each BulkServiceManager instance.
bulkServiceManager.setWorkingDirectory(new File(FileDirectory));
// The downloadEntitiesAsync method returns BulkEntityIterable, so the download file will not
// be accessible e.g. for cleanupTempFiles until you iterate over the result and close the BulkEntityIterable instance.
BulkEntityIterable tempEntities = bulkServiceManager.downloadEntitiesAsync(
downloadParameters,
null,
null
).get();
ArrayList<BulkEntity> resultEntities = new ArrayList<BulkEntity>();
for (BulkEntity entity : tempEntities) {
resultEntities.add(entity);
}
tempEntities.close();
// The cleanupTempFiles method removes all files (not sub-directories) within the working directory,
// whether or not the files were created by this BulkServiceManager instance.
bulkServiceManager.cleanupTempFiles();
Siehe auch
Sandbox
Codebeispiele für die Bing Ads-API
Adressen des Bing Ads-API-Webdiensts