Python Tableau workbooks.publish用法及代碼示例

Tableau Server Client (TSC)中workbooks.publish的用法。

用法

workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job, hidden_views)

將工作簿發布到指定站點。

注意：REST API 不能自動包含工作簿使用的數據提取或其他資源。因此，無法發布使用本地計算機上 Excel 或 csv 文件中的數據的 .twb 文件，除非您將數據和工作簿打包在 .twbx 文件中，或者單獨發布數據源。

對於大於 64 MB 的工作簿，發布方法會自動將文件分塊以供上傳。使用此方法比直接調用發布 REST API 方便得多。

REST API：Publish Workbook、Initiate File Upload、Append to File Upload

參數

名字	說明
`workbook_item`	`workbook_item` 指定您要發布的工作簿。添加工作簿時，您需要首先創建一個 `workbook_item` 的新實例，其中包括現有項目的 `project_id`。工作簿的名稱將是文件的名稱，除非您在創建實例時還指定了新工作簿的名稱。見WorkbookItem。
`file_path`	要發布的工作簿的路徑和名稱。
`mode`	指定您是發布新工作簿 (`CreateNew`) 還是覆蓋現有工作簿 (`Overwrite`)。您不能附加工作簿。您還可以使用發布模式屬性，例如：`TSC.Server.PublishMode.Overwrite`。
`connections`	在工作簿中創建的連接的`ConnectionCredentials` 對象列表。
`connection_credentials`	(可選)連接到工作簿數據源的憑據(如果需要)。這`ConnectionCredentials`對象包含數據源的身份驗證信息(用戶名和密碼，以及是嵌入憑據還是使用 OAuth)。自 API 服務器版本 2.3 起已棄用。
`skip_connection_check`	(可選)設置為`True` 以在上傳時跳過連接檢查。發布將成功，但未經檢查的連接問題可能會導致工作簿無法正常工作。默認為 `False` 。
`as_job`	(可選)設置為 `True` 以將上傳作為作業運行(異步上傳)。如果設置為`True`，則作業將開始執行發布過程並返回`Job` 對象。默認為 `False` 。
`hidden_views`	(可選)發布工作簿時需要隱藏的視圖的字符串名稱列表。

異常

錯誤	說明
`File path does not lead to an existing file.`	引發文件路徑不正確或文件丟失的錯誤。
`Invalid mode defined.`	如果發布模式不是定義的選項之一，則會引發錯誤。
`Workbooks cannot be appended.`	`mode` 必須設置為 `Overwrite` 或 `CreateNew` 。
`Only .twb or twbx files can be published as workbooks.`	如果指定的文件類型不受支持，則引發錯誤。

有關其他錯誤代碼，請參閱 REST API Publish Workbook。

已發布工作簿的 WorkbookItem。

示例


import tableauserverclient as TSC
tableau_auth = TSC.TableauAuth('username', 'password', site_id='site')
server = TSC.Server('https://servername')

with server.auth.sign_in(tableau_auth):
   # create a workbook item
   wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e')
   # call the publish method with the workbook item
   wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite')

相關用法

注：本文由純淨天空篩選整理自tableau.github.io大神的英文原創作品 workbooks.publish。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。