A API Campaign Manager 360 permite fazer o download de arquivos de relatório, que são o resultado da geração de um relatório no Criador de relatórios. Ele também permite que os usuários tenham acesso direto a um arquivo por meio de um link.
Dependendo do tipo de download que você deseja realizar, use uma das seguintes abordagens:
- Download direto: use Files.get com o parâmetro
alt=media
. - Download de arquivos em um navegador: use
browserUrl
do recurso Files.
O restante deste guia fornece instruções detalhadas para executar esses tipos de downloads com o recurso Files.
Pré-requisitos
Para fazer o download de um arquivo, você precisará de algumas informações:
- O ID do relatório ao qual o arquivo pertence. Para encontrar esse código, crie um novo relatório ou pesquise um existente.
- O ID do arquivo a ser baixado. É possível encontrar esse código ao gerar o relatório da etapa anterior ou ao consultar a lista de arquivos existentes como no exemplo abaixo:
C#
File target = null;
FileList files;
String nextPageToken = null;
do {
// Create and execute the files list request.
ReportsResource.FilesResource.ListRequest request =
service.Reports.Files.List(profileId, reportId);
request.PageToken = nextPageToken;
files = request.Execute();
foreach (File file in files.Items) {
if (IsTargetFile(file)) {
target = file;
break;
}
}
// Update the next page token.
nextPageToken = files.NextPageToken;
} while (target == null
&& files.Items.Any()
&& !String.IsNullOrEmpty(nextPageToken));
Java
File target = null;
FileList files;
String nextPageToken = null;
do {
// Create and execute the files list request.
files = reporting.reports().files().list(profileId, reportId).setPageToken(nextPageToken)
.execute();
for (File file : files.getItems()) {
if (isTargetFile(file)) {
target = file;
break;
}
}
// Update the next page token.
nextPageToken = files.getNextPageToken();
} while (target == null
&& !files.getItems().isEmpty()
&& !Strings.isNullOrEmpty(nextPageToken));
PHP
$target = null;
$response = null;
$pageToken = null;
do {
// Create and execute the file list request.
$response = $this->service->reports_files->listReportsFiles(
$userProfileId,
$reportId,
['pageToken' => $pageToken]
);
foreach ($response->getItems() as $file) {
if ($this->isTargetFile($file)) {
$target = $file;
break;
}
}
$pageToken = $response->getNextPageToken();
} while (empty($target) && !empty($response->getItems()) && !empty($pageToken));
Python
target = None
request = service.reports().files().list(
profileId=profile_id, reportId=report_id)
while True:
response = request.execute()
for report_file in response['items']:
if is_target_file(report_file):
target = report_file
break
if not target and response['items'] and response['nextPageToken']:
request = service.reports().files().list_next(request, response)
else:
break
Ruby
page_token = nil
target = nil
loop do
result = service.list_report_files(profile_id, report_id,
page_token: page_token)
result.items.each do |file|
if target_file?(file)
target = file
break
end
end
page_token = (result.next_page_token if target.nil? && result.items.any?)
break if page_token.to_s.empty?
end
O campo status
do recurso de arquivo precisa ser definido como REPORT_AVAILABLE
para ser qualificado para download.
Download direto
Para fazer um download direto, faça uma solicitação HTTP GET
autorizada para o serviço Arquivos e inclua o parâmetro de consulta alt=media
. Veja um exemplo de solicitação:
GET https://www.googleapis.com/dfareporting/v3.4/reports/12345/files/12345?alt=media HTTP/1.1 Authorization: Bearer your_auth_token
Esteja ciente de que a resposta que você receber conterá um redirecionamento, de forma que o ideal é que seu aplicativo esteja configurado para lidar com isso automaticamente. Se preferir fazer isso manualmente, é possível encontrar o URL de redirecionamento no cabeçalho Location
da resposta.
A maioria das bibliotecas cliente oficiais do Google fornece métodos convenientes para iniciar um download direto, como mostrado no exemplo abaixo. Se você preferir iniciar um download manualmente, um URL pré-elaborado será fornecido no campo apiUrl
do recurso de arquivo.
C#
// Retrieve the file metadata.
File file = service.Files.Get(reportId, fileId).Execute();
if ("REPORT_AVAILABLE".Equals(file.Status)) {
// Create a get request.
FilesResource.GetRequest getRequest = service.Files.Get(reportId, fileId);
// Optional: adjust the chunk size used when downloading the file.
// getRequest.MediaDownloader.ChunkSize = MediaDownloader.MaximumChunkSize;
// Execute the get request and download the file.
using (System.IO.FileStream outFile = new System.IO.FileStream(GenerateFileName(file),
System.IO.FileMode.Create, System.IO.FileAccess.Write)) {
getRequest.Download(outFile);
Console.WriteLine("File {0} downloaded to {1}", file.Id, outFile.Name);
}
}
Java
// Retrieve the file metadata.
File file = reporting.files().get(reportId, fileId).execute();
if ("REPORT_AVAILABLE".equals(file.getStatus())) {
// Prepare a local file to download the report contents to.
java.io.File outFile = new java.io.File(Files.createTempDir(), generateFileName(file));
// Create a get request.
Get getRequest = reporting.files().get(reportId, fileId);
// Optional: adjust the chunk size used when downloading the file.
// getRequest.getMediaHttpDownloader().setChunkSize(MediaHttpDownloader.MAXIMUM_CHUNK_SIZE);
// Execute the get request and download the file.
try (OutputStream stream = new FileOutputStream(outFile)) {
getRequest.executeMediaAndDownloadTo(stream);
}
System.out.printf("File %d downloaded to %s%n", file.getId(), outFile.getAbsolutePath());
}
PHP
// Retrieve the file metadata.
$file = $this->service->files->get($reportId, $fileId);
if ($file->getStatus() === 'REPORT_AVAILABLE') {
try {
// Prepare a local file to download the report contents to.
$fileName = join(
DIRECTORY_SEPARATOR,
[sys_get_temp_dir(), $this->generateFileName($file)]
);
$fileResource = fopen($fileName, 'w+');
$fileStream = \GuzzleHttp\Psr7\stream_for($fileResource);
// Execute the get request and download the file.
$httpClient = $this->service->getClient()->authorize();
$result = $httpClient->request(
'GET',
$file->getUrls()->getApiUrl(),
[\GuzzleHttp\RequestOptions::SINK => $fileStream]
);
printf('<h3>Report file saved to: %s</h3>', $fileName);
} finally {
$fileStream->close();
fclose($fileResource);
}
}
Python
# Retrieve the file metadata.
report_file = service.files().get(
reportId=report_id, fileId=file_id).execute()
if report_file['status'] == 'REPORT_AVAILABLE':
# Prepare a local file to download the report contents to.
out_file = io.FileIO(generate_file_name(report_file), mode='wb')
# Create a get request.
request = service.files().get_media(reportId=report_id, fileId=file_id)
# Create a media downloader instance.
# Optional: adjust the chunk size used when downloading the file.
downloader = http.MediaIoBaseDownload(
out_file, request, chunksize=CHUNK_SIZE)
# Execute the get request and download the file.
download_finished = False
while download_finished is False:
_, download_finished = downloader.next_chunk()
print('File %s downloaded to %s' % (report_file['id'],
os.path.realpath(out_file.name)))
Ruby
# Retrieve the file metadata.
report_file = service.get_file(report_id, file_id)
return unless report_file.status == 'REPORT_AVAILABLE'
# Prepare a local file to download the report contents to.
File.open(generate_file_name(report_file), 'w') do |out_file|
# Execute the download request. Providing a download destination
# retrieves the file contents rather than the file metadata.
service.get_file(report_id, file_id, download_dest: out_file)
puts format('File %s downloaded to %s', file_id,
File.absolute_path(out_file.path))
end
Downloads recuperáveis
Ao fazer o download de arquivos de relatório grandes, é possível que ocorra uma falha no meio do download. Para facilitar a recuperação e a retomada de um download com falha, o serviço de arquivos é compatível com a funcionalidade de download parcial.
O download parcial envolve a solicitação de partes específicas de um arquivo, permitindo que você divida downloads grandes em partes menores. É possível especificar qual parte de um arquivo você quer transferir por download incluindo um intervalo de bytes no cabeçalho HTTP Range
da solicitação. Por exemplo:
Range: bytes=500-999
A funcionalidade de download parcial é oferecida por muitas bibliotecas de clientes por um serviço de download de mídia. Consulte a documentação da biblioteca cliente para mais detalhes.
Fazer o download de arquivos em um navegador
Se você quer oferecer aos usuários uma maneira de fazer o download de um arquivo diretamente do navegador da Web, use o URL fornecido no campo browserUrl
do recurso Arquivo. Você pode redirecionar um usuário para este URL ou oferecê-lo como um link clicável. Em ambos os casos, o usuário precisará estar conectado a uma Conta do Google com acesso aos relatórios do Campaign Manager 360 e ter as permissões corretas para acessar o arquivo especificado e iniciar o download.
C#
File file = service.Files.Get(reportId, fileId).Execute();
String browserUrl = file.Urls.BrowserUrl;
Java
File file = reporting.files().get(reportId, fileId).execute();
String browserUrl = file.getUrls().getBrowserUrl();
PHP
$file = $this->service->files->get($reportId, $fileId);
$browserUrl = $file->getUrls()->getBrowserUrl();
Python
report_file = service.files().get(
reportId=report_id, fileId=file_id).execute()
browser_url = report_file['urls']['browserUrl']
Ruby
report_file = service.get_file(report_id, file_id)
browser_url = report_file.urls.browser_url