रिपोर्ट ढूंढना और चलाना

अपनी ज़रूरतों के मुताबिक रिपोर्ट की पहचान करने या उसे बनाने के बाद, आउटपुट जनरेट करें. रिपोर्ट के आउटपुट, रिपोर्ट फ़ाइलों में सेव किए जाते हैं. इन्हें प्रोग्राम के हिसाब से, वापस पाया जा सकता है और उसमें बदलाव किया जा सकता है. रिपोर्ट चलाने के बाद एक रिपोर्ट फ़ाइल बनती है.

इस गाइड में रिपोर्ट सेवा की मदद से, प्रोग्राम फ़ाइल जनरेट करने के बारे में जानकारी दी गई है.

रिपोर्ट ढूंढना

रिपोर्ट चलाने के लिए, आपको रिपोर्ट का आईडी जानना होगा. अगर आपने अभी-अभी कोई रिपोर्ट बनाई या अपडेट की है, तो यह वैल्यू, दिखाए गए रिपोर्ट रिसॉर्स के id फ़ील्ड में मिल जाएगी. हमारा सुझाव है कि उपयोगकर्ता, बाद में देखने के लिए, लौटाए गए इन आईडी को सेव करें.

अगर आपको वह रिपोर्ट आईडी नहीं मालूम है जिसे आपको चलाना है, तो उपलब्ध रिपोर्ट ढूंढने के लिए सभी उपलब्ध रिपोर्ट की सूची देखें. नीचे दिए गए उदाहरण में, उपयोगकर्ता की ओर से तय किए गए कुछ मानदंडों की मदद से रिपोर्ट खोजने का तरीका बताया गया है:

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

129

$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

वैकल्पिक पैरामीटर के बारे में जानने के लिए रेफ़रंस दस्तावेज़ देखें. इससे यह तय किया जा सकता है कि दिखाई गई रिपोर्ट की सूची को क्रम से कैसे लगाया और क्रम में लगाया जा सकता है. इस सूची के क्रम और क्रम को कंट्रोल करना, खास तौर पर उन रिपोर्ट को ढूंढने में मदद कर सकता है जिनमें हाल ही में बदलाव किया गया था.

रिपोर्ट चलाना

सही रिपोर्ट मिल जाने पर, उसे चलाने और एक नई रिपोर्ट फ़ाइल जनरेट करने के लिए, रिपोर्ट सेवा का इस्तेमाल किया जा सकता है. रिपोर्ट की जटिलता और इसके प्रोसेस होने में लगने वाले समय के आधार पर रिपोर्ट सिंक्रोनस या एसिंक्रोनस रूप से (डिफ़ॉल्ट) चलाई जा सकती है. सिंक्रोनस बनाम एसिंक्रोनस रिपोर्टिंग के बारे में जानकारी के लिए, सिंक्रोनस रिपोर्ट की गाइड देखें.

रिपोर्ट चलाने के लिए, रिपोर्ट सेवा की चलाने के तरीके पर कॉल करें, जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है:

C#

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

Java

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

129

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

इस अनुरोध का जवाब फ़ाइल संसाधन है. अगर यह सिंक्रोनस रूप से रन करने का अनुरोध था, तो लौटाए गए संसाधन के सभी फ़ील्ड भरे जाएंगे और फ़ाइल डाउनलोड के लिए तैयार होगी. यह अनुरोध एसिंक्रोनस तरीके से चलाया गया था. इसलिए, कुछ मुख्य फ़ील्ड मौजूद नहीं होंगे और फ़ाइल के लिए status की वैल्यू PROCESSING पर सेट की जाएगी, क्योंकि अभी तक रिपोर्ट नहीं चलाई गई है.

ध्यान दें: अगर सिंक्रोनस रिपोर्ट चलाने में बहुत ज़्यादा समय लगता है, तो यह अपने-आप एसिंक्रोनस रिपोर्ट रन में बदल जाएगी. यह देखने के लिए कि रिपोर्ट सही तरीके से चल रही है या नहीं, लौटाए गए फ़ाइल रिसॉर्स के status फ़ील्ड की हमेशा जांच करें.

रिपोर्ट कब काम करती है?

जब एसिंक्रोनस तरीके से रिपोर्ट चलाई जाती है, तो प्लेसहोल्डर फ़ाइल तुरंत जनरेट हो जाती है. इसके बाद, रिपोर्ट को प्रोसेस करने के लिए एक सूची में डाल दिया जाता है. प्लेसहोल्डर में दो मुख्य जानकारी होती हैं. इनसे आपको यह तय करने में मदद मिलती है कि रिपोर्ट कब चल रही है:

1. id फ़ील्ड, जिसका इस्तेमाल बाद के अनुरोधों में इस फ़ाइल का रेफ़रंस देने के लिए किया जा सकता है.
2. status फ़ील्ड, जो रिपोर्ट के चलने की मौजूदा स्थिति को दिखाता है.

यह तय करने के लिए कि कोई रिपोर्ट कब खत्म हो चुकी है, आपको समय-समय पर फ़ाइल के status की जांच करनी होगी, जैसा कि नीचे उदाहरण में दिया गया है:

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

129

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

status के REPORT_AVAILABLE में बदल जाने पर, फ़ाइल डाउनलोड करने के लिए तैयार होती है. जैसा कि ऊपर दिए गए उदाहरण में दिखाया गया है, यह सुझाव दिया जाता है कि आप इस तरह से पोल करते समय एक्सपोनेंशियल बैकऑफ़ रणनीति लागू करें, ताकि अनुरोध कोटा के इस्तेमाल को ऑप्टिमाइज़ किया जा सके.