YoumallClient (tencentcloud-sdk-java 3.1.135 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.youmall.v20180228.YoumallClient

public class YoumallClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`YoumallClient(Credential credential, String region)`
`YoumallClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAccountResponse`	`CreateAccount(CreateAccountRequest req)` 创建集团门店管理员账号
`CreateFacePictureResponse`	`CreateFacePicture(CreateFacePictureRequest req)` 通过上传指定规格的人脸图片，创建黑名单用户或者白名单用户。
`DeletePersonFeatureResponse`	`DeletePersonFeature(DeletePersonFeatureRequest req)` 删除顾客特征，仅支持删除黑名单或者白名单用户特征。
`DescribeCameraPersonResponse`	`DescribeCameraPerson(DescribeCameraPersonRequest req)` 通过指定设备ID和指定时段，获取该时段内中收银台摄像设备抓取到顾客头像及身份ID
`DescribeClusterPersonArrivedMallResponse`	`DescribeClusterPersonArrivedMall(DescribeClusterPersonArrivedMallRequest req)` 输出开始时间到结束时间段内的进出场数据。按天聚合的情况下，每天多次进出场算一次，以最初进场时间为进场时间，最后离场时间为离场时间。停留时间为多次进出场的停留时间之和。
`DescribeClusterPersonTraceResponse`	`DescribeClusterPersonTrace(DescribeClusterPersonTraceRequest req)` 输出开始时间到结束时间段内的进出场数据。按天聚合的情况下，每天多次进出场算一次，以最初进场时间为进场时间，最后离场时间为离场时间。
`DescribeFaceIdByTempIdResponse`	`DescribeFaceIdByTempId(DescribeFaceIdByTempIdRequest req)` 通过DescribeCameraPerson接口上报的收银台身份ID查询顾客的FaceID。查询最佳时间为收银台上报的次日1点后。
`DescribeHistoryNetworkInfoResponse`	`DescribeHistoryNetworkInfo(DescribeHistoryNetworkInfoRequest req)` 返回当前门店历史网络状态数据
`DescribeNetworkInfoResponse`	`DescribeNetworkInfo(DescribeNetworkInfoRequest req)` 返回当前门店最新网络状态数据
`DescribePersonResponse`	`DescribePerson(DescribePersonRequest req)` 查询指定某一卖场的用户信息
`DescribePersonArrivedMallResponse`	`DescribePersonArrivedMall(DescribePersonArrivedMallRequest req)` 输出开始时间到结束时间段内的进出场数据。不做按天聚合的情况下，每次进出场，产生一条进出场数据。
`DescribePersonInfoResponse`	`DescribePersonInfo(DescribePersonInfoRequest req)` 指定门店获取所有顾客详情列表，包含客户ID、图片、年龄、性别
`DescribePersonInfoByFacePictureResponse`	`DescribePersonInfoByFacePicture(DescribePersonInfoByFacePictureRequest req)` 通过上传人脸图片检索系统face id、顾客身份信息及底图
`DescribePersonTraceResponse`	`DescribePersonTrace(DescribePersonTraceRequest req)` 输出开始时间到结束时间段内的进出场数据。
`DescribePersonTraceDetailResponse`	`DescribePersonTraceDetail(DescribePersonTraceDetailRequest req)` 查询客户单次到场轨迹明细
`DescribePersonVisitInfoResponse`	`DescribePersonVisitInfo(DescribePersonVisitInfoRequest req)` 获取门店指定时间范围内的所有用户到访信息记录，支持的时间范围：过去365天，含当天。
`DescribeShopHourTrafficInfoResponse`	`DescribeShopHourTrafficInfo(DescribeShopHourTrafficInfoRequest req)` 按小时提供查询日期范围内门店的每天每小时累计客流人数数据，支持的时间范围：过去365天，含当天。
`DescribeShopInfoResponse`	`DescribeShopInfo(DescribeShopInfoRequest req)` 根据客户身份标识获取客户下所有的门店信息列表
`DescribeShopTrafficInfoResponse`	`DescribeShopTrafficInfo(DescribeShopTrafficInfoRequest req)` 按天提供查询日期范围内门店的单日累计客流人数，支持的时间范围：过去365天，含当天。
`DescribeTrajectoryDataResponse`	`DescribeTrajectoryData(DescribeTrajectoryDataRequest req)` 获取动线轨迹信息
`DescribeZoneFlowAgeInfoByZoneIdResponse`	`DescribeZoneFlowAgeInfoByZoneId(DescribeZoneFlowAgeInfoByZoneIdRequest req)` 获取指定区域人流各年龄占比
`DescribeZoneFlowAndStayTimeResponse`	`DescribeZoneFlowAndStayTime(DescribeZoneFlowAndStayTimeRequest req)` 获取区域人流和停留时间
`DescribeZoneFlowDailyByZoneIdResponse`	`DescribeZoneFlowDailyByZoneId(DescribeZoneFlowDailyByZoneIdRequest req)` 获取指定区域每日客流量
`DescribeZoneFlowGenderAvrStayTimeByZoneIdResponse`	`DescribeZoneFlowGenderAvrStayTimeByZoneId(DescribeZoneFlowGenderAvrStayTimeByZoneIdRequest req)` 获取指定区域不同年龄段男女平均停留时间
`DescribeZoneFlowGenderInfoByZoneIdResponse`	`DescribeZoneFlowGenderInfoByZoneId(DescribeZoneFlowGenderInfoByZoneIdRequest req)` 获取指定区域性别占比
`DescribeZoneFlowHourlyByZoneIdResponse`	`DescribeZoneFlowHourlyByZoneId(DescribeZoneFlowHourlyByZoneIdRequest req)` 获取指定区域分时客流量
`DescribeZoneTrafficInfoResponse`	`DescribeZoneTrafficInfo(DescribeZoneTrafficInfoRequest req)` 按天提供查询日期范围内，客户指定门店下的所有区域（优Mall部署时已配置区域）的累计客流人次和平均停留时间。支持的时间范围：过去365天，含当天。
`ModifyPersonFeatureInfoResponse`	`ModifyPersonFeatureInfo(ModifyPersonFeatureInfoRequest req)` 支持修改黑白名单类型的顾客特征
`ModifyPersonTagInfoResponse`	`ModifyPersonTagInfo(ModifyPersonTagInfoRequest req)` 标记到店顾客的身份类型，例如黑名单、白名单等
`ModifyPersonTypeResponse`	`ModifyPersonType(ModifyPersonTypeRequest req)` 修改顾客身份类型接口
`RegisterCallbackResponse`	`RegisterCallback(RegisterCallbackRequest req)` 调用本接口在优Mall中注册自己集团的到店通知回调接口地址，接口协议为HTTP或HTTPS。注册后，若集团有特殊身份（例如老客）到店通知，优Mall后台将主动将到店信息push给该接口

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - YoumallClient
```
public YoumallClient(Credential credential,
                     String region)
```
  - YoumallClient
```
public YoumallClient(Credential credential,
                     String region,
                     ClientProfile profile)
```
- Method Detail
  - CreateAccount
```
public CreateAccountResponse CreateAccount(CreateAccountRequest req)
                                    throws TencentCloudSDKException
```
    创建集团门店管理员账号
    
    Parameters:
    
    req - CreateAccountRequest
    
    Returns:
    
    CreateAccountResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateFacePicture
```
public CreateFacePictureResponse CreateFacePicture(CreateFacePictureRequest req)
                                            throws TencentCloudSDKException
```
    通过上传指定规格的人脸图片，创建黑名单用户或者白名单用户。
    
    Parameters:
    
    req - CreateFacePictureRequest
    
    Returns:
    
    CreateFacePictureResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeletePersonFeature
```
public DeletePersonFeatureResponse DeletePersonFeature(DeletePersonFeatureRequest req)
                                                throws TencentCloudSDKException
```
    删除顾客特征，仅支持删除黑名单或者白名单用户特征。
    
    Parameters:
    
    req - DeletePersonFeatureRequest
    
    Returns:
    
    DeletePersonFeatureResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCameraPerson
```
public DescribeCameraPersonResponse DescribeCameraPerson(DescribeCameraPersonRequest req)
                                                  throws TencentCloudSDKException
```
    通过指定设备ID和指定时段，获取该时段内中收银台摄像设备抓取到顾客头像及身份ID
    
    Parameters:
    
    req - DescribeCameraPersonRequest
    
    Returns:
    
    DescribeCameraPersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterPersonArrivedMall
```
public DescribeClusterPersonArrivedMallResponse DescribeClusterPersonArrivedMall(DescribeClusterPersonArrivedMallRequest req)
                                                                          throws TencentCloudSDKException
```
    输出开始时间到结束时间段内的进出场数据。按天聚合的情况下，每天多次进出场算一次，以最初进场时间为进场时间，最后离场时间为离场时间。停留时间为多次进出场的停留时间之和。
    
    Parameters:
    
    req - DescribeClusterPersonArrivedMallRequest
    
    Returns:
    
    DescribeClusterPersonArrivedMallResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterPersonTrace
```
public DescribeClusterPersonTraceResponse DescribeClusterPersonTrace(DescribeClusterPersonTraceRequest req)
                                                              throws TencentCloudSDKException
```
    输出开始时间到结束时间段内的进出场数据。按天聚合的情况下，每天多次进出场算一次，以最初进场时间为进场时间，最后离场时间为离场时间。
    
    Parameters:
    
    req - DescribeClusterPersonTraceRequest
    
    Returns:
    
    DescribeClusterPersonTraceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeFaceIdByTempId
```
public DescribeFaceIdByTempIdResponse DescribeFaceIdByTempId(DescribeFaceIdByTempIdRequest req)
                                                      throws TencentCloudSDKException
```
    通过DescribeCameraPerson接口上报的收银台身份ID查询顾客的FaceID。查询最佳时间为收银台上报的次日1点后。
    
    Parameters:
    
    req - DescribeFaceIdByTempIdRequest
    
    Returns:
    
    DescribeFaceIdByTempIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeHistoryNetworkInfo
```
public DescribeHistoryNetworkInfoResponse DescribeHistoryNetworkInfo(DescribeHistoryNetworkInfoRequest req)
                                                              throws TencentCloudSDKException
```
    返回当前门店历史网络状态数据
    
    Parameters:
    
    req - DescribeHistoryNetworkInfoRequest
    
    Returns:
    
    DescribeHistoryNetworkInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeNetworkInfo
```
public DescribeNetworkInfoResponse DescribeNetworkInfo(DescribeNetworkInfoRequest req)
                                                throws TencentCloudSDKException
```
    返回当前门店最新网络状态数据
    
    Parameters:
    
    req - DescribeNetworkInfoRequest
    
    Returns:
    
    DescribeNetworkInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePerson
```
public DescribePersonResponse DescribePerson(DescribePersonRequest req)
                                      throws TencentCloudSDKException
```
    查询指定某一卖场的用户信息
    
    Parameters:
    
    req - DescribePersonRequest
    
    Returns:
    
    DescribePersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePersonArrivedMall
```
public DescribePersonArrivedMallResponse DescribePersonArrivedMall(DescribePersonArrivedMallRequest req)
                                                            throws TencentCloudSDKException
```
    输出开始时间到结束时间段内的进出场数据。不做按天聚合的情况下，每次进出场，产生一条进出场数据。
    
    Parameters:
    
    req - DescribePersonArrivedMallRequest
    
    Returns:
    
    DescribePersonArrivedMallResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePersonInfo
```
public DescribePersonInfoResponse DescribePersonInfo(DescribePersonInfoRequest req)
                                              throws TencentCloudSDKException
```
    指定门店获取所有顾客详情列表，包含客户ID、图片、年龄、性别
    
    Parameters:
    
    req - DescribePersonInfoRequest
    
    Returns:
    
    DescribePersonInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePersonInfoByFacePicture
```
public DescribePersonInfoByFacePictureResponse DescribePersonInfoByFacePicture(DescribePersonInfoByFacePictureRequest req)
                                                                        throws TencentCloudSDKException
```
    通过上传人脸图片检索系统face id、顾客身份信息及底图
    
    Parameters:
    
    req - DescribePersonInfoByFacePictureRequest
    
    Returns:
    
    DescribePersonInfoByFacePictureResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePersonTrace
```
public DescribePersonTraceResponse DescribePersonTrace(DescribePersonTraceRequest req)
                                                throws TencentCloudSDKException
```
    输出开始时间到结束时间段内的进出场数据。
    
    Parameters:
    
    req - DescribePersonTraceRequest
    
    Returns:
    
    DescribePersonTraceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePersonTraceDetail
```
public DescribePersonTraceDetailResponse DescribePersonTraceDetail(DescribePersonTraceDetailRequest req)
                                                            throws TencentCloudSDKException
```
    查询客户单次到场轨迹明细
    
    Parameters:
    
    req - DescribePersonTraceDetailRequest
    
    Returns:
    
    DescribePersonTraceDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePersonVisitInfo
```
public DescribePersonVisitInfoResponse DescribePersonVisitInfo(DescribePersonVisitInfoRequest req)
                                                        throws TencentCloudSDKException
```
    获取门店指定时间范围内的所有用户到访信息记录，支持的时间范围：过去365天，含当天。
    
    Parameters:
    
    req - DescribePersonVisitInfoRequest
    
    Returns:
    
    DescribePersonVisitInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeShopHourTrafficInfo
```
public DescribeShopHourTrafficInfoResponse DescribeShopHourTrafficInfo(DescribeShopHourTrafficInfoRequest req)
                                                                throws TencentCloudSDKException
```
    按小时提供查询日期范围内门店的每天每小时累计客流人数数据，支持的时间范围：过去365天，含当天。
    
    Parameters:
    
    req - DescribeShopHourTrafficInfoRequest
    
    Returns:
    
    DescribeShopHourTrafficInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeShopInfo
```
public DescribeShopInfoResponse DescribeShopInfo(DescribeShopInfoRequest req)
                                          throws TencentCloudSDKException
```
    根据客户身份标识获取客户下所有的门店信息列表
    
    Parameters:
    
    req - DescribeShopInfoRequest
    
    Returns:
    
    DescribeShopInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeShopTrafficInfo
```
public DescribeShopTrafficInfoResponse DescribeShopTrafficInfo(DescribeShopTrafficInfoRequest req)
                                                        throws TencentCloudSDKException
```
    按天提供查询日期范围内门店的单日累计客流人数，支持的时间范围：过去365天，含当天。
    
    Parameters:
    
    req - DescribeShopTrafficInfoRequest
    
    Returns:
    
    DescribeShopTrafficInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTrajectoryData
```
public DescribeTrajectoryDataResponse DescribeTrajectoryData(DescribeTrajectoryDataRequest req)
                                                      throws TencentCloudSDKException
```
    获取动线轨迹信息
    
    Parameters:
    
    req - DescribeTrajectoryDataRequest
    
    Returns:
    
    DescribeTrajectoryDataResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneFlowAgeInfoByZoneId
```
public DescribeZoneFlowAgeInfoByZoneIdResponse DescribeZoneFlowAgeInfoByZoneId(DescribeZoneFlowAgeInfoByZoneIdRequest req)
                                                                        throws TencentCloudSDKException
```
    获取指定区域人流各年龄占比
    
    Parameters:
    
    req - DescribeZoneFlowAgeInfoByZoneIdRequest
    
    Returns:
    
    DescribeZoneFlowAgeInfoByZoneIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneFlowAndStayTime
```
public DescribeZoneFlowAndStayTimeResponse DescribeZoneFlowAndStayTime(DescribeZoneFlowAndStayTimeRequest req)
                                                                throws TencentCloudSDKException
```
    获取区域人流和停留时间
    
    Parameters:
    
    req - DescribeZoneFlowAndStayTimeRequest
    
    Returns:
    
    DescribeZoneFlowAndStayTimeResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneFlowDailyByZoneId
```
public DescribeZoneFlowDailyByZoneIdResponse DescribeZoneFlowDailyByZoneId(DescribeZoneFlowDailyByZoneIdRequest req)
                                                                    throws TencentCloudSDKException
```
    获取指定区域每日客流量
    
    Parameters:
    
    req - DescribeZoneFlowDailyByZoneIdRequest
    
    Returns:
    
    DescribeZoneFlowDailyByZoneIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneFlowGenderAvrStayTimeByZoneId
```
public DescribeZoneFlowGenderAvrStayTimeByZoneIdResponse DescribeZoneFlowGenderAvrStayTimeByZoneId(DescribeZoneFlowGenderAvrStayTimeByZoneIdRequest req)
                                                                                            throws TencentCloudSDKException
```
    获取指定区域不同年龄段男女平均停留时间
    
    Parameters:
    
    req - DescribeZoneFlowGenderAvrStayTimeByZoneIdRequest
    
    Returns:
    
    DescribeZoneFlowGenderAvrStayTimeByZoneIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneFlowGenderInfoByZoneId
```
public DescribeZoneFlowGenderInfoByZoneIdResponse DescribeZoneFlowGenderInfoByZoneId(DescribeZoneFlowGenderInfoByZoneIdRequest req)
                                                                              throws TencentCloudSDKException
```
    获取指定区域性别占比
    
    Parameters:
    
    req - DescribeZoneFlowGenderInfoByZoneIdRequest
    
    Returns:
    
    DescribeZoneFlowGenderInfoByZoneIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneFlowHourlyByZoneId
```
public DescribeZoneFlowHourlyByZoneIdResponse DescribeZoneFlowHourlyByZoneId(DescribeZoneFlowHourlyByZoneIdRequest req)
                                                                      throws TencentCloudSDKException
```
    获取指定区域分时客流量
    
    Parameters:
    
    req - DescribeZoneFlowHourlyByZoneIdRequest
    
    Returns:
    
    DescribeZoneFlowHourlyByZoneIdResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeZoneTrafficInfo
```
public DescribeZoneTrafficInfoResponse DescribeZoneTrafficInfo(DescribeZoneTrafficInfoRequest req)
                                                        throws TencentCloudSDKException
```
    按天提供查询日期范围内，客户指定门店下的所有区域（优Mall部署时已配置区域）的累计客流人次和平均停留时间。支持的时间范围：过去365天，含当天。
    
    Parameters:
    
    req - DescribeZoneTrafficInfoRequest
    
    Returns:
    
    DescribeZoneTrafficInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPersonFeatureInfo
```
public ModifyPersonFeatureInfoResponse ModifyPersonFeatureInfo(ModifyPersonFeatureInfoRequest req)
                                                        throws TencentCloudSDKException
```
    支持修改黑白名单类型的顾客特征
    
    Parameters:
    
    req - ModifyPersonFeatureInfoRequest
    
    Returns:
    
    ModifyPersonFeatureInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPersonTagInfo
```
public ModifyPersonTagInfoResponse ModifyPersonTagInfo(ModifyPersonTagInfoRequest req)
                                                throws TencentCloudSDKException
```
    标记到店顾客的身份类型，例如黑名单、白名单等
    
    Parameters:
    
    req - ModifyPersonTagInfoRequest
    
    Returns:
    
    ModifyPersonTagInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPersonType
```
public ModifyPersonTypeResponse ModifyPersonType(ModifyPersonTypeRequest req)
                                          throws TencentCloudSDKException
```
    修改顾客身份类型接口
    
    Parameters:
    
    req - ModifyPersonTypeRequest
    
    Returns:
    
    ModifyPersonTypeResponse
    
    Throws:
    
    TencentCloudSDKException
  - RegisterCallback
```
public RegisterCallbackResponse RegisterCallback(RegisterCallbackRequest req)
                                          throws TencentCloudSDKException
```
    调用本接口在优Mall中注册自己集团的到店通知回调接口地址，接口协议为HTTP或HTTPS。注册后，若集团有特殊身份（例如老客）到店通知，优Mall后台将主动将到店信息push给该接口
    
    Parameters:
    
    req - RegisterCallbackRequest
    
    Returns:
    
    RegisterCallbackResponse
    
    Throws:
    
    TencentCloudSDKException

Class YoumallClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

YoumallClient

YoumallClient

Method Detail

CreateAccount

CreateFacePicture

DeletePersonFeature

DescribeCameraPerson

DescribeClusterPersonArrivedMall

DescribeClusterPersonTrace

DescribeFaceIdByTempId

DescribeHistoryNetworkInfo

DescribeNetworkInfo

DescribePerson

DescribePersonArrivedMall

DescribePersonInfo

DescribePersonInfoByFacePicture

DescribePersonTrace

DescribePersonTraceDetail

DescribePersonVisitInfo

DescribeShopHourTrafficInfo

DescribeShopInfo

DescribeShopTrafficInfo

DescribeTrajectoryData

DescribeZoneFlowAgeInfoByZoneId

DescribeZoneFlowAndStayTime

DescribeZoneFlowDailyByZoneId

DescribeZoneFlowGenderAvrStayTimeByZoneId

DescribeZoneFlowGenderInfoByZoneId

DescribeZoneFlowHourlyByZoneId

DescribeZoneTrafficInfo

ModifyPersonFeatureInfo

ModifyPersonTagInfo

ModifyPersonType

RegisterCallback