रिपोर्ट खोजें और चलाएं

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

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

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

रिपोर्ट चलाने के लिए, आपके पास रिपोर्ट का आईडी होना ज़रूरी है. अगर आपने अभी-अभी कोई रिपोर्ट बनाई है या उसे अपडेट किया है, तो यह वैल्यू, दिखाई गई रिपोर्ट के 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));

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

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

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

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

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

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)

इस अनुरोध का रिस्पॉन्स, फ़ाइल रिसॉर्स है. अगर सिंक्रोनस रन अनुरोध सफल होता है, तो लौटाए गए संसाधन के सभी फ़ील्ड भरे जाएंगे. साथ ही, फ़ाइल डाउनलोड के लिए तैयार हो जाएगी. यह अनुरोध एसिंक्रोनस तरीके से चलाए जाने का अनुरोध था. हालांकि, कुछ मुख्य फ़ील्ड मौजूद नहीं होंगे और फ़ाइल के 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);

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

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