DownloadCampaignsByCampaignIds Service Operation – Bulk

Artikel
12/21/2023

Lädt Einstellungen und Leistungsdaten für die angegebenen Kampagnen herunter. Sie können alle Kampagnendaten oder nur die Daten anfordern, die sich seit dem letzten Herunterladen der Kampagne geändert haben.

Sie müssen die gleichen Benutzeranmeldeinformationen für den Downloadanforderungsvorgang (entweder DownloadCampaignsByAccountIds oder DownloadCampaignsByCampaignIds) und den GetBulkDownloadStatus-Abrufvorgang verwenden.

Tipp

Das Massendateischema enthält Details zu Datensätzen, die Sie herunterladen und hochladen können. Halten Sie sich an die bewährten Methoden, um eine faire Nutzung für sich selbst und alle Microsoft Advertising-Kunden sicherzustellen. Weitere Informationen finden Sie unter Bewährte Methoden für Massendownloads und Bewährte Methoden für Massenuploads.

Anfordern von Elementen

Das DownloadCampaignsByCampaignIdsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element	Beschreibung	Datentyp
Kampagnen	Die Kampagnen, die heruntergeladen werden sollen. Sie können maximal 1.000 Kampagnen angeben. Die von Ihnen angegebenen Kampagnen müssen zum gleichen Konto gehören.	CampaignScope-Array
CompressionType	Der Komprimierungstyp der Downloaddatei. Mögliche Werte finden Sie unter CompressionType. Der Standardkomprimierungstyp ist Zip.	CompressionType
Datascope	Sie können Zusätzlich zu Entitätsdaten wie Kampagneneinstellungen Auch Qualitätsbewertungsdaten wie z. B. Anzeigenrelevanz einschließen. Der Standardwert ist EntityData. Sie können mehrere Werte als Flags einschließen. Wie Sie mehrere Flags angeben, hängt von der programmiersprache ab, die Sie verwenden. C# behandelt diese Werte beispielsweise als Flagwerte, und Java behandelt sie als Array von Zeichenfolgen. Das SOAP sollte eine Zeichenfolge enthalten, die eine durch Leerzeichen getrennte Liste von Werten enthält, `<DataScope>EntityData QualityScoreData</DataScope>`z. B. . Wenn BidSuggestionsData oder QualityScoreData enthalten sind, müssen Sie eine vollständige Synchronisierung anfordern. Um eine vollständige Synchronisierung durchzuführen, legen Sie LastSyncTimeInUTC nicht fest, d. h. lassen Sie es null.	Datascope
DownloadEntities	Die Entitäten, die in den Download eingeschlossen werden sollen. Eine Liste der Entitäten, die Sie herunterladen können, finden Sie unter DownloadEntity-Wertsatz . Sie müssen mindestens eine Downloadentität angeben, andernfalls tritt beim Vorgang ein Fehler auf.	DownloadEntity-Array
DownloadFileType	Das Format der Downloaddatei. Mögliche Werte finden Sie unter DownloadFileType. Der Standardwert ist CSV.	DownloadFileType
Formatversion	Das Format für Datensätze der Downloaddatei. Als bewährte Methode sollten Sie immer die neueste Formatversion angeben. Die derzeit einzige unterstützte Formatversion für Version 13 der Bing Ads-API ist 6.0. Sie sollten Datensätze gemäß dem Massendateischema für die entsprechende Formatversion verwalten.	Zeichenfolge
LastSyncTimeInUTC	Der Zeitpunkt, zu dem Sie zuletzt einen Download angefordert haben. Das Datum und die Uhrzeit werden in koordinierter Weltzeit (UTC) ausgedrückt. Wenn Sie den Zeitpunkt der letzten Synchronisierung angeben, werden nur die Entitäten heruntergeladen, die seit dem angegebenen Datum und der angegebenen Uhrzeit geändert (hinzugefügt, aktualisiert oder gelöscht wurden). Wenn die übergeordnete Kampagne oder Anzeigengruppe seit der angegebenen letzten Synchronisierungszeit gelöscht wurde, wird nur ein gelöschter Datensatz für die gelöschte übergeordnete Kampagne oder Anzeigengruppe angezeigt. Wenn beispielsweise eine Kampagne gelöscht wurde, enthält die Massendatei keine gelöschten Datensätze für die Anzeigengruppen, Kriterien, Anzeigen und Schlüsselwörter, die sich in der Kampagne befanden. Das Zielkriterium unterscheidet sich geringfügig von anderen Entitäten, und gelöschte Datensätze werden nicht zurückgegeben. Wenn Änderungen am Ziel einer Kampagne oder Anzeigengruppe vorgenommen wurden, werden alle derzeit aktiven Unterzielkriteriumseinträge zurückgegeben. In der Regel fordern Sie einen vollständigen Download an, wenn Sie den Vorgang zum ersten Mal aufrufen, indem Sie dieses Element auf NULL festlegen. Bei allen nachfolgenden Aufrufen legen Sie den Zeitpunkt der letzten Synchronisierung auf den Zeitstempel des vorherigen Downloads fest. Die Downloaddatei enthält den Zeitstempel des Downloads in der Spalte Synchronisierungszeit des Kontodatensatzes . Sie sollten die Kontosynchronisierungszeit verwenden, um dieses Element festzulegen, wenn Sie das nächste Mal einen Download anfordern. Wenn Sie ein Datum und eine Uhrzeit festlegen, die mehr als 30 Tage vorher liegt, wird ein Fehler zurückgegeben.	dateTime

Anforderungsheaderelemente

Element	Beschreibung	Datentyp
AuthenticationToken	Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Weitere Informationen finden Sie unter Authentifizierung mit OAuth.	Zeichenfolge
CustomerAccountId	Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.	Zeichenfolge
Customerid	Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.	Zeichenfolge
DeveloperToken	Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird. Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.	Zeichenfolge
Kennwort	Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen.	Zeichenfolge
UserName	Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen.	Zeichenfolge

Antwortelemente

Das DownloadCampaignsByCampaignIdsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.

Antworttextelemente

Element	Beschreibung	Datentyp
DownloadRequestId	Der Bezeichner der Downloadanforderung. Sie verwenden den Bezeichner, um den GetBulkDownloadStatus-Vorgang aufzurufen, um die status des Downloads zu überprüfen. Der Bezeichner ist maximal zwei Tage gültig. Wenn Sie die Datei innerhalb dieses Zeitraums nicht erfolgreich heruntergeladen haben, wird sie von der Downloadwebsite entfernt, und Sie müssen eine neue Downloadanforderungs-ID abrufen. Die Zeichenfolge hat eine Länge bis zu 40 und kann beliebige Zeichen enthalten.	Zeichenfolge

Antwortheaderelemente

Element	Beschreibung	Datentyp
TrackingId	Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält.	Zeichenfolge

SOAP anfordern

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">DownloadCampaignsByCampaignIds</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DownloadCampaignsByCampaignIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Campaigns i:nil="false">
        <CampaignScope>
          <CampaignId>ValueHere</CampaignId>
          <ParentAccountId>ValueHere</ParentAccountId>
        </CampaignScope>
      </Campaigns>
      <CompressionType i:nil="false">ValueHere</CompressionType>
      <DataScope>ValueHere</DataScope>
      <DownloadEntities i:nil="false">
        <DownloadEntity>ValueHere</DownloadEntity>
      </DownloadEntities>
      <DownloadFileType i:nil="false">ValueHere</DownloadFileType>
      <FormatVersion i:nil="false">ValueHere</FormatVersion>
      <LastSyncTimeInUTC i:nil="false">ValueHere</LastSyncTimeInUTC>
    </DownloadCampaignsByCampaignIdsRequest>
  </s:Body>
</s:Envelope>

Antwort-SOAP

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <DownloadCampaignsByCampaignIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByCampaignIdsResponse>
  </s:Body>
</s:Envelope>

Codesyntax

Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

public async Task<DownloadCampaignsByCampaignIdsResponse> DownloadCampaignsByCampaignIdsAsync(
	IList<CampaignScope> campaigns,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByCampaignIdsRequest
	{
		Campaigns = campaigns,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

	return (await BulkService.CallAsync((s, r) => s.DownloadCampaignsByCampaignIdsAsync(r), request));
}

static DownloadCampaignsByCampaignIdsResponse downloadCampaignsByCampaignIds(
	ArrayOfCampaignScope campaigns,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByCampaignIdsRequest request = new DownloadCampaignsByCampaignIdsRequest();

	request.setCampaigns(campaigns);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

	return BulkService.getService().downloadCampaignsByCampaignIds(request);
}

static function DownloadCampaignsByCampaignIds(
	$campaigns,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

	$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];

	$request = new DownloadCampaignsByCampaignIdsRequest();

	$request->Campaigns = $campaigns;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

	return $GLOBALS['BulkProxy']->GetService()->DownloadCampaignsByCampaignIds($request);
}

response=bulk_service.DownloadCampaignsByCampaignIds(
	Campaigns=Campaigns,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

Anforderungen

Dienst: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Freigeben über