擷取 API 酬載並傳送電子郵件

瞭解如何在 Application Integration 中建立範例整合項目。下列步驟說明如何設定觸發條件、工作、邊緣、變數和資料對應,以執行完整的整合。

總覽

在本快速入門導覽課程中,您將從公開 API 擷取網頁瀏覽次數、將資料轉換為可用格式,並透過電子郵件傳送結果清單,所有操作都在整合編輯器中完成。


如要直接在 Google Cloud 控制台中,按照這項工作的逐步指南操作,請按一下「Guide me」(逐步引導)

逐步引導


建立新的整合功能

如要建立新的整合,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的「Application Integration」頁面。

    前往 Application Integration

  2. 按一下左側導覽選單中的「整合」,開啟「整合」頁面。
  3. 按一下「建立整合」
  4. 在「建立整合」對話方塊中輸入名稱和說明。

    在本快速入門導覽課程中,請輸入名稱 my-test-integration 和說明 Integration for quickstart

  5. 選取整合作業的區域。
  6. 按一下「建立」,開啟整合編輯器。

新增及設定 API 觸發條件

您必須具備觸發條件,才能開始整合作業的一連串任務。您可以使用任何可用的觸發條件啟動整合。在本快速入門導覽課程中,請使用 API 觸發條件

如要設定 API 觸發條件,請按照下列步驟操作:

  1. 在整合服務編輯器中,按一下「觸發條件」,即可查看可用觸發條件的清單。
  2. 在整合服務編輯器中,按一下「API trigger」(API 觸發條件)
  3. 如要設定觸發條件,請按一下「API 觸發條件」。系統會顯示觸發條件設定窗格。
  4. Application Integration 會自動填入觸發條件的「標籤」和「觸發條件 ID」觸發條件 ID 是由機器產生,您無法編輯這個值。不過,您可以編輯「Label」屬性的值。

    系統會自動儲存您對資源所做的變更。

新增及設定工作

工作是一組可執行的步驟,可將變數做為輸入內容,並產生變數做為輸出內容。 與觸發條件一樣,您可以在整合項目中使用任何可用的工作。本快速入門導覽課程會使用「呼叫 REST 端點」、「資料對應」和「傳送電子郵件」工作。以下步驟說明各項工作的設定詳細資料。

設定「呼叫 REST 端點」工作

如要設定「呼叫 REST 端點」工作,請按照下列步驟操作:

  1. 選取「工作」,系統隨即會顯示可用工作的清單。
  2. 在整合服務編輯器中,按一下並放置「Call REST Endpoint」(呼叫 REST 端點)
  3. 將滑鼠懸停在「API trigger」(API 觸發條件) 的控制點上,然後點選線條並拖曳到「Call REST Endpoint」(呼叫 REST 端點) 任務的控制點,即可從「API trigger」(API 觸發條件) 到「Call REST Endpoint」(呼叫 REST 端點) 新增邊緣連線。邊緣表示從「API trigger」(API 觸發條件) 到「Call REST Endpoint」(呼叫 REST 端點) 任務的控制流程。

    邊緣是指整合中任意兩個元素之間的連線。連線表示控制流程從一個元素 (工作或觸發條件) 到另一個元素的方向。如要進一步瞭解邊緣,請參閱「邊緣」。

  4. 如要設定這項工作,請按一下「呼叫 REST 端點」。系統隨即會顯示工作設定窗格。設定下列屬性:
    • 標籤:輸入這項工作的自訂名稱。例如輸入 Call REST Endpoint Task
    • 驗證:這個快速入門導覽課程不需要驗證設定檔。 如要進一步瞭解如何將驗證設定檔用於其他用途,請參閱 在 Application Integration 中建立驗證設定檔
    • 工作輸入:輸入呼叫 REST 端點的詳細資料。您在此輸入的資訊會做為「呼叫 REST 端點」工作的輸入內容。下圖顯示「呼叫 REST 端點」任務的「任務輸入」和「HTTP 設定」部分:

      呼叫 REST 端點工作輸入 呼叫 REST 端點工作輸入

      輸入下列資訊:

      • 端點基準網址:輸入 https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031。 wikimedia.org 的公用 API 會傳回指定月份文章「Tree」的網頁瀏覽次數。
      • HTTP 方法:使用下拉式清單選取 GET
    • HTTP 設定:應用程式整合會填入下列值:
      1. 追蹤重新導向: True
      2. 工作應因 HTTP 錯誤而失敗: True
    • 工作輸出:應用程式整合會填入三個變數,用來保存呼叫 REST 端點的回應資料輸出內容。下圖顯示「呼叫 REST 端點」工作的「工作輸出」和其他部分:

      呼叫 REST 端點工作輸出 呼叫 REST 端點工作輸出

      查看下列資訊:

      • responseHeader(呼叫 REST 端點):這個變數會保留與「呼叫 REST 端點」工作相關聯的回應標頭資料。變數資料的類型為 String (STR)。
      • responseBody(呼叫 REST 端點):這個變數會保留與「呼叫 REST 端點」工作相關聯的回應主體資料。變數資料的類型為 String (STR)。
      • responseStatus(呼叫 REST 端點):這個變數會保留與「呼叫 REST 端點」工作相關聯的回應狀態資料。變數資料的類型為 String (STR)。
    • 其餘欄位應包含下列預設值:
      • 這項工作的執行策略: When all tasks succeed
      • 下一個工作的執行政策: Run all match

    系統會自動儲存您對資源所做的變更。

新增及設定「資料對應」工作

如要設定「資料對應」工作,請按照下列步驟操作:

  1. 選取「工作」,系統隨即會顯示可用工作的清單。
  2. 在整合服務編輯器中,點按並放置「資料對應」
  3. 將滑鼠懸停在「呼叫 REST 端點」的控制點上,然後點選線條並拖曳到「資料對應」任務的控制點,即可從「呼叫 REST 端點」到「資料對應」新增邊緣連線。邊緣表示從「Call REST Endpoint」(呼叫 REST 端點) 任務到「Data Mapping」(資料對應) 任務的控制流程。
  4. 如要設定工作,請按一下「資料對應」工作。工作設定窗格隨即會顯示。
  5. 按一下「開啟資料對應編輯器」

    您可以使用資料對應編輯器,透過可用的轉換函式,將輸入變數對應至所需輸出變數。然後,輸出內容會以變數的形式提供給任何其他整合作業或觸發條件。如要進一步瞭解如何以變數形式傳遞資料,請參閱「 變數」。

    在本快速入門導覽課程中,請使用 responseBody(Call REST Endpoint) 建立對應,做為輸入內容: input:

    1. 將「變數」窗格中的 responseBody 變數拖曳至第一個「輸入」列。
    2. 按一下「responseBody」變數方塊中的「+ (新增函式)」,即可查看可用函式清單。您可以套用多項函式,轉換輸入變數中的資料。

      在這種情況下,您可以將酬載轉換為 JSON,然後疊代回應陣列,取得電子郵件通知所需的產品名稱清單。步驟如下:

      • 選取 TO_JSON(),將 responseBody 字串轉換為 JSON。
      • 按一下「responseBody」變數晶片中的「+ (新增函式)」,選取並串連 GET_PROPERTY() 函式。
      • 如要新增 GET_PROPERTY() 的輸入參數,請按一下「變數或值」,然後在「值」中輸入 items

        這項函式會從 JSON 酬載中擷取屬性。 將 items 屬性傳入這個函式做為參數。這會傳回「僅」列出產品名稱的清單,不含其他產品資訊。您的函式應如下所示:

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)
      • 如要移除或刪除函式,請按一下 - 符號。
    3. 按一下「輸出」欄中的第一個欄位,建立新的輸出變數來保存轉換後的資料值。填寫下列欄位:
      • 在「Name」(名稱) 欄位中,輸入 JSONList
      • 從「變數類型」清單中選取「整合輸出」
      • 在「資料類型」清單中,選取「JSON」
      • 如要建立變數並關閉窗格,請按一下「建立」。新的 JSONList 變數會顯示在「資料對應」編輯器左側的「變數」清單中。
    4. 完成對應後,請關閉資料對應編輯器。系統會自動儲存所有變更。下圖顯示資料對應編輯器,以及在本快速入門導覽課程中建立的對應:

      資料對應編輯器 資料對應編輯器

新增並設定「Send Email」(傳送電子郵件) 任務

如要設定「Send Email」(傳送電子郵件) 任務,請按照下列步驟操作:

  1. 在整合編輯器中選取「Tasks」(工作),即可顯示可用工作清單。
  2. 在整合服務編輯器中,按一下並放置「傳送電子郵件」
  3. 將滑鼠懸停在「資料對應」的控制點上,然後點選線條並拖曳到「傳送電子郵件」任務的控制點,即可從「資料對應」新增邊緣連線至「傳送電子郵件」。邊緣表示從「資料對應」 任務到「傳送電子郵件」任務的控制流程。
  4. 如要設定這項工作,請按一下「傳送電子郵件」。工作設定窗格隨即會顯示。在「工作輸入」部分中,設定下列屬性:
    • 「To Recipient(s)」(收件者):輸入您的電子郵件地址。您會收到這封電子郵件,確認整合作業已順利完成。
    • 「Subject」(主旨):輸入 Email from Application Integration
    • 純文字格式的內文:在「資料對應」工作流程中,選取先前建立的 JSONList 變數。
    • 其餘選項則可保留預設設定。

    系統會自動儲存您對資源所做的變更。

確認必要的邊緣連線

確認您已在整合中新增任務和觸發條件之間的邊緣連線。連線表示從一個元素 (工作或觸發條件) 到另一個元素的控制流程方向。如要進一步瞭解邊緣,請參閱「邊緣」。

完成的連線應如下圖所示:

圖片:顯示快速入門流程 圖片:顯示快速入門流程

測試整合功能

如要測試新整合項目,請按照下列步驟操作:

  1. 在整合服務編輯器的工具列中,按一下「測試」

    系統隨即會顯示「測試整合」窗格。

  2. 按一下「測試整合」

如要進一步瞭解測試,請參閱「測試及發布整合」。

成功完成後,整合作業會傳送電子郵件至「Send Email」(傳送電子郵件) 任務中指定的電子郵件地址,並附上 JSON 值。請在電子郵件用戶端中確認已收到這封電子郵件。

整合服務傳送的電子郵件應包含類似下列內容的主體:

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

除了驗證電子郵件內容,您也可以檢查記錄,查看特定整合的狀態和酬載。如要查看記錄:

  1. 在整合服務編輯器的工具列中,按一下「記錄」
  2. 在「執行記錄」頁面中,您可以查看每次嘗試執行整合的詳細資料。 每個項目都包含執行嘗試的詳細資料,包括:
    • 整合名稱
    • 執行作業 ID
    • 狀態
    • 開始時間
    • 時間長度
    • 整合版本
    • 觸發條件 ID
    • Cloud Logging
  3. 按一下已執行的整合旁邊的展開箭頭 (>),即可查看整合中的工作和變數展開清單,以及工作狀態和變數有效負載。

配額與限制

如要瞭解配額和限制,請參閱「配額與限制」。