Documentation ¶
Overview ¶
Package file 素材相关API models
Index ¶
- type AdAppCreateRequest
- type AdAppListRequest
- type AdAppListResponse
- type AdAppUpdateRequest
- type AdImageGetRequest
- type AdImageListRequest
- type AdImageListResponse
- type AdImageUploadRequestV1
- type AdImageUploadRequestV2
- type AdVideoGetRequest
- type AdVideoListRequest
- type AdVideoListResponse
- type AdVideoRelateCreativesRequest
- type AdVideoRelateCreativesResponse
- type AdVideoRelatedCreative
- type AdVideoRelatedCreatives
- type AdVideoShareDetail
- type AdVideoShareRequest
- type AdVideoShareResponse
- type AdVideoTagDeleteRequest
- type AdVideoUpdateRequest
- type AdVideoUploadRequestV1
- type AdVideoUploadRequestV2
- type App
- type Image
- type Video
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdAppCreateRequest ¶
type AdAppCreateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // File 应用安装包(apk); 包体限制:1G 以内;当platform为1时,可自行选择上传apk,如果同时传了url,以file字段值为主 File *model.UploadField // AppVersion 应用标记; 不能超过100字符,同一账户下应用标记不能重复;样例:快影-3.0.0.0103 AppVersion string `json:"app_version,omitempty"` // AppName 应用名称; 不能超过100字符 AppName string `json:"app_name,omitempty"` // ImageToken 应用图标的image_token; 图片token,可通过上传图片接口获取;platform为1/3时必填,请上传png/jpg/jpeg图片,尺寸450*450,小于100KB ImageToken string `json:"image_token,omitempty"` // PackageName 应用包名; platform为1(Android应用下载)必填,其它类型不用填写,不能超过 100 字符 PackageName string `json:"package_name,omitempty"` // Platform 应用类型; 1:Android应用下载,2:Android网页游戏,3:iOS应用下载,4:iOS网页游戏 Platform int `json:"platform,omitempty"` // URL 应用地址 URL string `json:"url,omitempty"` // UseSDK 是否接入快手广告监测SDK; 0:未接入,1:已接入 UseSDK int `json:"use_sdk"` // AppPrivacyUrl app隐私政策链接,需与app相关,该字段会经过审核; 安卓类应用必填 AppPrivacyUrl string `json:"app_privacy_url,omitempty"` // PermissionInformation 权限信息,请通过应用权限信息列表接口获取信息 PermissionInformation string `json:"permission_information,omitempty"` // RealAppVersion 真实版本号 RealAppVersion string `json:"real_app_version,omitempty"` // AppIconUrl 应用包大小 PackageSize int64 `json:"package_size,omitempty"` // AppDetailImageToken app应用详情图片 AppDetailImageToken string `json:"app_detail_image_token,omitempty"` }
AdAppCreateRequest 创建应用 API Request
func (AdAppCreateRequest) Encode ¶
func (r AdAppCreateRequest) Encode() []model.UploadField
Encode implement UploadRequest interface
func (AdAppCreateRequest) Url ¶
func (r AdAppCreateRequest) Url() string
Url implement UploadRequest interface
type AdAppListRequest ¶
type AdAppListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id"` // AppIDS 应用ID AppIDS []uint64 `json:"app_ids,omitempty"` // Page 页码,默认 1 Page int `json:"page,omitempty"` // PageSize 页数,默认 20 PageSize int `json:"page_size,omitempty"` }
AdAppListRequest 获取应用列表 API Request
func (AdAppListRequest) Encode ¶
func (r AdAppListRequest) Encode() []byte
Encode implement PostRequest interface
func (AdAppListRequest) Url ¶
func (r AdAppListRequest) Url() string
Url implement GetRequest interface
type AdAppListResponse ¶
type AdAppListResponse struct { // TotalCount 返回条数 TotalCount int `json:"total_count,omitempty"` // Details 列表 Details []App `json:"details,omitempty"` }
AdAppListResponse 获取应用列表 API Response
type AdAppUpdateRequest ¶
type AdAppUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // File 应用安装包(apk); 包体限制:1G 以内;当platform为1时,可自行选择上传apk,如果同时传了url,以file字段值为主 File *model.UploadField // AppID 应用ID AppID int64 `json:"app_id,omitempty"` // AppVersion 应用标记; 不能超过100字符,同一账户下应用标记不能重复;样例:快影-3.0.0.0103 AppVersion string `json:"app_version,omitempty"` // AppName 应用名称; 不能超过100字符 AppName string `json:"app_name,omitempty"` // ImageToken 应用图标的image_token; 图片token,可通过上传图片接口获取;platform为1/3时必填,请上传png/jpg/jpeg图片,尺寸450*450,小于100KB ImageToken string `json:"image_token,omitempty"` // PacakgeName 应用包名; platform为1(Android应用下载)必填,其它类型不用填写,不能超过 100 字符 PackageName string `json:"package_name,omitempty"` // URL 应用地址 URL string `json:"url,omitempty"` // UseSDK 是否接入快手广告监测SDK; 0:未接入,1:已接入 UseSDK *int `json:"use_sdk"` // AppPrivacyUrl app隐私政策链接,需与app相关,该字段会经过审核; 安卓类应用必填 AppPrivacyUrl string `json:"app_privacy_url,omitempty"` // PermissionInformation 权限信息,请通过应用权限信息列表接口获取信息 PermissionInformation string `json:"permission_information,omitempty"` // RealAppVersion 真实版本号 RealAppVersion string `json:"real_app_version,omitempty"` // AppIconUrl 应用包大小 PackageSize int64 `json:"package_size,omitempty"` // AppDetailImageToken app应用详情图片 AppDetailImageToken string `json:"app_detail_image_token,omitempty"` }
AdAppUpdateRequest 修改应用 API Request
func (AdAppUpdateRequest) Encode ¶
func (r AdAppUpdateRequest) Encode() []model.UploadField
Encode implement UploadRequest interface
func (AdAppUpdateRequest) Url ¶
func (r AdAppUpdateRequest) Url() string
Url implement UploadRequest interface
type AdImageGetRequest ¶
type AdImageGetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // ImageToken 图片token ImageToken string `json:"image_token,omitempty"` }
AdImageGetRequest 查询图片信息get接口 API Request
func (AdImageGetRequest) Encode ¶
func (r AdImageGetRequest) Encode() string
Encode implement GetRequest interface
func (AdImageGetRequest) Url ¶
func (r AdImageGetRequest) Url() string
Url implement GetRequest interface
type AdImageListRequest ¶
type AdImageListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // StartDate 开始时间; 与end_date同时传或同时不传; StartDate string `json:"start_date,omitempty"` // EndDate 结束时间 EndDate string `json:"end_date,omitempty"` // Page 请求的页码数 Page int `json:"page,omitempty"` // PageSize 每页行数 PageSize int `json:"page_size,omitempty"` }
AdImageListRequest 查询图片接口list接口API Request
func (AdImageListRequest) Encode ¶
func (r AdImageListRequest) Encode() []byte
Encode implement GetRequest interface
func (AdImageListRequest) Url ¶
func (r AdImageListRequest) Url() string
Url implement GetRequest interface
type AdImageListResponse ¶
type AdImageListResponse struct { // TotalCount 图片总数 TotalCount int `json:"total_count,omitempty"` // Details 详情 Details []Image `json:"details,omitempty"` }
AdImageListResponse 查询图片接口list接口 API Response
type AdImageUploadRequestV1 ¶
type AdImageUploadRequestV1 struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // File 图片文件 File *model.UploadField `json:"file,omitempty"` // Type 上传图片类型; 0:上传封面图片(仅1.0版本使用),1:上传app_icon图片,2:广告组设置中scene_id为7时的封面图片;3:广告组设置中scene_id为3时的素材图片(后贴片样式已下线) Type int `json:"type"` }
AdImageUploadRequestV1 上传图片v1接口 API Request
func (AdImageUploadRequestV1) Encode ¶
func (r AdImageUploadRequestV1) Encode() []model.UploadField
Encode implenent UploadRequest interface
func (AdImageUploadRequestV1) Url ¶
func (r AdImageUploadRequestV1) Url() string
Url implement UploadRequest interface
type AdImageUploadRequestV2 ¶
type AdImageUploadRequestV2 struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Type 上传图片类型; 默认为2。1:上传app_icon图片; 2:广告组设置中scene_id为7时的封面图片; 4:广告组设置中scene_id为3时的便利贴广告素材图片;5:联盟图片素材; 6:横版图片;7:小图(组图与小图对于格式要求一致,只不过组图传三个);高级创意图片:100:图片卡片 ;101:多利益卡-图文 ;102:多利益卡-多标签 ;103:电商促销样式。 要求:1.图片宽度不能小于228像素,高度不能小于150像素、2.图片宽高比为1.52:1/只支持png/jpeg/jpg格式、3.图片不能大于2M Type int `json:"type,omitempty"` // UploadType 1: 通过文件上传;2: 通过图片url上传; UploadType int `json:"upload_type,omitempty"` // File 图片文件; upload_type为1时必填,详细要求见附录 File *model.UploadField `json:"file,omitempty"` // URL 图片url; upload_type为2时必填,详细要求见附录 URL string `json:"url,omitempty"` // Signature 图片md5值; 用于服务端校验,当 upload_type为1时必填 Signature string `json:"siganture,omitempty"` }
AdImageUploadRequestV2 上传图片v2接口 API Request
func (AdImageUploadRequestV2) Encode ¶
func (r AdImageUploadRequestV2) Encode() []model.UploadField
Encode implenent UploadRequest interface
func (AdImageUploadRequestV2) Url ¶
func (r AdImageUploadRequestV2) Url() string
Url implement UploadRequest interface
type AdVideoGetRequest ¶
type AdVideoGetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PhotoIDs 视频ID集 PhotoIDs []string `json:"photo_ids,omitempty"` }
AdVideoGetRequest 获取视频信息get接口 API Request
func (AdVideoGetRequest) Encode ¶
func (r AdVideoGetRequest) Encode() []byte
Encode implement PostRequest interface
func (AdVideoGetRequest) Url ¶
func (r AdVideoGetRequest) Url() string
Url implement PostRequest interface
type AdVideoListRequest ¶
type AdVideoListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PhotoIDs 视频 id列表,不超过 100 个 id PhotoIDs []string `json:"photo_ids,omitempty"` // NewStatus 视频状态s; 0:删除, -1:全部数据,包含删除 不传默认返回不含删除的数据 NewStatus *int `json:"new_status,omitempty"` // StartDate 开始时间; 与end_date同时传或同时不传; StartDate string `json:"start_date,omitempty"` // EndDate 结束时间 EndDate string `json:"end_date,omitempty"` // Page 请求的页码数 Page int `json:"page,omitempty"` // PageSize 每页行数 PageSize int `json:"page_size,omitempty"` }
AdVideoListRequest 查询视频接口list接口API Request
func (AdVideoListRequest) Encode ¶
func (r AdVideoListRequest) Encode() []byte
Encode implement PostRequest interface
func (AdVideoListRequest) Url ¶
func (r AdVideoListRequest) Url() string
Url implement PostRequest interface
type AdVideoListResponse ¶
type AdVideoListResponse struct { // TotalCount 图片总数 TotalCount int `json:"total_count,omitempty"` // Details 详情 Details []Video `json:"details,omitempty"` }
AdVideoListResponse 查询视频接口list接口 API Response
type AdVideoRelateCreativesRequest ¶
type AdVideoRelateCreativesRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PhotoIDs 视频id; 最大20个,可以动态配置 PhotoIds []string `json:"photo_ids,omitempty"` }
AdVideoRelateCreativesRequest 视频关联创意数查询
func (AdVideoRelateCreativesRequest) Encode ¶
func (r AdVideoRelateCreativesRequest) Encode() []byte
Encode implement PostRequest interface3
func (AdVideoRelateCreativesRequest) Url ¶
func (r AdVideoRelateCreativesRequest) Url() string
Url implement PostRequest interface
type AdVideoRelateCreativesResponse ¶
type AdVideoRelateCreativesResponse struct { // RelatedCreatives 与视频相关联的创意的信息; 关联创意数=审核中+投放中的创意,仅包含自定义创意,程序化创意数量暂未计入 RelatedCreatives []AdVideoRelatedCreatives `json:"related_creatives,omitempty"` }
AdVideoRelateCreativesResponse 视频关联创意数查询 API Response
type AdVideoRelatedCreative ¶
type AdVideoRelatedCreative struct { // CreativeID 创意id CreativeID uint64 `json:"creative_id,omitempty"` // CreativeName 创意名称 CreativeName string `json:"creative_name,omitempty"` }
AdVideoRelatedCreative
type AdVideoRelatedCreatives ¶
type AdVideoRelatedCreatives struct { // PhotoID 视频id PhotoID string `json:"photo_id,omitempty"` // Creatives 与视频关联的创意的信息 Creatives []AdVideoRelatedCreative `json:"creatives,omitempty"` // CreativeCount 与此视频id关联的创意总数 CreativeCount int64 `json:"creative_count,omitempty"` }
AdVideoRelatedCreatives 视频关联创意
type AdVideoShareDetail ¶
type AdVideoShareDetail struct { uint64 `json:"advertiser_id,omitempty"` PhotoID string `json:"photo_id,omitempty"` OriginalPhotoID string `json:"original_photo_id,omitempty"` }AdvertiserID
AdVideoShareDetail 视频库-推送视频 API Response Detail
type AdVideoShareRequest ¶
type AdVideoShareRequest struct { uint64 `json:"advertiser_id,omitempty"` PhotoIDs []string `json:"photo_ids,omitempty"` ShareAdvertiserIDs []uint64 `json:"share_advertiser_ids,omitempty"` }AdvertiserID
AdVideoShareRequest 视频库-推送视频 API Request
func (AdVideoShareRequest) Encode ¶
func (r AdVideoShareRequest) Encode() []byte
Encode implement PostRequest interface
func (AdVideoShareRequest) Url ¶
func (r AdVideoShareRequest) Url() string
Url implement PostRequest interface
type AdVideoShareResponse ¶
type AdVideoShareResponse struct { AdVideoShareDetail `json:"details,omitempty"` }Details []
AdVideoShareResponse 视频库-推送视频 API Response
type AdVideoTagDeleteRequest ¶
type AdVideoTagDeleteRequest struct { // AdvertiserID 广告主 id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PhotoIDs 视频 ids,不超过 10 个 PhotoIDs []string `json:"photo_ids,omitempty"` // PhotoTag 视频标签 单个标签长度不能超过 10,只支持一个标签 PhotoTag []string `json:"photo_tag,omitempty"` }
AdVideoTagDeleteRequest 视频库-删除视频标签 API Request
func (AdVideoTagDeleteRequest) Encode ¶
func (r AdVideoTagDeleteRequest) Encode() []byte
Encode implement PostRequest interface
func (AdVideoTagDeleteRequest) Url ¶
func (r AdVideoTagDeleteRequest) Url() string
Url implement PostRequest interface
type AdVideoUpdateRequest ¶
type AdVideoUpdateRequest struct { // AdvertiserID 广告主 id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PhotoIDs 视频 ids,不超过 100 个 PhotoIDs []string `json:"photo_ids,omitempty"` // PhotoName 视频名称; photo_name 和 photo_tags 填其一即可。photo_name长度不得超过100字符 PhotoName string `json:"photo_name,omitempty"` // PhotoTag 视频标签 单个标签长度不能超过 10,只支持一个标签 PhotoTag []string `json:"photo_tag,omitempty"` }
AdVideoUpdateRequest 视频库-批量更新视频功能 API Request
func (AdVideoUpdateRequest) Encode ¶
func (r AdVideoUpdateRequest) Encode() []byte
Encode implement PostRequest interface
func (AdVideoUpdateRequest) Url ¶
func (r AdVideoUpdateRequest) Url() string
Url implement PostRequest interface
type AdVideoUploadRequestV1 ¶
type AdVideoUploadRequestV1 struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // File 视频文件; 只支持mp4格式,详细要求见附录 File *model.UploadField `json:"file,omitempty"` // Type 上传视频类型; 0:发现页信息流视频,默认值 1:信息流竖版视频 2:信息流横版视频 3:后贴片竖版视频(已下线) 4:后贴片横版视频(已下线) Type int `json:"type"` // ShieldBackwardSwitch 上传视频后是否自动同步至快手个人主页; false表示后端屏蔽,视频不可profile页可见, true表示不屏蔽。 ShieldBackwardSwitch bool `json:"shield_backward_switch,omitempty"` }
AdVideoUploadRequestV1 上传视频v1接口 API Request
func (AdVideoUploadRequestV1) Encode ¶
func (r AdVideoUploadRequestV1) Encode() []model.UploadField
Encode implenent UploadRequest interface
func (AdVideoUploadRequestV1) Url ¶
func (r AdVideoUploadRequestV1) Url() string
Url implement UploadRequest interface
type AdVideoUploadRequestV2 ¶
type AdVideoUploadRequestV2 struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // File 视频文件; 只支持mp4格式,详细要求见附录 File *model.UploadField `json:"file,omitempty"` // Type 上传视频类型; 0:发现页信息流视频,默认值 1:信息流竖版视频 2:信息流横版视频 3:后贴片竖版视频(已下线) 4:后贴片横版视频(已下线) Type int `json:"type"` // Signature 视频md5值 Signature string `json:"signature,omitempty"` // PhotoName 视频名称,默认是视频 id; 不超过 50 字符,若不传默认为文件名称 PhotoName string `json:"photo_name,omitempty"` // PhotoTag 视频标签; 单个标签不超过 10 字符,支持一个标签 PhotoTag []string `json:"photo_tag,omitempty"` // Sync 用同步/异步方式上传视频; 0:(默认)以异步方式上传,不需要同步等待,上传较快。1:(选填)同步方式上传,上传较慢 Sync int `json:"sync,omitempty"` // ShieldBackwardSwitch 上传视频后是否自动同步至快手个人主页; false表示后端屏蔽,视频不可profile页可见, true表示不屏蔽。 ShieldBackwardSwitch bool `json:"shield_backward_switch,omitempty"` }
AdVideoUploadRequestV2 上传视频v2接口 API Request
func (AdVideoUploadRequestV2) Encode ¶
func (r AdVideoUploadRequestV2) Encode() []model.UploadField
Encode implenent UploadRequest interface
func (AdVideoUploadRequestV2) Url ¶
func (r AdVideoUploadRequestV2) Url() string
Url implement UploadRequest interface
type App ¶
type App struct { // AppID 应用ID AppID uint64 `json:"app_id,omitempty"` // URL 应用地址 URL string `json:"url,omitempty"` // AppVersion 应用标记 AppVersion string `json:"app_version,omitempty"` // AppName 应用名称 AppName string `json:"app_name,omitempty"` // AppIconUrl 应用图标链接 AppIconUrl string `json:"app_icon_url,omitempty"` // ImageToken 应用图标的image_token ImageToken string `json:"image_token,omitempty"` // PacakgeName 应用包名 PackageName string `json:"package_name,omitempty"` // Platform 应用类型 Platform int `json:"platform,omitempty"` // UpdateTime 更新时间; 单位:毫秒 UpdateTime int64 `json:"update_time,omitempty"` // UseSDK 是否接入快手广告监测SDK; 0:未接入,1:已接入 UseSDK int `json:"use_sdk,omitempty"` // AppPrivacyUrl app隐私政策链接,需与app相关,该字段会经过审核; 安卓类应用必填 AppPrivacyUrl string `json:"app_privacy_url,omitempty"` // ScanStatus 应用安全扫描状态; 1-扫描中,2-成功,3-失败,4-失败重试中 ScanStatus int `json:"scan_status,omitempty"` // PermissionInformation 权限信息,请通过应用权限信息列表接口获取信息 PermissionInformation []int `json:"permission_information,omitempty"` // RealAppVersion 真实版本号 RealAppVersion string `json:"real_app_version,omitempty"` // PackageSize 应用包大小 PackageSize int64 `json:"package_size,omitempty"` // AppDetailImageToken app应用详情图片 AppDetailImageToken string `json:"app_detail_image_token,omitempty"` }
App 应用
type Image ¶
type Image struct { // URL 图片预览地址 URL string `json:"url,omitempty"` // Width 图片宽度 Width int `json:"width,omitempty"` // Height 图片高度 Height int `json:"height,omitempty"` // Size 图片大小 Size int64 `json:"size,omitempty"` // Format 图片格式 Format string `json:"format,omitempty"` // Signature 图片MD5值 Signature string `json:"signature,omitempty"` // ImageToken 图片token 创建创意时使用 ImageToken string `json:"image_token,omitempty"` // PicId 图片库图片ID PicId string `json:"pic_id,omitempty"` }
Image 图片素材
type Video ¶
type Video struct { // PhotoID 视频ID PhotoID string `json:"photo_id,omitempty"` // Width 视频宽度 Width int `json:"width,omitempty"` // Height 视频高度 Height int `json:"height,omitempty"` // URL 视频预览链接 URL string `json:"url,omitempty"` // CoverUrl 视频首帧图片链接 CoverUrl string `json:"cover_url,omitempty"` // Signature 视频md5值 Signature string `json:"signature,omitempty"` // UploadTime 上传时间 UploadTime string `json:"upload_time,omitempty"` // PhotoName 视频名称 PhotoName string `json:"photo_name,omitempty"` // PhotoTag 视频标签 PhotoTag string `json:"photo_tag,omitempty"` // NewStatus 视频状态; 0:逻辑删除,1:正常 NewStatus int `json:"new_status,omitempty"` // Duration 视频时长; 单位毫秒 Duration int64 `json:"duration,omitempty"` // Source 视频来源; 0:自上传,1:开眼,2:素造,7:聚星视频 Source int `json:"source,omitempty"` }
Video 视频素材
Source Files ¶
- ad_app_create_request.go
- ad_app_list_request.go
- ad_app_list_response.go
- ad_app_update_request.go
- ad_image_get_request.go
- ad_image_list_request.go
- ad_image_list_response.go
- ad_image_upload_request_v1.go
- ad_image_upload_request_v2.go
- ad_video_get_request.go
- ad_video_list_request.go
- ad_video_list_response.go
- ad_video_relate_creatives_request.go
- ad_video_relate_creatives_response.go
- ad_video_share_request.go
- ad_video_share_response.go
- ad_video_tag_delete_request.go
- ad_video_update_request.go
- ad_video_upload_request_v1.go
- ad_video_upload_request_v2.go
- app.go
- doc.go
- image.go
- video.go