# 数据预拉取和数据周期性更新

调试工具

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

getFetchdataSetting

# 功能描述

调用本接口可以获取数据预拉取和数据周期性更新配置、设置预拉取数据、设置周期性拉取数据。
使用过程中如遇到问题，可在开放平台服务商专区发帖交流。

# 注意事项

该接口有三个功能，通过action的值进行区分，请详细按照接口文档调用接口。
pre_fetch_url或者period_fetch_url的域名需要配置为小程序的业务域名

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/wxa/fetchdatasetting?access_token=ACCESS_TOKEN

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：18
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用authorizer_access_token
action	string	是	可填"get"、“ set_pre_fetch”、"set_period_fetch"
is_pre_fetch_open	boolean	否	数据预拉取是否开启，action=set_pre_fetch时，必填
pre_fetch_type	number	否	数据来源，0: 开发者服务器；1：云函数。action=set_pre_fetch时，必填
pre_fetch_url	string	否	数据下载地址，当pre_fetch_type=0必填。
说明，1、需要将域名先添加到第三方平台的业务域名；2、然后将该域名添加到小程序业务域名；才可以成功设置
pre_env	string	否	环境ID，当pre_fetch_type=1必填
pre_function_name	string	否	函数名，当pre_fetch_type=1必填
is_period_fetch_open	boolean	否	周期性拉取数据是否开启，true开启，false关闭。action= set_period_fetch时，必填
period_fetch_type	number	否	数据来源，0: 开发者服务器；1：云函数。action= set_period_fetch时，必填
period_fetch_url	string	否	数据下载地址，当period_fetch_type=0必填
1、需要将域名先添加到第三方平台的业务域名；2、然后将该域名添加到小程序业务域名；才可以成功设置
period_env	string	否	环境ID，当period_fetch_type=1必填
period_function_name	string	否	函数名，当period_fetch_type=1必填

# 返回参数

属性	类型	说明
errcode	number	返回码
errmsg	string	错误信息
is_pre_fetch_open	boolean	数据预拉取是否开启
pre_fetch_type	number	数据来源，0: 开发者服务器；1：云函数
pre_fetch_url	string	数据下载地址，当pre_fetch_type=0有效
pre_env	string	环境ID，当pre_fetch_type=1有效
pre_function_name	string	函数名，当pre_fetch_type=1有效
is_period_fetch_open	boolean	数据周期性更新是否开启
period_fetch_type	number	0: 开发者服务器；1：云函数
period_fetch_url	string	数据下载地址当period_fetch_type=0有效
period_env	string	环境ID，当period_fetch_type=1有效
period_function_name	string	函数名，当period_fetch_type=1有效

# 调用示例

示例说明: 获取数据预拉取和数据周期性更新配置

# 请求数据示例


{
  "action": "get"
}

# 返回数据示例


{
  "errcode": 0,
  "errmsg": "ok",
  "is_pre_fetch_open": true, 
  "pre_fetch_type": 1, 
  "pre_env": "test-pfyol", 
  "pre_function_name": "test_func",
  "is_period_fetch_open": true, 
  "period_fetch_type": 0, 
  "period_fetch_url": "https://111.qq.com"
}

示例说明: 设置预拉取数据

# 请求数据示例


{
  "action": "set_pre_fetch", 
  "is_pre_fetch_open": true, 
  "pre_fetch_type": 0, 
  "pre_fetch_url": "https://fff.com"
}

# 返回数据示例


{
  "errcode": 0,
  "errmsg": "ok"
}

示例说明: 设置周期性拉取数据

# 请求数据示例


{
  "action": "set_period_fetch", 
  "is_period_fetch_open": true, 
  "period_fetch_type": 1, 
  "period_env": "test-pfyol", 
  "period_function_name": "login"
}

# 返回数据示例


{
  "errcode": 0,
  "errmsg": "ok"
}

# 错误码

错误码	错误码取值	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
9410016		存在无效域名。具体原因见errmsg（可能有多种原因）。
9410013	无效action	无效action
40166	invalid weapp appid	非小程序发起调用