mirage

Documentation

Overview

Package mirage 包含优酷播控幻影API相关结构体

https://open.taobao.com/API.htm?docId=43082&docType=2

Index

• type PermissionRequestDto
• type PermissionResponseDto
• type YoukuMirageQueryPermissionAPIRequest
  • func NewYoukuMirageQueryPermissionRequest() *YoukuMirageQueryPermissionAPIRequest
  • func (r YoukuMirageQueryPermissionAPIRequest) GetApiMethodName() string
  • func (r YoukuMirageQueryPermissionAPIRequest) GetApiParams() url.Values
  • func (r YoukuMirageQueryPermissionAPIRequest) GetPermissionRequestDto() *PermissionRequestDto
  • func (r *YoukuMirageQueryPermissionAPIRequest) SetPermissionRequestDto(_permissionRequestDto *PermissionRequestDto) error
• type YoukuMirageQueryPermissionAPIResponse
• type YoukuMirageQueryPermissionAPIResponseModel

Types

type PermissionRequestDto

type PermissionRequestDto struct {
	// 资源id
	ResourceIds []string `json:"resource_ids,omitempty" xml:"resource_ids>string,omitempty"`
	// 播放场景
	DisplayScene string `json:"display_scene,omitempty" xml:"display_scene,omitempty"`
	// pid
	Pid string `json:"pid,omitempty" xml:"pid,omitempty"`
	// 端对drm的能力
	ClientDrmAbility string `json:"client_drm_ability,omitempty" xml:"client_drm_ability,omitempty"`
	// app 版本
	AppVersion string `json:"app_version,omitempty" xml:"app_version,omitempty"`
	// 用户身份
	UserIdentity string `json:"user_identity,omitempty" xml:"user_identity,omitempty"`
	// ccode
	Ccode string `json:"ccode,omitempty" xml:"ccode,omitempty"`
	// ytid
	Ytid string `json:"ytid,omitempty" xml:"ytid,omitempty"`
	// 用户ip
	UserIp string `json:"user_ip,omitempty" xml:"user_ip,omitempty"`
	// 用户简化版userAgent
	Ua string `json:"ua,omitempty" xml:"ua,omitempty"`
	// 用户完整userAgent
	UserAgent string `json:"user_agent,omitempty" xml:"user_agent,omitempty"`
	// 设备类型
	DeviceType string `json:"device_type,omitempty" xml:"device_type,omitempty"`
	// 运营商
	DmaCode string `json:"dma_code,omitempty" xml:"dma_code,omitempty"`
	// 地区码
	AreaCode string `json:"area_code,omitempty" xml:"area_code,omitempty"`
	// 国家码
	CountryCode string `json:"country_code,omitempty" xml:"country_code,omitempty"`
	// 网站
	Site string `json:"site,omitempty" xml:"site,omitempty"`
	// 资源类型
	ResourceType string `json:"resource_type,omitempty" xml:"resource_type,omitempty"`
	// 调用方
	Caller string `json:"caller,omitempty" xml:"caller,omitempty"`
	// 签名
	Signature string `json:"signature,omitempty" xml:"signature,omitempty"`
	// 需要展示形式配置
	NeedDisplayConfig bool `json:"need_display_config,omitempty" xml:"need_display_config,omitempty"`
	// 需要同步返回drm配置信息
	NeedDrmConfig bool `json:"need_drm_config,omitempty" xml:"need_drm_config,omitempty"`
	// 苹果
	IsFromApple bool `json:"is_from_apple,omitempty" xml:"is_from_apple,omitempty"`
}

PermissionRequestDto 结构体

type PermissionResponseDto

type PermissionResponseDto struct {
	// 错误内容
	Message string `json:"message,omitempty" xml:"message,omitempty"`
	// 该值为MAP类型，KEY=视频或者节目ID；VALUE中包含两个值resourceId视频或者节目ID(String类型)，以及access该视频或者节目是否可播（Boolean）结果
	Permissions string `json:"permissions,omitempty" xml:"permissions,omitempty"`
	// 成功
	Success bool `json:"success,omitempty" xml:"success,omitempty"`
}

PermissionResponseDto 结构体

type YoukuMirageQueryPermissionAPIRequest

type YoukuMirageQueryPermissionAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

YoukuMirageQueryPermissionAPIRequest 优酷播控查询是否可播API API请求 youku.mirage.query.permission

根据节目ID或者VID查询视频或者节目是否可以播放

func NewYoukuMirageQueryPermissionRequest

func NewYoukuMirageQueryPermissionRequest() *YoukuMirageQueryPermissionAPIRequest

NewYoukuMirageQueryPermissionRequest 初始化YoukuMirageQueryPermissionAPIRequest对象

func (YoukuMirageQueryPermissionAPIRequest) GetApiMethodName

func (r YoukuMirageQueryPermissionAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (YoukuMirageQueryPermissionAPIRequest) GetApiParams

func (r YoukuMirageQueryPermissionAPIRequest) GetApiParams() url.Values

GetApiParams IRequest interface 方法, 获取API参数

func (YoukuMirageQueryPermissionAPIRequest) GetPermissionRequestDto

func (r YoukuMirageQueryPermissionAPIRequest) GetPermissionRequestDto() *PermissionRequestDto

GetPermissionRequestDto PermissionRequestDto Getter

func (*YoukuMirageQueryPermissionAPIRequest) SetPermissionRequestDto

func (r *YoukuMirageQueryPermissionAPIRequest) SetPermissionRequestDto(_permissionRequestDto *PermissionRequestDto) error

SetPermissionRequestDto is PermissionRequestDto Setter 入参

type YoukuMirageQueryPermissionAPIResponse

type YoukuMirageQueryPermissionAPIResponse struct {
	model.CommonResponse
	YoukuMirageQueryPermissionAPIResponseModel
}

YoukuMirageQueryPermissionAPIResponse 优酷播控查询是否可播API API返回值 youku.mirage.query.permission

根据节目ID或者VID查询视频或者节目是否可以播放

type YoukuMirageQueryPermissionAPIResponseModel

type YoukuMirageQueryPermissionAPIResponseModel struct {
	XMLName xml.Name `xml:"youku_mirage_query_permission_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 返回值
	Resp *PermissionResponseDto `json:"resp,omitempty" xml:"resp,omitempty"`
}

YoukuMirageQueryPermissionAPIResponseModel is 优酷播控查询是否可播API 成功返回结果