Busque y ejecute informes

Una vez que haya identificado o creado un informe que satisfaga sus necesidades, es momento de generar resultados. Los resultados del informe se almacenan en archivos de informes que se pueden recuperar y manipular de manera programática. Un archivo de informe se genera como resultado de la ejecución de un informe.

En esta guía, se explica cómo generar archivos de informes de manera programática con el servicio de informes.

Cómo encontrar un informe

Para ejecutar un informe, debe conocer el ID del informe. Si acaba de crear o actualizar un informe, este valor se puede encontrar en el campo id del recurso del informe que se mostró. Se recomienda que los usuarios almacenen estos ID que se muestran para realizar una búsqueda posterior.

Si no conoce el ID del informe que desea ejecutar, puede consultar la lista de todos los informes disponibles para encontrar el que desea ejecutar. En el siguiente ejemplo, se muestra cómo buscar un informe por criterios definidos por el usuario:

C#

Report target = null;
ReportList reports;
String nextPageToken = null;

do {
  // Create and execute the reports list request.
  ReportsResource.ListRequest request = service.Reports.List(profileId);
  request.PageToken = nextPageToken;
  reports = request.Execute();

  foreach (Report report in reports.Items) {
    if (IsTargetReport(report)) {
      target = report;
      break;
    }
  }

  // Update the next page token.
  nextPageToken = reports.NextPageToken;
} while (target == null
    && reports.Items.Any()
    && !String.IsNullOrEmpty(nextPageToken));

Java

Report target = null;
ReportList reports;
String nextPageToken = null;

do {
  // Create and execute the reports list request.
  reports = reporting.reports().list(profileId).setPageToken(nextPageToken).execute();

  for (Report report : reports.getItems()) {
    if (isTargetReport(report)) {
      target = report;
      break;
    }
  }

  // Update the next page token.
  nextPageToken = reports.getNextPageToken();
} while (target == null
    && !reports.getItems().isEmpty()
    && !Strings.isNullOrEmpty(nextPageToken));

PHP

$target = null;
$response = null;
$pageToken = null;

do {
    // Create and execute the report list request.
    $response = $this->service->reports->listReports(
        $userProfileId,
        ['pageToken' => $pageToken]
    );

    foreach ($response->getItems() as $report) {
        if ($this->isTargetReport($report)) {
            $target = $report;
            break;
        }
    }

    $pageToken = $response->getNextPageToken();
} while (empty($target) && !empty($response->getItems()) && !empty($pageToken));

Python

target = None

# Construct the request.
request = service.reports().list(profileId=profile_id)

while True:
  response = request.execute()

  for report in response['items']:
    if is_target_report(report):
      target = report
      break

  if not target and response['items'] and response['nextPageToken']:
    request = service.reports().list_next(request, response)
  else:
    break

Ruby

page_token = nil
target = nil

loop do
  result = service.list_reports(profile_id, page_token: page_token)

  result.items.each do |report|
    if target_report?(report)
      target = report
      break
    end
  end

  page_token = (result.next_page_token if target.nil? && result.items.any?)
  break if page_token.to_s.empty?
end

Consulta la documentación de referencia para ver los parámetros opcionales que puedes especificar a fin de controlar cómo se ordena y ordena la lista de informes que se muestran. Controlar el orden y el orden de esta lista puede ser especialmente útil para encontrar informes que se modificaron recientemente.

Ejecuta un informe

Una vez que encuentres un informe adecuado, puedes usar el servicio de informes para ejecutarlo y generar un archivo de informe nuevo. Los informes se pueden ejecutar de forma síncrona o asíncrona (predeterminado), según la complejidad del informe y el tiempo que demore en procesarse. Consulta la guía de Informes síncronos para obtener detalles sobre los informes síncronos y los asíncronos.

Para ejecutar un informe, realice una llamada al método de ejecución del servicio Report, como se muestra en el siguiente ejemplo:

C#

// Run the report.
File file = service.Reports.Run(profileId, reportId).Execute();

Java

// Run the report.
File file = reporting.reports().run(profileId, reportId).execute();

PHP

// Run the report.
$file = $this->service->reports->run($userProfileId, $reportId);

Python

# Run the report.
report_file = service.reports().run(
    profileId=profile_id, reportId=report_id).execute()

Ruby

# Run the report.
report_file = service.run_report(profile_id, report_id)

La respuesta a esta solicitud es un recurso de archivos. Si esta fuera una solicitud de ejecución síncrona, se completarían todos los campos del recurso mostrado y el archivo estaría listo para descargarse. Sin embargo, como esta era una solicitud de ejecución asíncrona, faltan algunos campos clave y el status del archivo se establecerá en PROCESSING, dado que el informe aún no terminó de ejecutarse.

Nota: Si la ejecución de un informe síncrono tarda demasiado en completarse, se convertirá automáticamente en una ejecución de informe asíncrona. Siempre verifica el campo status del recurso de archivos que se muestra para determinar si un informe terminó de ejecutarse.

¿Cuándo se termina de ejecutar un informe?

Cuando ejecuta un informe de manera asíncrona, se genera un archivo de marcador de posición de inmediato y este se pone en una cola para procesarlo. El marcador de posición contendrá dos datos clave para ayudarlo a determinar cuándo termina de generarse el informe:

1. Un campo id, que se puede usar para hacer referencia a este archivo en solicitudes posteriores.
2. Un campo status, que representa el estado actual del informe ejecutado.

Para determinar cuándo termina de ejecutarse un informe, debes verificar el status del archivo de forma periódica, como se muestra en el siguiente ejemplo:

C#

// Wait for the report file to finish processing.
// An exponential backoff policy is used to limit retries and conserve quota.
int sleep = 0;
int startTime = GetCurrentTimeInSeconds();
do {
  File file = service.Files.Get(reportId, fileId).Execute();

  if ("REPORT_AVAILABLE".Equals(file.Status)) {
    Console.WriteLine("File status is {0}, ready to download.", file.Status);
    return;
  } else if (!"PROCESSING".Equals(file.Status)) {
    Console.WriteLine("File status is {0}, processing failed.", file.Status);
    return;
  } else if (GetCurrentTimeInSeconds() - startTime > MAX_RETRY_ELAPSED_TIME) {
    Console.WriteLine("File processing deadline exceeded.");
    return;
  }

  sleep = GetNextSleepInterval(sleep);
  Console.WriteLine("File status is {0}, sleeping for {1} seconds.", file.Status, sleep);
  Thread.Sleep(sleep * 1000);
} while (true);

Java

BackOff backOff =
    new ExponentialBackOff.Builder()
        .setInitialIntervalMillis(10 * 1000) // 10 second initial retry
        .setMaxIntervalMillis(10 * 60 * 1000) // 10 minute maximum retry
        .setMaxElapsedTimeMillis(60 * 60 * 1000) // 1 hour total retry
        .build();

do {
  File file = reporting.files().get(reportId, fileId).execute();

  if ("REPORT_AVAILABLE".equals(file.getStatus())) {
    // File has finished processing.
    System.out.printf("File status is %s, ready to download.%n", file.getStatus());
    return file;
  } else if (!"PROCESSING".equals(file.getStatus())) {
    // File failed to process.
    System.out.printf("File status is %s, processing failed.", file.getStatus());
    return null;
  }

  // The file hasn't finished processing yet, wait before checking again.
  long retryInterval = backOff.nextBackOffMillis();
  if (retryInterval == BackOff.STOP) {
    System.out.println("File processing deadline exceeded.%n");
    return null;
  }

  System.out.printf("File status is %s, sleeping for %dms.%n", file.getStatus(), retryInterval);
  Thread.sleep(retryInterval);
} while (true);

PHP

// Wait for the report file to finish processing.
// An exponential backoff policy is used to limit retries and conserve
// quota.
$sleep = 0;
$startTime = time();

do {
    $file = $this->service->files->get($reportId, $fileId);

    if ($file->getStatus() === 'REPORT_AVAILABLE') {
        printf('File status is %s, ready to download<br>', $file->getStatus());
        return $file;
    } elseif ($file->getStatus() !== 'PROCESSING') {
        printf('File status is %s, processing failed<br>', $file->getStatus());
        return null;
    } elseif (time() - $startTime > self::MAX_RETRY_ELAPSED_TIME) {
        printf('File processing deadline exceeded<br>');
        return null;
    }

    $sleep = $this->getNextSleepInterval($sleep);
    printf(
        'File status is %s, sleeping for %d seconds<br>',
        $file->getStatus(),
        $sleep
    );
    $this->sleep($sleep);
} while (true);

Python

# Wait for the report file to finish processing.
# An exponential backoff strategy is used to conserve request quota.
sleep = 0
start_time = time.time()
while True:
  report_file = service.files().get(
      reportId=report_id, fileId=file_id).execute()

  status = report_file['status']
  if status == 'REPORT_AVAILABLE':
    print 'File status is %s, ready to download.' % status
    return
  elif status != 'PROCESSING':
    print 'File status is %s, processing failed.' % status
    return
  elif time.time() - start_time > MAX_RETRY_ELAPSED_TIME:
    print 'File processing deadline exceeded.'
    return

  sleep = next_sleep_interval(sleep)
  print 'File status is %s, sleeping for %d seconds.' % (status, sleep)
  time.sleep(sleep)

Ruby

# Wait for the report file to finish processing.
# An exponential backoff strategy is used to conserve request quota.
interval = 0
start_time = Time.now
loop do
  report_file = service.get_file(report_id, file_id)

  status = report_file.status
  if status == 'REPORT_AVAILABLE'
    puts format('File status is %s, ready to download.', status)
    break
  elsif status != 'PROCESSING'
    puts format('File status is %s, processing failed.', status)
    break
  elsif Time.now - start_time > MAX_RETRY_ELAPSED_TIME
    puts 'File processing deadline exceeded.'
    break
  end

  interval = next_sleep_interval(interval)
  puts format('File status is %s, sleeping for %d seconds.', status,
    interval)
  sleep(interval)
end

Cuando status cambie a REPORT_AVAILABLE, el archivo estará listo para descargarse. Como se muestra en el ejemplo anterior, se recomienda implementar una estrategia de retirada exponencial durante el sondeo, para optimizar el uso de la cuota de solicitudes.