گزارش ها را پیدا و اجرا کنید

پس از شناسایی یا ایجاد گزارشی که نیازهای شما را برآورده می کند، نوبت به تولید خروجی می رسد. خروجی گزارش در فایل‌های گزارش ذخیره می‌شود که می‌توان آن‌ها را به‌صورت برنامه‌ریزی بازیابی و دستکاری کرد. یک فایل گزارش در نتیجه اجرای یک گزارش تولید می شود.

این راهنما نحوه تولید فایل های گزارش را از طریق سرویس گزارش ها به صورت برنامه نویسی توضیح می دهد.

یک گزارش پیدا کنید

برای اجرای یک گزارش، باید شناسه گزارش را بدانید. اگر به‌تازگی گزارشی را ایجاد یا به‌روزرسانی کرده‌اید ، این مقدار را می‌توانید در قسمت id منبع گزارشی که برگردانده شده است پیدا کنید. توصیه می شود که کاربران این شناسه های برگشتی را برای جستجوی بعدی ذخیره کنند.

اگر شناسه گزارشی را که می‌خواهید اجرا کنید نمی‌دانید، می‌توانید فهرست همه گزارش‌های موجود را بررسی کنید تا گزارش مورد نظر خود را پیدا کنید. مثال زیر نحوه جستجوی گزارش را بر اساس برخی معیارهای تعریف شده توسط کاربر نشان می دهد:

سی شارپ

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

جاوا

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

پایتون

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

روبی

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

برای کنترل نحوه مرتب‌سازی و مرتب‌سازی فهرست گزارش‌های برگشتی، برای پارامترهای اختیاری که می‌توانید تعیین کنید، به مستندات مرجع مراجعه کنید. کنترل مرتب‌سازی و مرتب‌سازی این فهرست می‌تواند برای یافتن گزارش‌هایی که اخیراً اصلاح شده‌اند مفید باشد.

یک گزارش اجرا کنید

هنگامی که یک گزارش مناسب پیدا کردید، می توانید از سرویس گزارش برای اجرای آن و ایجاد یک فایل گزارش جدید استفاده کنید. بسته به پیچیدگی گزارش و زمان پردازش آن، گزارش ها می توانند به صورت همزمان یا ناهمزمان (پیش فرض) اجرا شوند. برای جزئیات بیشتر در مورد گزارش گیری همزمان در مقابل گزارش ناهمزمان، راهنمای گزارش های همزمان را ببینید.

برای اجرای یک گزارش، مانند مثال زیر، با متد اجرای سرویس Report تماس بگیرید:

سی شارپ

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

جاوا

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

PHP

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

پایتون

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

روبی

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

پاسخ به این درخواست یک منبع Files است. اگر این یک درخواست اجرای همزمان موفقیت آمیز بود، تمام فیلدهای منبع برگشتی پر می شد و فایل برای دانلود آماده می شد. با این حال، از آنجایی که این یک درخواست اجرای ناهمزمان بود، برخی از فیلدهای کلیدی وجود ندارد و status فایل روی PROCESSING تنظیم می شود، زیرا گزارش هنوز اجرا نشده است.

توجه: اگر اجرای یک گزارش همگام بیش از حد طول بکشد تا تکمیل شود، به طور خودکار به اجرای گزارش ناهمزمان تبدیل می شود. همیشه فیلد status منبع فایل برگشتی را بررسی کنید تا مشخص شود که آیا یک گزارش واقعاً اجرا شده است یا خیر.

اجرای یک گزارش چه زمانی به پایان می رسد؟

هنگامی که یک گزارش را به صورت ناهمزمان اجرا می کنید، یک فایل نگهدارنده بلافاصله ایجاد می شود و گزارش در یک صف قرار می گیرد تا پردازش شود. مکان نگهدار حاوی دو بخش کلیدی اطلاعات است که به شما کمک می کند تعیین کنید که چه زمانی اجرای گزارش به پایان رسیده است:

1. یک فیلد id ، که می تواند برای ارجاع به این فایل در درخواست های بعدی استفاده شود.
2. یک فیلد status ، که نشان دهنده وضعیت فعلی اجرای گزارش است.

برای تعیین اینکه چه زمانی اجرای یک گزارش به پایان رسیده است، باید به صورت دوره ای status فایل را بررسی کنید، مانند مثال زیر:

سی شارپ

// 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);

جاوا

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

پایتون

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

روبی

# 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

وقتی status به REPORT_AVAILABLE تغییر کرد، فایل آماده دانلود است. همانطور که در مثال بالا نشان داده شده است، اکیداً توصیه می‌شود که هنگام نظرسنجی مانند این، برای بهینه‌سازی استفاده از سهمیه درخواست خود، یک استراتژی عقب‌نشینی نمایی اجرا کنید.