文档中心 > API类目 > 淘宝客API

taobao.tbk.sc.publisher.info.get (淘宝客-公用-私域用户备案信息查询)

查询已生成的渠道id或会员运营id的相关信息。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
relation_id Number 可选 2323 渠道独占 - 渠道关系ID
page_no Number 可选 0
  • 默认值:1
  • 第几页,下标从0开始
    page_size Number 可选 10
  • 默认值:10
  • 每页大小
    info_type Number 必须 1 类型,必选 1:渠道信息;2:会员信息
    relation_app String 必须 common 备案的场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)。如不填默认common。查询会员信息只需填写common即可
    special_id String 可选 1212 会员独占 - 会员运营ID
    external_id String 可选 12345 淘宝客外部用户标记,如自身系统账户ID;微信ID等
    external_type Number 可选 0
  • 默认值:0
  • 1-微信、2-微博、3-抖音、4-快手、5-QQ,0-其他;默认为0

    响应参数

    名称 类型 示例值 描述
    data Data data
    • └ total_count
    • Number
    • 40
    • 共享字段 - 总记录数
    • inviter_list
    • MapData []
    • inviterList
    • 共享字段 - 渠道或会员列表
    • └ relation_app
    • String
    • common
    • 共享字段 - 备案场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)
    • └ create_date
    • Date
    • 2018-06-01 11:12:23
    • 共享字段 - 备案日期
    • └ account_name
    • String
    • s**x
    • 渠道独有 - 渠道昵称
    • └ real_name
    • String
    • xxx
    • 渠道独有 - 渠道名称
    • └ relation_id
    • Number
    • 40232
    • 渠道独有 - 渠道关系ID
    • └ offline_scene
    • String
    • 门店
    • 渠道独有 - 线下场景信息,1 - 门店,2- 学校,3 - 工厂,4 - 其他
    • └ online_scene
    • String
    • 微信群
    • 渠道独有 - 线上场景信息,1 - 微信群,2- QQ群,3 - 其他
    • └ note
    • String
    • 小蜜蜂
    • 渠道独有 - 媒体侧渠道备注信息
    • └ root_pid
    • String
    • mm_1_1_1
    • 共享字段 - 渠道/会员专属pid
    • └ rtag
    • String
    • 123
    • 共享字段 - 渠道/会员原始身份信息
    • offline_info
    • RegisterInfoDto
    • 线下
    • 线下备案专属信息
    • └ shop_name
    • String
    • 日用百货店
    • 渠道独有 -店铺名称
    • └ shop_type
    • String
    • 生活服务类 电信营业厅
    • 渠道独有 -店铺类型
    • └ phone_number
    • String
    • 1590000000
    • 渠道独有 - 信息
    • └ detail_address
    • String
    • **街道**号楼
    • 渠道独有 -信息
    • └ location
    • String
    • 内蒙古自治区 呼和浩特市
    • 渠道独有 -区
    • └ shop_certify_type
    • String
    • 营业执照
    • 渠道独有 -类型
    • └ certify_number
    • String
    • 123445677
    • 渠道独有 - 编号
    • └ career
    • String
    • 个人 快递员
    • 渠道独有 -经营类型
    • └ special_id
    • Number
    • 12345
    • 会员独有 - 会员运营ID
    • └ punish_status
    • String
    • 1
    • 渠道独有 - 处罚状态
    • └ external_id
    • String
    • 12345
    • 淘宝客外部用户标记
    • └ external_type
    • String
    • 1
    • 1-微信、2-微博、3-抖音、4-快手、5-QQ,0-其他
    • └ root_pid_channel_list
    • String []
    • ["mm_1_1_1"]
    • 渠道专属pidList

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkScPublisherInfoGetRequest req = new TbkScPublisherInfoGetRequest();
    req.setRelationId(2323L);
    req.setPageNo(0L);
    req.setPageSize(10L);
    req.setInfoType(1L);
    req.setRelationApp("common");
    req.setSpecialId("1212");
    req.setExternalId("12345");
    req.setExternalType(0L);
    TbkScPublisherInfoGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_sc_publisher_info_get_response>
        <data>
            <total_count>40</total_count>
            <inviter_list>
                <map_data>
                    <relation_app>common</relation_app>
                    <create_date>2018-06-01 11:12:23</create_date>
                    <account_name>s**x</account_name>
                    <real_name>xxx</real_name>
                    <relation_id>40232</relation_id>
                    <offline_scene>门店</offline_scene>
                    <online_scene>微信群</online_scene>
                    <note>小蜜蜂</note>
                    <root_pid>mm_1_1_1</root_pid>
                    <rtag>123</rtag>
                    <offline_info>
                        <shop_name>日用百货店</shop_name>
                        <shop_type>生活服务类 电信营业厅</shop_type>
                        <phone_number>1590000000</phone_number>
                        <detail_address>**街道**号楼</detail_address>
                        <location>内蒙古自治区 呼和浩特市</location>
                        <shop_certify_type>营业执照</shop_certify_type>
                        <certify_number>123445677</certify_number>
                        <career>个人 快递员</career>
                    </offline_info>
                    <special_id>12345</special_id>
                    <punish_status>1</punish_status>
                    <external_id>12345</external_id>
                    <external_type>1</external_type>
                </map_data>
            </inviter_list>
            <root_pid_channel_list>
                <string>[&quot;mm_1_1_1&quot;]</string>
            </root_pid_channel_list>
        </data>
    </tbk_sc_publisher_info_get_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案
    isp.tbkapi-service-unavailable 淘宝客API服务不可用 请稍后重试
    isv.invalid-parameter:start_price 参数填写不正确 参数填写不正确
    isv.invalid-parameter:end_price 参数填写不正确 参数填写不正确
    isv.invalid-parameter:end_tk_rate 参数填写不正确 参数填写不正确
    4 查询不到对应的adzoneId 请检查adzoneId是否正确
    2 pid不正确 请检查是否输入了正确的adzoneId和siteId
    30501 输入参数info_type非法 参考文档
    isp.sys-error 服务异常 稍后重试

    API工具

    如何获得此API

    FAQ

    返回
    顶部