Operação do Serviço GetBulkDownloadStatus - Em massa

Artigo
12/21/2023

Obtém o estado de um pedido de transferência em massa.

Nota

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 .

Elementos do Pedido

O objeto GetBulkDownloadStatusRequest 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
RequestId	O identificador do pedido de transferência. As operações DownloadCampaignsByAccountIds e DownloadCampaignsByCampaignIds devolvem este elemento como DownloadRequestId. 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 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 GetBulkDownloadStatusResponse 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
Erros	Uma matriz de objetos OperationError correspondentes a erros encontrados durante o processamento do sistema do ficheiro em massa após o pedido de transferência ter sido submetido.	Matriz OperationError
ForwardCompatibilityMap	A lista de cadeias de chave e valor para compatibilidade de reencaminhamento para evitar alterações interruptivas quando novos elementos são adicionados na versão atual da API. As alterações de compatibilidade de reencaminhamento serão registadas aqui em versões futuras. Atualmente, não existem alterações de compatibilidade para esta operação.	Matriz KeyValuePairOfstringstring
Percentagem de Conclusão	A percentagem de conclusão do progresso para o processamento do sistema do ficheiro de transferência em massa.	int
RequestStatus	O estado da transferência. Os valores possíveis são os seguintes. Concluído – a transferência foi concluída com êxito. InProgress - A transferência está em curso. Falha - A transferência falhou. Pode submeter uma nova transferência com menos entidades, sem dados de pontuação de qualidade e sugestões de oferta, ou tentar submeter novamente a mesma transferência mais tarde. FailedFullSyncRequired – o elemento LastSyncTimeInUTC do pedido tem de ser definido como nulo, por exemplo, se a conta especificada tiver sido incluída numa migração de dados. Depois de pedir uma transferência completa, pode começar a pedir transferências delta novamente.	cadeia
ResultFileUrl	O URL que contém os dados de transferência quando o valor RequestStatus é Concluído. Tem cinco minutos a partir do momento em que este URL é devolvido para transferir o ficheiro. Se não iniciar a transferência dentro deste período de tempo, terá de chamar GetBulkDownloadStatus novamente para obter um novo URL. Não deve assumir uma dependência no domínio do URL de transferência, uma vez que está sujeito a alterações. O ficheiro de transferência é comprimido (no formato zip), pelo que tem de deszipar o ficheiro para aceder aos dados. Para obter informações sobre o formato de ficheiro em massa, veja Bulk File Schema (Esquema de Ficheiros em Massa).	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">GetBulkDownloadStatus</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>
    <GetBulkDownloadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <RequestId i:nil="false">ValueHere</RequestId>
    </GetBulkDownloadStatusRequest>
  </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>
    <GetBulkDownloadStatusResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Errors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <OperationError>
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <Message d4p1:nil="false">ValueHere</Message>
        </OperationError>
      </Errors>
      <ForwardCompatibilityMap xmlns:e215="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e215:KeyValuePairOfstringstring>
          <e215:key d4p1:nil="false">ValueHere</e215:key>
          <e215:value d4p1:nil="false">ValueHere</e215:value>
        </e215:KeyValuePairOfstringstring>
      </ForwardCompatibilityMap>
      <PercentComplete>ValueHere</PercentComplete>
      <RequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</RequestStatus>
      <ResultFileUrl d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</ResultFileUrl>
    </GetBulkDownloadStatusResponse>
  </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<GetBulkDownloadStatusResponse> GetBulkDownloadStatusAsync(
	string requestId)
{
	var request = new GetBulkDownloadStatusRequest
	{
		RequestId = requestId
	};

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

static GetBulkDownloadStatusResponse getBulkDownloadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkDownloadStatusRequest request = new GetBulkDownloadStatusRequest();

	request.setRequestId(requestId);

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

static function GetBulkDownloadStatus(
	$requestId)
{

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

	$request = new GetBulkDownloadStatusRequest();

	$request->RequestId = $requestId;

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

response=bulk_service.GetBulkDownloadStatus(
	RequestId=RequestId)

Requisitos

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

Partilhar via