SharePoint

透過 SharePoint 連接器，您可以管理 SharePoint 中的檔案、資料夾和附件。

支援的版本

這個連接器支援 Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 以上版本，以及 SharePoint Online。

事前準備

在 Google Cloud 專案中，執行下列工作：

  • 確認已設定網路連線。詳情請參閱「網路連線」。
  • 將 roles/connectors.admin IAM 角色授予設定連結器的使用者。
  • 將 roles/secretmanager.viewer 和 roles/secretmanager.secretAccessor 身分與存取權管理角色授予要用於連接器的服務帳戶：
  • 啟用 secretmanager.googleapis.com (Secret Manager API) 和 connectors.googleapis.com (Connectors API)。 詳情請參閱「啟用服務」。

建立 SharePoint 連線

連線專屬於資料來源。也就是說，如果您有多個資料來源，則必須為每個資料來源建立個別的連線。如要建立連線，請按照下列步驟操作：

  1. 在 Cloud 控制台中，前往「Integration Connectors」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「Connections」(連線) 頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「地區」部分中，從「區域」清單選取位置，然後按一下「下一步」。

    如需所有支援的地區清單，請參閱「位置」。

  4. 在「連線詳細資料」部分，完成下列步驟：
    1. 從連接器清單中選取「SharePoint」SharePoint。
    2. 從「連接器版本」清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。連線名稱可包含小寫英文字母、數字或連字號，名稱開頭須為英文字母，結尾須為英文字母或數字，且不得超過 49 個字元。
    4. 視需要輸入連線執行個體的「Description」(說明)。
    5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
    6. 在「服務帳戶」欄位中，選取具備必要角色的帳戶。
    7. 視需要設定「連線節點設定」：

      • 節點數量下限：輸入連線節點數量下限。
      • 節點數量上限：輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多，就需要越多節點；反之，處理的交易量越少，需要的節點就越少。如要瞭解節點對連線器定價的影響，請參閱「 連線節點定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

    8. (選用) 按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
    9. 點選「下一步」。
  5. 在「目的地」部分，輸入要連線的遠端主機 (後端系統) 詳細資料，然後按一下「下一步」。

    6. 在「目的地類型」欄位中，選取目的地類型。例如，主機位址為 https://<SITE_NAME>.sharepoint.com。

    • 如要指定目的地主機名稱或 IP 位址，請選取「主機地址」，然後在「主機 1」欄位中輸入地址。
    • 如要建立私人連線，請選取「Endpoint attachment」(端點連結)，然後從「Endpoint Attachment」(端點連結) 清單中選擇所需連結。

    如要建立與後端系統的公開連線，並加強安全性，建議為連線設定靜態輸出 IP 位址，然後設定防火牆規則，只允許特定靜態 IP 位址。

    如要輸入其他目的地，請按一下「+新增目的地」。
  6. 在「Authentication」(驗證) 部分，輸入驗證詳細資料。
    1. 選取「驗證類型」並輸入相關詳細資料。

      SharePoint 連線支援下列驗證類型：

      • Windows 憑證。如果您使用 SharePoint 的地端部署版本，請選取這個選項。
      • AzureAD。如果您使用 SharePoint 線上版，請選取這個選項。
      • OAuth 2.0 用戶端憑證搭配 JWT 持有者。如果您使用 OAuth 2.0 用戶端憑證搭配 JWT 不記名權杖進行驗證，請選取這個選項。
      • OAuth 2.0 用戶端憑證 (含用戶端密鑰)。如果您使用 OAuth 2.0 用戶端憑證和用戶端密鑰進行驗證，請選取這個選項。

      2. 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點選「下一步」。
  7. 在「檢閱」部分，檢查連線和驗證詳細資料。
  8. 點選「建立」。

設定驗證機制

SharePoint 連接器支援下列驗證類型：

Windows 憑證驗證類型

如要啟用 Windows 憑證驗證類型，請完成下列步驟：

  1. 設定 PSC 並建立端點連結。
  2. 在 Google Cloud中指定憑證。

設定 PSC 並建立端點連結

  1. 使用 SharePoint 託管的 IP 建立執行個體群組。
  2. 建立內部直通式網路負載平衡器，並使用您建立的執行個體群組做為後端。TCP 內部負載平衡器必須啟用全域存取權。
  3. 在 Private Service Connect 中發布負載平衡器。發布負載平衡器後，系統會產生服務附件。
  4. 發布服務，並指定您建立的負載平衡器。
  5. 使用服務連結建立端點連結。
  6. 建立端點連結後，請使用端點連結 IP 建立 SharePoint 連線。

    7. 如要進一步瞭解如何建立端點連結，請參閱「建立端點連結」。

在 Google Cloud中指定 Windows 憑證詳細資料

在 Integration Connectors 中建立連線時，您必須指定下列詳細資料：

在「Authentication」部分，選取「Windows credentials」做為驗證類型，然後輸入下列詳細資料：

  • 使用者名稱：輸入使用者名稱。
  • 密碼：選取密碼。
  • 密鑰版本：輸入密鑰版本。

Windows 憑證連線類型

下表列出 Windows 憑證連線類型的範例設定值。

欄位名稱 詳細資料
區域 us-central1
連接器 SharePoint
連接器版本 1
連線名稱 sharepoint-staging-psc
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
節點數量下限 2
節點數量上限 50
目的地類型 主機位址
主機 1 http://192.0.2.0
通訊埠 1 24
驗證 Windows 憑證
使用者名稱 USER_NAME
密碼 密碼
密鑰版本 1

Azure AD 驗證類型

如要啟用 Azure AD 驗證類型，請完成下列步驟：

  1. 註冊應用程式並取得 OAuthClientId 和 OAuthClientSecret。
  2. 在 Google Cloud中指定憑證。
  3. 在 Google Cloud中授權連線。
  4. 在應用程式中新增重新導向網址。

註冊應用程式，並取得 OAuthClientId 和 OAuthClientSecret

如要註冊應用程式並取得應用程式的 OAuthClientId 和 OAuthClientSecret，請按照下列步驟操作：

  1. 登入 Azure 入口網站。
  2. 在「Azure services」中，選取「App registrations」，然後選取「New registration」。
  3. 輸入應用程式名稱，然後選取「Any Microsoft Entra ID tenant - Multitenant」(任何 Microsoft Entra ID 租戶 - 多租戶)。
  4. 按一下「註冊」。
  5. 建立應用程式後，請前往「Certificates & secrets」頁面。
  6. 為應用程式建立用戶端密鑰，並儲存用戶端密鑰值。
  7. 前往「API 權限」頁面。
  8. 按一下「新增權限」。
  9. 在「要求 API 權限」對話方塊中，從下表選取 API、類型和權限，即可在應用程式中執行作業。

    10. 如要啟用連線，您必須授予 Sites.Read.All「Microsoft Graph」 API 的權限。

    API 權限名稱 類型
    Microsoft Graph ConsentRequest.Read.All Application/ Delegated
    Microsoft Graph ConsentRequest.ReadWrite.All Application/ Delegated
    Microsoft Graph DelegatedAdminRelationship.Read.All Application/ Delegated
    Microsoft Graph DelegatedAdminRelationship.ReadWrite.All Application/ Delegated
    Microsoft Graph DelegatedPermissionGrant.Read.All Application/ Delegated
    Microsoft Graph DelegatedPermissionGrant.ReadWrite.All Application/ Delegated
    Microsoft Graph Files.Read.All Application/ Delegated
    Microsoft Graph Files.ReadWrite.All Application/ Delegated
    Microsoft Graph Sites.FullControl.All Application/ Delegated
    Microsoft Graph Sites.Manage.All Application/ Delegated
    Microsoft Graph Sites.Read.All Application/ Delegated
    Microsoft Graph Sites.ReadWrite.All Application/ Delegated
    Microsoft Graph Sites.Selected Application/ Delegated
    Microsoft Graph TermStore.Read.All Application/ Delegated
    Microsoft Graph TermStore.ReadWrite.All Application/ Delegated
    Microsoft Graph User.Export.All Application/ Delegated
    Microsoft Graph User.Read Delegated
    Microsoft Graph User.Read.All Application/ Delegated
    Microsoft Graph User.ReadWrite.All Application/ Delegated
    SharePoint EnterpriseResource.Read Delegated
    SharePoint EnterpriseResource.Write Delegated
    SharePoint Project.Read Delegated
    SharePoint Project.Write Delegated
    SharePoint ProjectWebApp.FullControl Delegated
    SharePoint ProjectWebAppReporting.Read Delegated
    SharePoint TaskStatus.Submit Delegated
  10. 儲存變更。
  11. 如果您選取需要管理員同意的權限，可以在「API 權限」頁面，從目前的租戶授予權限。
  12. 如要新增範圍，請前往「Expose an API」(公開 API) 部分，新增 AllSites.Manage, Sites.FullControl.All 範圍並選取可控管範圍的對象 (管理員和使用者)。
  13. 按一下 [儲存]。

在 Google Cloud中指定憑證

在 Integration Connectors 中建立連線時，您必須指定下列詳細資料：

在「Authentication」(驗證) 部分，選取「AzureAD」做為驗證類型，然後輸入下列詳細資料：

  • 用戶端 ID：輸入用於要求存取權杖的用戶端 ID。
  • 範圍：輸入以半形逗號分隔的所需範圍清單。例如：Sites.FullControl.All
  • 用戶端密鑰：輸入包含您所建立已連結應用程式用戶端密鑰的密鑰。
  • 密鑰版本：上述所選密鑰的密鑰版本。
  • 授權網址：建立 OAuth 用戶端時產生的授權網址。 請按照下列格式輸入網址：https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent。 例如 https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent。

在 Google Cloud中授權連線

  1. 在「連線」頁面中，找出新建立的連線。

    新連結器的「狀態」會顯示「需要授權」。

  2. 按一下「需要授權」。

    系統隨即會顯示「編輯授權」窗格。

  3. 將「重新導向 URI」值複製到外部應用程式。詳情請參閱「在應用程式中新增重新導向網址」。
  4. 驗證授權詳細資料。
  5. 按一下 [授權]。

    授權成功後，「連線」頁面的連線狀態會設為「有效」。

在應用程式中新增重新導向網址

  1. 在 Azure 入口網站中，依序點選「Azure 服務」>「應用程式註冊」。
  2. 按一下應用程式名稱。
  3. 按一下「新增重新導向 URI」。
  4. 按一下「Add a platform」。
  5. 在「Web」對話方塊中，貼上您在 Google Cloud授權連線時複製的重新導向 URI。

Azure AD 連線類型

下表列出 Azure AD 連線類型的範例設定值：

欄位名稱 詳細資料
區域 us-central1
連接器 SharePoint
連接器版本 1
連線名稱 sharepoint-google-cloud-con
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
節點數量下限 2
節點數量上限 50
目的地類型 主機位址
主機 1 http://z8**.sharepoint.com
驗證 AzureAD
用戶端 ID CLIENT_ID
範圍 Sites.FullControl.All
用戶端密鑰 CLIENT_SECRET
密鑰版本 1
授權網址 https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0 - 用戶端憑證，JWT 不記名驗證類型

如要啟用 OAuth 2.0 - 用戶端憑證搭配 JWT 不記名驗證類型，請完成下列步驟：

  1. 建立憑證。
  2. 將憑證上傳至 Azure 入口網站。
  3. 取得私密金鑰。
  4. 完成設定。
  5. 在 Google Cloud中指定 OAuth 2.0 JWT 持有者憑證。

建立憑證

  1. 在電腦上建立空白資料夾。
  2. 在資料夾中建立文字檔案。
  3. 從「透過 Azure AD 僅限應用程式頁面授予存取權」 複製 PowerShell 指令碼，然後貼到文字檔中。
  4. 將文字檔重新命名為 Create-SelfSignedCertificate.ps1。
  5. 在資料夾中執行 Windows PowerShell。
  6. 前往包含文字檔的目錄。
  7. 複製下列指令： .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    輸入 CERTIFICATE_NAME 的專屬名稱。將 StartDate 變更為目前日期，EndDate 則變更為您選擇的日期。

  8. 將複製的指令連同變更貼到 Windows PowerShell，然後按下 Enter 鍵。

    Windows PowerShell 會提示您輸入密碼，以保護私密金鑰。請務必儲存密碼，以供日後使用。

    Windows PowerShell 會建立兩個檔案：MyCertificate.pfx 和 MyCertificate.cer。

將憑證上傳至 Azure 入口網站

  1. 登入 Azure 入口網站，指定下列詳細資料來註冊新應用程式：
    • 名稱：輸入應用程式名稱。
    • 支援的帳戶類型：選取「Accounts in this organizational directory only (Account name only - Single tenant)」。
  2. 依序前往「API Permissions」>「Add permission」>「Request API permissions」>「SharePoint」。
  3. 選取「應用程式權限」，然後新增所需權限。
  4. 選取「授予管理員同意聲明」，然後選取「是」。
  5. 建立應用程式後，請前往「Certificates & Secrets」部分。
  6. 選取「上傳憑證」，然後從電腦上傳 CER 憑證。上傳完成後，選取「新增」。

    請勿在應用程式中新增用戶端密鑰，因為這會干擾以憑證為基礎的驗證流程。

  7. 前往資訊清單，找出 KeyCredentials，然後將 customKeyIdentifier 複製為指紋。稍後會用到這項資訊。您已註冊應用程式並連結憑證。

取得私密金鑰

您可以使用 OpenSSL 將 PFX 檔案轉換為 PEM 檔案，取得私密金鑰。

  1. 在命令提示字元中，前往 PFX 檔案所在的資料夾，然後執行下列指令： openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. 輸入您在憑證建立程序中使用的 PFX 密碼。
  3. 在文字編輯器中開啟 PEM 檔案，並複製所有文字 (即為私密金鑰)。

完成設定

  1. 從 Azure 入口網站中新註冊的應用程式複製用戶端 ID 和租戶 ID。
  2. 使用下列憑證，透過 SharePoint 清單服務主體驗證登入：
    • 用戶端 ID
    • 用戶群 ID
    • 私密金鑰
    • 指紋 (私密金鑰密碼)

在 Google Cloud中指定 OAuth 2.0 JWT 持有者憑證

在 Integration Connectors 中建立連線時，您必須指定下列詳細資料：

在「Authentication」(驗證) 部分，選取「OAuth 2.0 client credentials with JWT bearer」(OAuth 2.0 用戶端憑證搭配 JWT 不記名權杖) 做為驗證類型，然後輸入下列詳細資料：

  • 在「Client ID」欄位中，輸入用於要求存取權杖的用戶端 ID。這是您在 Azure 入口網站中註冊應用程式時產生的消費者金鑰。
  • 在「私密金鑰」欄位中，選取包含 PEM 格式私密金鑰檔案內容的 Secret Manager 密碼。私密金鑰應與提供給連線器的公開金鑰/憑證相符。
  • 在「Secret version」(密鑰版本) 欄位中，選取上方所選密鑰的版本。
  • 在「私密金鑰密碼」欄位中，選取含有私密金鑰檔案密碼 (同義詞) 的 Secret Manager 密碼。使用您在建立憑證時設定的密碼，保護私密金鑰。
  • 在「Secret version」(密鑰版本) 欄位中，選取上方所選密鑰的版本。
  • 在「Azure Tenant」(Azure 租戶) 欄位，輸入用於存取資料的 Microsoft 線上租戶。

JWT 持有者憑證連線類型

下表列出 OAuth 2.0 JWT 不記名憑證連線類型的範例設定值。

欄位名稱 詳細資料
區域 europe-west1
連接器 SharePoint
連接器版本 1
連線名稱 sharepoint-jwt-certificate
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
節點數量下限 2
節點數量上限 50
目的地類型 主機位址
主機 1 http://z8**.sharepoint.com
通訊埠 1 ****
驗證 OAuth 2.0 - 用戶端憑證 (透過 JWT 持有者)
OAuth 用戶端 ID CLIENT_ID
私密金鑰 顏色釋義
密鑰版本 1
私密金鑰密碼 密碼
密鑰版本 1
Azure 租用戶 AZURE_TENANT_ID

OAuth 2.0 - 用戶端密鑰連線類型

如要啟用 OAuth 2.0 用戶端密鑰連線類型，請完成下列步驟：

  1. 註冊增益集。
  2. 授予外掛程式權限。
  3. 在 Google Cloud中指定 OAuth 2.0 用戶端憑證
  4. 重新授權授權碼

註冊增益集

  1. 使用以下網址前往「Register Add-In」(註冊外掛程式) 頁面： https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx。
  2. 在「應用程式資訊」部分，產生用戶端 ID 和用戶端密鑰。
  3. 指定「名稱」、「應用程式網域」和「重新導向 URI」的值。
  4. 按一下「建立」。外掛程式已註冊，SharePoint 應用程式會顯示建立的資訊。

授予增益集權限

  1. 使用下列網址前往 SharePoint 網站： https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx。系統會將您重新導向至「授予權限」頁面。
  2. 在「App ID」欄位中，輸入您先前產生的用戶端 ID，然後按一下「Lookup」。系統會填入「名稱」、「應用程式網域」和「重新導向網址」的值。
  3. 以 XML 格式輸入下列權限要求： 
          <AppPermissionRequests AllowAppOnlyPolicy="true">
      <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
      </AppPermissionRequests>
  4. 點選「建立」。Sharepoint 應用程式會顯示權限同意對話方塊。
  5. 按一下「信任」。

在 Google Cloud中指定 OAuth 2.0 用戶端憑證

在 Integration Connectors 中建立連線時，您必須指定下列詳細資料：

在「Authentication」(驗證) 部分，選取「OAuth 2.0 client credentials with client secret」(OAuth 2.0 用戶端憑證和用戶端密鑰) 做為驗證類型，然後輸入下列詳細資料：

  • 在「用戶端 ID」欄位中，輸入連結器為您建立的應用程式提供的用戶端 ID。
  • 在「Client Secret」(用戶端密鑰) 欄位中，選取包含您所建立已連結應用程式用戶端密鑰的 Secret Manager 密鑰。
  • 在「Secret version」(密鑰版本) 欄位中，選取用戶端密鑰版本。

重新授權授權碼

如果您使用 Authorization code 驗證類型，且已在 SharePoint 應用程式中進行任何設定變更，則必須重新授權 SharePoint 連線。如要重新授權連結，請按照下列步驟操作：

  1. 在「連線」頁面中，按一下所需連線。

    系統隨即會開啟連線詳細資料頁面。

  2. 按一下「編輯」即可編輯連結詳細資料。
  3. 在「驗證」部分中，驗證「OAuth 2.0 - 授權碼」詳細資料。

    視需要進行變更。

  4. 按一下 [儲存]。系統會將您導向連線詳細資料頁面。
  5. 在「驗證」部分中，按一下「編輯授權」。系統會顯示「Authorize」(授權) 窗格。
  6. 按一下「Authorize」。

    如果授權成功，「連線」頁面的連線狀態會設為「有效」。

用戶端憑證連線類型

下表列出 OAuth 2.0 用戶端憑證連線類型的範例設定值。

欄位名稱 詳細資料
區域 europe-west1
連接器 SharePoint
連接器版本 1
連線名稱 sharepoint-client-credentials
服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
節點數量下限 2
節點數量上限 50
目的地類型 主機位址
主機 1 http://z8**.sharepoint.com
通訊埠 1 ****
驗證 OAuth 2.0 - 用戶端憑證 (透過用戶端密鑰)
用戶端 ID CLIENT_ID
用戶端密鑰 CLIENT_SECRET
密鑰版本 1

在整合服務中使用 SharePoint 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

動作

本節列出連接器支援的部分動作。如要瞭解如何設定動作，請參閱「動作範例」。

DeleteAttachment 動作

這項操作會刪除附件。

DeleteAttachment 動作的輸入參數

參數名稱 資料類型 必填 說明
ListTitle 字串 是 清單項目的標題。
ItemId 字串 是 清單項目的 ID。
FileName 字串 是 要從文件庫刪除的檔案名稱。

CheckInDocument 動作

這項操作可讓您在文件中查看。

CheckInDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
RelativeURL 字串 是 資料夾的相對網址。
DocumentName 字串 是 要簽入的檔案名稱。
註解 字串 否 選用入住訊息。

CheckOutDocument 動作

這項操作可讓您簽出檔案。

CheckOutDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
RelativeURL 字串 是 資料夾的相對網址。
DocumentName 字串 是 要簽出的檔案名稱。

DiscardCheckOutDocument 動作

這項操作可讓你復原檔案簽出作業。

DiscardCheckOutDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
RelativeURL 字串 是 資料夾的相對網址。
DocumentName 字串 是 要撤銷簽出的檔案名稱。

CopyDocument 動作

這項動作可讓您將檔案從一個位置複製到另一個位置。

CopyDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
SourceFileRelativeUrl 字串 是 來源檔案的相對網址。
DestFileRelativeUrl 字串 是 目的地檔案的相對網址。

UploadDocument 動作

這項動作可讓你上傳檔案。

UploadDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
FileName 字串 是 要上傳的檔案名稱。
RelativeUrl 字串 是 資料夾的相對網址。
內容 字串 否 要上傳的內容 (以檔案形式)。
ContentBytes 字串 否 要以檔案形式上傳的位元組內容 (Base64 字串)。用來上傳二進位資料。
HasBytes 布林值 否 指定要上傳的內容是否為二進位檔。預設值為 false。

DownloadDocument 動作

這項操作可讓您下載檔案。

DownloadDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
RemoteFile 字串 是 要下載的檔案完整網址。
程式庫 字串 是 SharePoint 伺服器上的程式庫名稱。
HasBytes 布林值 否 指定是否應以位元組形式下載內容。預設值為 false。

MoveAttachmentOrDocument 動作

這項操作可將檔案從一個資料夾移至另一個資料夾。

MoveAttachmentOrDocument 動作的輸入參數

參數名稱 資料類型 必填 說明
SourceFileURL 字串 是 要移動的來源檔案網址。
DestinationFolderURL 字串 是 目的地資料夾的網址。

CreateFolder 動作

這項動作可讓您建立資料夾。

CreateFolder 動作的輸入參數

參數名稱 資料類型 必填 說明
RelativeURL 字串 是 資料夾的相對網址。
FolderName 字串 是 要建立的資料夾名稱。

AddAttachments 動作

這項動作可讓你新增附件。

AddAttachments 動作的輸入參數

參數名稱 資料類型 必填 說明
ListTitle 字串 是 附件清單的名稱。
FileName 字串 是 附件檔案名稱。
ItemId 字串 是 要新增的附件 ID。
內容 字串 是 附件內容。
ContentBytes 字串 否 要上傳為附件的位元組內容 (Base64 編碼字串)。用來上傳二進位資料。
HasBytes 布林值 否 指定要上傳的內容是否為二進位檔。預設值為 false。

DownloadAttachments 動作

這項操作可下載附件。

DownloadAttachments 動作的輸入參數

參數名稱 資料類型 必填 說明
RemoteFile 字串 是 檔案的相對網址。
HasBytes 布林值 否 指定要下載的內容是否為二進位檔。預設值為 false。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 刪除附件

這個範例會刪除指定檔案。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DeleteAttachment」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. 如果動作成功，DeleteAttachment 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 在文件中簽入

這個範例會在文件中簽入。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「CheckInDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. 如果動作成功，CheckInDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 簽出檔案

這個範例會簽出檔案。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「CheckOutDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. 如果動作成功，CheckOutDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 捨棄結帳

這個範例會還原檔案簽出作業。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DiscardCheckOutDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. 如果動作成功，DiscardCheckOutDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 複製檔案

這個範例會將檔案從一個位置複製到另一個位置。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「CopyDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. 如果動作成功，CopyDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 上傳文字檔案

這個範例會將文字檔上傳至指定位置。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「UploadDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. 如果動作成功，UploadDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 上傳二進位檔案

這個範例會將二進位檔案上傳至指定位置。上傳二進位檔案時，請將要上傳的內容指定為 Base64 編碼字串。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「UploadDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. 如果動作成功，UploadDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Status": "Success"
}]

範例 - 下載檔案

這個範例會下載檔案。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DownloadDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. 如果動作成功，DownloadDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Success": "True",
"Content": "Test File",
}]

範例 - 下載二進位檔案

這個範例會下載二進位檔案。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DownloadDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. 如果動作成功，DownloadDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

範例 - 從特定網站下載檔案

這個範例會從特定網站下載檔案。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DownloadDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
  "RemoteFile": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
  "Library": "Docs",
  "HasBytes": true
}
    4. 如果動作成功，DownloadDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [
  {
    "Success": "True",
    "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
  }
]

    如要從特定網站下載檔案，請提供遠端檔案的完整地址。

範例 - 移動附件

這個範例會將附件從一個位置移到另一個位置。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「MoveAttachmentOrDocument」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. 如果動作成功，MoveAttachmentOrDocument 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Result": "Success"
}]

範例 - 建立資料夾

這個範例會在指定位置建立資料夾。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「CreateFolder」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. 如果動作成功，CreateFolder 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

範例 - 新增附件

這個範例會將附件新增至指定清單。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「AddAttachments」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. 如果動作成功，AddAttachments 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

範例 - 新增二進位附件

這個範例會將二進位附件新增至指定清單。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「AddAttachments」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. 如果動作成功，AddAttachments 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

範例 - 下載附件

這個範例會下載附件。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DownloadAttachments」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. 如果動作成功，DownloadAttachments 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

    [{
"Success": "True",
"Content": "Test File",
}]

範例 - 下載二進位附件

這個範例會下載二進位附件。

  1. 在「Configure connector task」對話方塊中，按一下 Actions。
  2. 選取「DownloadAttachments」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. 如果動作成功，DownloadAttachments 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有檔案

這個範例會列出 Files 實體中的所有檔案。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 Files。
  3. 選取 List 作業，然後按一下「完成」。
  4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句來篩選結果集。您也可以使用邏輯運算子指定多個篩選條件。

範例 - 取得清單

這個範例會從 My Lists 實體取得具有指定 ID 的清單。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 My Lists。
  3. 選取 Get 作業，然後按一下「完成」。
  4. 在「連線器」工作的「工作輸入」部分，按一下「EntityId」，然後在「預設值」欄位中輸入 3。

    其中 3 是 My Lists 實體中的主鍵值。

範例 - 建立記錄

這個範例會在 My Lists 實體中建立記錄。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 My Lists。
  3. 選取「Create」作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

    [{
"ID": 3.0
}]

範例 - 刪除記錄

這個範例會刪除 My Lists 實體中具有指定 ID 的記錄。

  1. 在「Configure connector task」對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取 My Lists。
  3. 選取「Delete」作業，然後按一下「完成」。
  4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下「entityId」，然後在「Default Value」(預設值) 欄位中輸入 2。
  • 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用連線器工作，請參閱「連線器工作」。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟