Operação de Serviço DownloadCampaignsByCampaignIds - Em Massa

Artigo
12/21/2023

Transfere as definições e os dados de desempenho das campanhas especificadas. Pode pedir todos os dados da campanha ou apenas os dados que foram alterados desde a última vez que transferiu a campanha.

Tem de utilizar as mesmas credenciais de utilizador para a operação de pedido de transferência ( downloadCampaignsByAccountIds ou DownloadCampaignsByCampaignIds) e a operação de consulta GetBulkDownloadStatus .

Sugestão

O Esquema de Ficheiros em Massa fornece detalhes sobre os registos que pode transferir e carregar. Adira às melhores práticas para garantir uma utilização justa para si e para todos os clientes do Microsoft Advertising. Para obter detalhes, veja Melhores Práticas de Transferência em Massa e Melhores Práticas de Carregamento em Massa.

Elementos do Pedido

O objeto DownloadCampaignsByCampaignIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento	Descrição	Tipo de Dados
Campanhas	As campanhas a transferir. Pode especificar um máximo de 1000 campanhas. As campanhas que especificar têm de pertencer à mesma conta.	Matriz CampaignScope
CompressionType	O tipo de compressão do ficheiro de transferência. Para valores possíveis, veja CompressionType. O tipo de compressão predefinido é Zip.	CompressionType
DataScope	Pode incluir dados de classificação de qualidade, como relevância de anúncios, além de dados de entidades, como definições de campanha. O valor predefinido é EntityData. Pode incluir múltiplos valores como sinalizadores. A forma como especifica vários sinalizadores depende da linguagem de programação que utiliza. Por exemplo, C# trata estes valores como valores de sinalizador e Java trata-os como uma matriz de cadeias. O SOAP deve incluir uma cadeia que contém uma lista delimitada por espaço de valores, por exemplo, `<DataScope>EntityData QualityScoreData</DataScope>`. Se BidSuggestionsData ou QualityScoreData estiverem incluídos, tem de pedir uma sincronização completa. Para efetuar uma sincronização completa, não defina LastSyncTimeInUTC , ou seja, deixe-o nulo.	DataScope
DownloadEntities	As entidades a incluir na transferência. Para obter uma lista de entidades que pode transferir, veja o conjunto de valores DownloadEntity . Tem de especificar pelo menos uma entidade de transferência e, caso contrário, a operação irá efetuar um erro.	DownloadEntity array (Matriz DownloadEntity )
DownloadFileType	O formato do ficheiro de transferência. Para obter os valores possíveis, veja DownloadFileType. A predefinição é CSV.	DownloadFileType
FormatVersion	O formato dos registos do ficheiro de transferência. Como melhor prática, deve sempre especificar a versão de formato mais recente. Atualmente, a única versão de formato suportado para a Versão 13 da API de Anúncios do Bing é a 6.0. Deve gerir registos de acordo com o Esquema de Ficheiro em Massa para a versão de formato correspondente.	cadeia
LastSyncTimeInUTC	A última vez que pediu uma transferência. A data e hora são expressas na Hora Universal Coordenada (UTC). Se especificar a hora da última sincronização, apenas as entidades que foram alteradas (adicionadas, atualizadas ou eliminadas) desde a data e hora especificadas serão transferidas. Se a campanha principal ou o grupo de anúncios tiver sido eliminado desde a hora da última sincronização especificada, só verá um registo eliminado para a campanha ou grupo de anúncios principal eliminado. Por exemplo, se uma campanha tiver sido eliminada, o ficheiro em massa não conterá registos eliminados para os grupos de anúncios, critérios, anúncios e palavras-chave que estavam na campanha. Os critérios de destino são tratados de forma ligeiramente diferente das outras entidades e os registos eliminados não são devolvidos. Se tiverem sido efetuadas alterações ao destino de uma campanha ou grupo de anúncios, todos os registos de critérios de sub-destino atualmente ativos são devolvidos. Normalmente, pede uma transferência completa quando chama a operação pela primeira vez ao definir este elemento como nulo. Em todas as chamadas subsequentes, defina a hora da última sincronização para o carimbo de data/hora da transferência anterior. O ficheiro de transferência contém o carimbo de data/hora da transferência na coluna Hora da Sincronização do registo conta . Deve utilizar a Hora de Sincronização da conta para definir este elemento da próxima vez que pedir uma transferência. Se definir uma data e hora que seja superior a 30 dias antes, será devolvido um erro.	dateTime

Elementos do Cabeçalho do Pedido

Elemento	Descrição	Tipo de Dados
AuthenticationToken	O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).	cadeia
CustomerAccountId	O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.	cadeia
CustomerId	O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.	cadeia
DeveloperToken	O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador.	cadeia
Palavra-passe	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia
Nome de Utilizador	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia

Elementos de Resposta

O objeto DownloadCampaignsByCampaignIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento	Descrição	Tipo de Dados
DownloadRequestId	O identificador do pedido de transferência. Utilize o identificador para chamar a operação GetBulkDownloadStatus para verificar o estado da transferência. O identificador é válido durante um máximo de dois dias. Se não tiver transferido o ficheiro com êxito neste período, este será removido do site de transferência e terá de obter um novo identificador de pedido de transferência. A cadeia tem um comprimento até 40 e pode conter qualquer caráter.	cadeia

Elementos do Cabeçalho de Resposta

Elemento	Descrição	Tipo de Dados
TrackingId	O identificador da entrada de registo que contém os detalhes da chamada à API.	cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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>

Soap de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta SOAP.

<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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: BulkService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13

Compartilhar via