פעולות ארוכות (LRO)

כמה קריאות ל-Google Ads API מחזירות פעולות ממושכות (LRO). הן עוקבות אחרי הסטטוס של משימה שמתבצעת לאורך זמן, בלי לדרוש RPC חוסם אחד.

כיתת OperationFuture

כדי לבצע פעולות ב-LRO בספריית הלקוח של Java, משתמשים במחלקה OperationFuture. הפונקציה OperationFuture מסתמכת על לקוח השירות הבסיסי כדי לדגום את ה-API לקבלת עדכוני סטטוס, לכן חשוב לוודא שלקוח השירות נשאר פתוח ופעיל עד שהפעולה מסתיימת.

לא מומלץ:

private void executeOperation(String jobName) throws Exception {
  OperationFuture<Empty, OfflineUserDataJobMetadata> future =
      startLongRunningOperation(jobName);
  // FAILS: The service client was already closed when
  // startLongRunningOperation() exited its try-with-resources block, so
  // future.get() fails when polling.
  future.get();
}

private OperationFuture<Empty, OfflineUserDataJobMetadata>
    startLongRunningOperation(String jobToStart) {
  try (OfflineUserDataJobServiceClient offlineUserDataJobServiceClient =
      googleAdsClient
          .getLatestVersion()
          .createOfflineUserDataJobServiceClient()) {
    // Issues an asynchronous request to run the offline user data job.
    return offlineUserDataJobServiceClient.runOfflineUserDataJobAsync(
        jobToStart);
  }
}

מומלץ:

private void executeOperation(String jobName) throws Exception {
  try (OfflineUserDataJobServiceClient offlineUserDataJobServiceClient =
      googleAdsClient
          .getLatestVersion()
          .createOfflineUserDataJobServiceClient()) {
    OperationFuture<Empty, OfflineUserDataJobMetadata> future =
        startLongRunningOperation(offlineUserDataJobServiceClient, jobName);
    // Waits for the operation to complete (with a timeout) while the client is
    // still open.
    future.get(5, TimeUnit.MINUTES);
  }
}

private OperationFuture<Empty, OfflineUserDataJobMetadata>
    startLongRunningOperation(
        OfflineUserDataJobServiceClient offlineUserDataJobServiceClient,
        String jobToStart) {
  return offlineUserDataJobServiceClient.runOfflineUserDataJobAsync(jobToStart);
}

שימו לב שהמשתנה OperationFuture משמש רק בזמן שהמשתנה OfflineUserDataJobServiceClient נשאר פתוח בתוך הבלוק try-with-resources.