Qualtricsapi是Qualtrics Web API的轻量级Python库。
QualtricsA的Python项目详细描述
质量控制
作者:Jeremy Seibert
许可证:MIT
包文档:Documentation
Qualtrics是一家非常棒的公司,它开发的软件可以让用户通过在线调查收集在线数据。这个Python包作为一个包装器存在于QualthAPI中。这个包的主要目标是成为python用户从qualtrics摄取或上传数据到开发环境的超级方便的方式,反之亦然。
在我们继续之前,我想提两件事:
首先,您必须具有Qualtrics API访问权限才能使用此包。请与您的Qualtrics帐户经理联系,以进一步澄清您帐户的访问凭据。
第二,这个方案不附属于质量标准。因此,我这个包的作者jeremy seibert并不隶属于qualtrics,qualtrics也不支持这个包。有关Qualtrics API的具体信息,请参阅其官方文档。
r用户
对于任何r用户来说,都有一个同样出色的包"qualtRics",它的功能与这个包非常相似。我试图与Qualtrics包和这个包中使用的一些方法保持一致,以便两者之间有一个内聚。但是,我不认为它支持在xm联系人数据(即xmdirectory或邮件列表)中工作的功能。CRAN
作者:Julia Silge,Jasper Ginn
许可证:MIT
功能性
目前这个软件包有两个主要用途。
联系人数据-管理xmdirectory和任何相关邮件列表中的调查联系人。
调查数据-管理调查和从每个调查中收集的数据。
基本用法
凭证代码流
我们首先创建的环境变量将保存您的api凭证,因此您不必不断地声明它们。为此,我们导入credentials模块,创建并调用qualtrics_api_credentials()
方法。
fromQualtricsAPI.SetupimportCredentials#Create an instance of Credentialsc=Credentials()#Call the qualtrics_api_credentials() methodc.qualtrics_api_credentials(token='Your API Token',data_center='Your Data Center',directory_id='Your Directory ID')
这将生成环境变量,用于填充进行api调用所必需的http头。
联系方式
现在,所需的http头的生成将被自动处理,因此我们不必担心它。我们有两个模块可用于处理联系人数据。第一个是XMDirectory()
,和MailingList()
。我们按如下方式进口。
fromQualtricsAPI.XMimportXMDirectoryfromQualtricsAPI.XMimportMailingList#Create instances of eachx=XMDirectory()m=MailingList()
导入后,两个模块之间有10个可用的方法。
- xmdirectory()类方法
# Creates contacts in the XMDirectoryx.create_contact_in_XM()#Deletes a contact in the XMDirectory (use cautiously!)x.delete_contact()#lists Contacts in the XMDirectoryx.list_contacts_in_directory()
- mailingList()类方法
#Creates a new Mailing list for the given Qualtrics User()m.create_list()#Lists the Mailing Lists for the given Qualtrics User()m.list_lists()#Gets the Attributes of the defined Mailing Listm.get_list()#Renames the defined Mailing Listm.rename_list()#Deletes a defined Mailing List (use cautiously!)m.delete_list()#Lists the contacts in the defined Mailing Listm.list_contacts()#Creates contacts in a Mailing Listm.create_contact_in_list()
调查数据
目前只有一个模块是用来处理调查数据的,Responses()
。此模块有一个方法可下载与给定调查相关联的响应。可以使用以下方法调用该方法。
fromQualtricsAPI.SurveysimportResponses#Create instances of eachr=Responses()#Call the methodr.get_responses()
总结
同样,这是目前正在开发中,所以可能有减少的功能,但我希望这有助于其他Qualtrics用户加快他们当前的工作流程!
想做贡献吗?
这个项目遵守Contributor Code of Conduct。通过参与这个项目,你同意遵守它的条款。反馈、错误报告(和修复!),欢迎功能请求!