如何使用Python导出Tableau仪表盘所有筛选器选项的PDF

我想用tableau_api_lib库编写Python代码，实现导出Tableau仪表盘单个筛选器选项的PDF，并循环导出该筛选器所有选项对应的仪表盘PDF。参照教程代码后，因使用令牌密钥连接Tableau Online，代码无法正常运行。尝试修改代码适配令牌登录、留空站点名称和站点URL后，持续出现JSON错误。以下是我的代码：

import pandas as pd
import io
from tableau_api_lib import TableauServerConnection
from tableau_api_lib.utils.querying import get_views_dataframe

DASHBOARD_NAME = 'Hospital Stats'
FILTER_NAME = 'department'
FILE_PREFIX = 'hospitalstats_'

# Sign in to Tableau Server
tableau_server_config = {
    'server': 'http://tableaudserverurl',
    'api_version': '3.11',
    'personal_access_token_name': 'name',
    'personal_access_token_secret': 'token',
    'site_name': '',
    'site_url': ''
}
conn = TableauServerConnection(tableau_server_config)
conn.sign_in()

# Get the view IDs for the dashboard and filter view
views = get_views_dataframe(conn)
print("Available views:")
print(views['name'])

dashboard_view_id = views[views['name'] == DASHBOARD_NAME]['id'].values[0]
filter_view_id = views[views['name'] == FILTER_NAME]['id'].values[0]

# Retrieve the filter options as a DataFrame
filter_data = conn.query_view_data(view_id=filter_view_id)
filter_df = pd.read_csv(io.StringIO(filter_data.content.decode('utf-8')))
filter_list = list(filter_df[FILTER_NAME])

# Export PDF and print view content for each filter option
pdf_params = {
    'type': 'type=A4',
    'orientation': 'orientation=Landscape',
    'filter': None
}
for item in filter_list:
    pdf_params['filter'] = f'vf_{FILTER_NAME}={item}'
    pdf = conn.query_view_pdf(view_id=dashboard_view_id, parameter_dict=pdf_params)
    with open(f'{FILE_PREFIX}{item}.pdf', 'wb') as pdf_file:
        pdf_file.write(pdf.content)
    
    # Print the view content for the current filter option
    view_content = conn.query_view_image(view_id=dashboard_view_id, parameter_dict=pdf_params)
    print(f"View content for filter option '{item}':")
    print(view_content.content)

# Sign out from Tableau Server
conn.sign_out()

核心问题点 #

1. Tableau Online服务器地址错误：使用了HTTP协议的自定义地址，Tableau Online必须使用https://online.tableau.com。
2. 站点配置缺失：Tableau Online的site_name和site_url不能留空，需从你的站点URL中提取（例如URLhttps://online.tableau.com/#/site/my-hospital-site/views/...中，site_url为my-hospital-site，site_name为站点的显示名称如My Hospital Site）。
3. PDF参数格式错误：parameter_dict中的参数不需要带key=前缀，筛选器参数的格式也不符合API要求。
4. 筛选器选项获取逻辑错误：试图通过同名视图获取筛选器选项，逻辑不合理，应直接从仪表盘的视图数据中提取。

修正后的代码 #

import pandas as pd
import io
from tableau_api_lib import TableauServerConnection
from tableau_api_lib.utils.querying import get_views_dataframe

DASHBOARD_NAME = 'Hospital Stats'
FILTER_FIELD = 'department'  # 仪表盘内的筛选器字段名
FILE_PREFIX = 'hospitalstats_'

# Tableau Online 正确配置
tableau_server_config = {
    'server': 'https://online.tableau.com',
    'api_version': '3.11',
    'personal_access_token_name': '你的令牌名称',
    'personal_access_token_secret': '你的令牌密钥',
    'site_name': '你的站点显示名称',  # 例如"My Hospital Site"
    'site_url': '你的站点URL后缀'       # 例如"my-hospital-site"
}

# 建立连接
conn = TableauServerConnection(tableau_server_config)
conn.sign_in()

# 获取仪表盘视图ID
views_df = get_views_dataframe(conn)
dashboard_view = views_df[views_df['name'] == DASHBOARD_NAME]

if dashboard_view.empty:
    raise ValueError(f"未找到名为'{DASHBOARD_NAME}'的仪表盘视图")

dashboard_view_id = dashboard_view['id'].values[0]

# 从仪表盘视图数据中提取筛选器所有唯一选项
view_data = conn.query_view_data(view_id=dashboard_view_id)
view_df = pd.read_csv(io.StringIO(view_data.content.decode('utf-8')))
filter_options = view_df[FILTER_FIELD].unique().tolist()

# 循环导出每个筛选器选项的PDF
pdf_base_params = {
    'type': 'A4',
    'orientation': 'Landscape'
}

for option in filter_options:
    # 构建当前筛选器的参数
    filter_param = {f'vf_{FILTER_FIELD}': option}
    current_params = {**pdf_base_params, **filter_param}
    
    # 请求PDF并保存
    pdf_response = conn.query_view_pdf(view_id=dashboard_view_id, parameter_dict=current_params)
    
    # 处理特殊字符避免文件保存失败
    safe_option = option.replace('/', '_').replace('\\', '_').replace(':', '_')
    with open(f'{FILE_PREFIX}{safe_option}.pdf', 'wb') as pdf_file:
        pdf_file.write(pdf_response.content)
    
    print(f"已完成筛选器选项「{option}」的PDF导出")

# 登出服务器
conn.sign_out()

关键修正说明 #

• 服务器地址：强制使用Tableau Online官方HTTPS地址，避免连接失败。
• 站点配置：补充正确的site_name和site_url，解决JSON解析错误的核心原因。
• 参数格式：修正parameter_dict的键值对格式，筛选器参数直接用vf_<字段名>作为键，选项值作为值，符合Tableau API要求。
• 筛选器选项获取：直接从仪表盘的视图数据中提取唯一字段值，无需依赖额外视图。
• 文件命名安全：对筛选器选项中的特殊字符做替换，避免文件保存报错。

内容的提问来源于stack exchange，提问作者zopgen