Operação do Serviço GetBulkUploadStatus - Em massa
Obtém o estado e o progresso de conclusão de um pedido de carregamento em massa.
Elementos do Pedido
O objeto GetBulkUploadStatusRequest 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
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 GetBulkUploadStatusResponse 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 a conclusão do carregamento de HTTP POST. Por exemplo, um OperationError incluiria o código de erro BulkServiceFormatVersionNotSupported se o ficheiro carregado contivesse um ou mais registos em massa que não são suportados com a versão de formato de ficheiro correspondente. |
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 em massa carregado. O intervalo de valores está entre 0 e 100. Também deve comparar o estado do carregamento. Se o carregamento falhar, a percentagem concluída será reposta para zero (0). |
int |
| RequestStatus | O estado do carregamento. Seguem-se os possíveis valores de estado devolvidos. Concluído – o ficheiro de carregamento foi aceite e processado com êxito sem erros. CompletedWithErrors – o carregamento foi concluído com um ou mais erros. Embora o carregamento geral tenha sido efetuado com êxito, pode ter ocorrido um ou mais erros de adição ou atualização. Como melhor prática, deve pedir informações de erro através do elemento ResponseMode ao chamar GetBulkUploadUrl e verificar se existem erros no ResultFileUrl . Falha – o carregamento completo falhou devido a um erro inesperado. Pode submeter um novo carregamento com menos entidades ou tentar submeter novamente o mesmo carregamento mais tarde. FileUploaded - O pedido de carregamento foi recebido e está na fila para processamento. InProgress - O ficheiro de carregamento foi aceite e o carregamento está em curso. PendingFileUpload - O ficheiro de carregamento não foi recebido para o RequestId correspondente. UploadFileRowCountExceeded – o limite de registos em massa no ficheiro de carregamento foi excedido. Para obter mais informações sobre limites e melhores práticas de carregamento, veja Carregamento em Massa. UploadFileFormatNotSupported – o campo Formatar Nomeda Versão especificado no carregamento não é suportado para esta versão da API em Massa. |
cadeia |
| ResultFileUrl | O URL do ficheiro que contém os resultados pedidos, por exemplo, informações de erro de carregamento. O URL tem de ser utilizado no prazo de cinco minutos após a operação GetBulkUploadStatus devolver a cadeia de resposta de estado Completed ou CompletedWithErrors . Se não iniciar a transferência dentro deste período de tempo, terá de chamar GetBulkUploadStatus 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. |
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">GetBulkUploadStatus</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>
<GetBulkUploadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<RequestId i:nil="false">ValueHere</RequestId>
</GetBulkUploadStatusRequest>
</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>
<GetBulkUploadStatusResponse 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:e145="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e145:KeyValuePairOfstringstring>
<e145:key d4p1:nil="false">ValueHere</e145:key>
<e145:value d4p1:nil="false">ValueHere</e145:value>
</e145: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>
</GetBulkUploadStatusResponse>
</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<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
string requestId)
{
var request = new GetBulkUploadStatusRequest
{
RequestId = requestId
};
return (await BulkService.CallAsync((s, r) => s.GetBulkUploadStatusAsync(r), request));
}
static GetBulkUploadStatusResponse getBulkUploadStatus(
java.lang.String requestId) throws RemoteException, Exception
{
GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();
request.setRequestId(requestId);
return BulkService.getService().getBulkUploadStatus(request);
}
static function GetBulkUploadStatus(
$requestId)
{
$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];
$request = new GetBulkUploadStatusRequest();
$request->RequestId = $requestId;
return $GLOBALS['BulkProxy']->GetService()->GetBulkUploadStatus($request);
}
response=bulk_service.GetBulkUploadStatus(
RequestId=RequestId)
Requisitos
Serviço: BulkService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13
URL do Pedido
https://bulk.api.bingads.microsoft.com/Bulk/v13/BulkUploadStatus/Query
Elementos do Pedido
O objeto GetBulkUploadStatusRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Autorização | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada. 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 GetBulkUploadStatusResponse 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 JSON 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 a conclusão do carregamento de HTTP POST. Por exemplo, um OperationError incluiria o código de erro BulkServiceFormatVersionNotSupported se o ficheiro carregado contivesse um ou mais registos em massa que não são suportados com a versão de formato de ficheiro correspondente. |
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 em massa carregado. O intervalo de valores está entre 0 e 100. Também deve comparar o estado do carregamento. Se o carregamento falhar, a percentagem concluída será reposta para zero (0). |
int |
| RequestStatus | O estado do carregamento. Seguem-se os possíveis valores de estado devolvidos. Concluído – o ficheiro de carregamento foi aceite e processado com êxito sem erros. CompletedWithErrors – o carregamento foi concluído com um ou mais erros. Embora o carregamento geral tenha sido efetuado com êxito, pode ter ocorrido um ou mais erros de adição ou atualização. Como melhor prática, deve pedir informações de erro através do elemento ResponseMode ao chamar GetBulkUploadUrl e verificar se existem erros no ResultFileUrl . Falha – o carregamento completo falhou devido a um erro inesperado. Pode submeter um novo carregamento com menos entidades ou tentar submeter novamente o mesmo carregamento mais tarde. FileUploaded - O pedido de carregamento foi recebido e está na fila para processamento. InProgress - O ficheiro de carregamento foi aceite e o carregamento está em curso. PendingFileUpload - O ficheiro de carregamento não foi recebido para o RequestId correspondente. UploadFileRowCountExceeded – o limite de registos em massa no ficheiro de carregamento foi excedido. Para obter mais informações sobre limites e melhores práticas de carregamento, veja Carregamento em Massa. UploadFileFormatNotSupported – o campo Formatar Nomeda Versão especificado no carregamento não é suportado para esta versão da API em Massa. |
cadeia |
| ResultFileUrl | O URL do ficheiro que contém os resultados pedidos, por exemplo, informações de erro de carregamento. O URL tem de ser utilizado no prazo de cinco minutos após a operação GetBulkUploadStatus devolver a cadeia de resposta de estado Completed ou CompletedWithErrors . Se não iniciar a transferência dentro deste período de tempo, terá de chamar GetBulkUploadStatus 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. |
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 JSON
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. 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.
{
"RequestId": "ValueHere"
}
JSON de Resposta
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.
{
"Errors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"Message": "ValueHere"
}
],
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"PercentComplete": IntValueHere,
"RequestStatus": "ValueHere",
"ResultFileUrl": "ValueHere"
}
Sintaxe de Código
Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. 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<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
string requestId)
{
var request = new GetBulkUploadStatusRequest
{
RequestId = requestId
};
return (await BulkService.CallAsync((s, r) => s.GetBulkUploadStatusAsync(r), request));
}
static GetBulkUploadStatusResponse getBulkUploadStatus(
java.lang.String requestId) throws RemoteException, Exception
{
GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();
request.setRequestId(requestId);
return BulkService.getService().getBulkUploadStatus(request);
}
static function GetBulkUploadStatus(
$requestId)
{
$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];
$request = new GetBulkUploadStatusRequest();
$request->RequestId = $requestId;
return $GLOBALS['BulkProxy']->GetService()->GetBulkUploadStatus($request);
}
response=bulk_service.GetBulkUploadStatus(
RequestId=RequestId)