Documentation ¶
Overview ¶
Package creativeasset provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.15.0 DO NOT EDIT.
Index ¶
- func NewGetAssetRequest(server string, params *GetAssetParams) (*http.Request, error)
- func NewGetUploadLocationRequest(server string, params *GetUploadLocationParams, ...) (*http.Request, error)
- func NewGetUploadLocationRequestWithBody(server string, params *GetUploadLocationParams, contentType string, ...) (*http.Request, error)
- func NewRegisterAssetRequest(server string, params *RegisterAssetParams, body RegisterAssetJSONRequestBody) (*http.Request, error)
- func NewRegisterAssetRequestWithBody(server string, params *RegisterAssetParams, contentType string, body io.Reader) (*http.Request, error)
- func NewSearchAssetsRequest(server string, params *SearchAssetsParams, body SearchAssetsJSONRequestBody) (*http.Request, error)
- func NewSearchAssetsRequestWithBody(server string, params *SearchAssetsParams, contentType string, body io.Reader) (*http.Request, error)
- type CaAccounts
- type CaAdPolicyModerationResult
- type CaArgumentList
- type CaAsins
- type CaAsset
- type CaAssetFiles
- type CaAssetGlobal
- type CaAssetId
- type CaAssetIdentifier
- type CaAssetName
- type CaAssetSortCriteria
- type CaAssetSortCriteriaField
- type CaAssetSortCriteriaOrder
- type CaAssetStatus
- type CaAssetSubType
- type CaAssetType
- type CaAssetUploadLocation
- type CaAssetVersion
- type CaAssetVersionList
- type CaAssociatedContextTypeMapping
- type CaAssociatedProgram
- type CaAssociatedSubEntity
- type CaAssociatedSubEntityList
- type CaAudioStreamMetadata
- type CaBadRequest
- type CaFileMetadata
- type CaFileMetadataContentType
- type CaFileName
- type CaFilterCriteria
- type CaForbiddenRequest
- type CaInternalError
- type CaMarketplaceIds
- type CaMetadataMap
- type CaModerationContent
- type CaModerationContentStatus
- type CaModerationPolicyMap
- type CaModerationStatus
- type CaPageCriteria
- type CaPageIdentifier
- type CaPageSize
- type CaProcessedFile
- type CaProcessedFileMetadata
- type CaProcessedUrlType
- type CaProcessedUrlsMap
- type CaProgram
- type CaProgramSpecifications
- type CaProgramSpecificationsList
- type CaRange
- type CaRangeFilter
- type CaRegistrationContext
- type CaResourceNotFound
- type CaSearchAssetText
- type CaSearchRequestCommon
- type CaSpecCheckApprovedPrograms
- type CaSpecification
- type CaSpecificationList
- type CaSpecificationProgram
- type CaStorageLocationUrls
- type CaURL
- type CaUnauthorizedRequest
- type CaValueFilter
- type CaValueFilterValueField
- type CaValueRangeFilterOptions
- func (t CaValueRangeFilterOptions) AsDATEUPLOADED() (DATEUPLOADED, error)
- func (t CaValueRangeFilterOptions) AsSIZE() (SIZE, error)
- func (t *CaValueRangeFilterOptions) FromDATEUPLOADED(v DATEUPLOADED) error
- func (t *CaValueRangeFilterOptions) FromSIZE(v SIZE) error
- func (t CaValueRangeFilterOptions) MarshalJSON() ([]byte, error)
- func (t *CaValueRangeFilterOptions) MergeDATEUPLOADED(v DATEUPLOADED) error
- func (t *CaValueRangeFilterOptions) MergeSIZE(v SIZE) error
- func (t *CaValueRangeFilterOptions) UnmarshalJSON(b []byte) error
- type CaVersion
- type CaVersionInfo
- type CaVideoStreamMetadata
- type CaassetSubTypes
- type Client
- func (c *Client) GetAsset(ctx context.Context, params *GetAssetParams) (*http.Response, error)
- func (c *Client) GetUploadLocation(ctx context.Context, params *GetUploadLocationParams, ...) (*http.Response, error)
- func (c *Client) GetUploadLocationWithBody(ctx context.Context, params *GetUploadLocationParams, contentType string, ...) (*http.Response, error)
- func (c *Client) RegisterAsset(ctx context.Context, params *RegisterAssetParams, ...) (*http.Response, error)
- func (c *Client) RegisterAssetWithBody(ctx context.Context, params *RegisterAssetParams, contentType string, ...) (*http.Response, error)
- func (c *Client) SearchAssets(ctx context.Context, params *SearchAssetsParams, ...) (*http.Response, error)
- func (c *Client) SearchAssetsWithBody(ctx context.Context, params *SearchAssetsParams, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) GetAssetWithResponse(ctx context.Context, params *GetAssetParams) (*GetAssetResp, error)
- func (c *ClientWithResponses) GetUploadLocationWithBodyWithResponse(ctx context.Context, params *GetUploadLocationParams, contentType string, ...) (*GetUploadLocationResp, error)
- func (c *ClientWithResponses) GetUploadLocationWithResponse(ctx context.Context, params *GetUploadLocationParams, ...) (*GetUploadLocationResp, error)
- func (c *ClientWithResponses) RegisterAssetWithBodyWithResponse(ctx context.Context, params *RegisterAssetParams, contentType string, ...) (*RegisterAssetResp, error)
- func (c *ClientWithResponses) RegisterAssetWithResponse(ctx context.Context, params *RegisterAssetParams, ...) (*RegisterAssetResp, error)
- func (c *ClientWithResponses) SearchAssetsWithBodyWithResponse(ctx context.Context, params *SearchAssetsParams, contentType string, ...) (*SearchAssetsResp, error)
- func (c *ClientWithResponses) SearchAssetsWithResponse(ctx context.Context, params *SearchAssetsParams, ...) (*SearchAssetsResp, error)
- type ClientWithResponsesInterface
- type DATEUPLOADED
- type GetAssetParams
- type GetAssetResp
- type GetUploadLocationJSONBody
- type GetUploadLocationJSONRequestBody
- type GetUploadLocationParams
- type GetUploadLocationResp
- type HttpRequestDoer
- type RegisterAssetJSONBody
- type RegisterAssetJSONRequestBody
- type RegisterAssetParams
- type RegisterAssetResp
- type RequestEditorFn
- type ResponseEditorFn
- type SIZE
- type SearchAssetsJSONRequestBody
- type SearchAssetsParams
- type SearchAssetsResp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewGetAssetRequest ¶
func NewGetAssetRequest(server string, params *GetAssetParams) (*http.Request, error)
NewGetAssetRequest generates requests for GetAsset
func NewGetUploadLocationRequest ¶
func NewGetUploadLocationRequest(server string, params *GetUploadLocationParams, body GetUploadLocationJSONRequestBody) (*http.Request, error)
NewGetUploadLocationRequest calls the generic GetUploadLocation builder with application/json body
func NewGetUploadLocationRequestWithBody ¶
func NewGetUploadLocationRequestWithBody(server string, params *GetUploadLocationParams, contentType string, body io.Reader) (*http.Request, error)
NewGetUploadLocationRequestWithBody generates requests for GetUploadLocation with any type of body
func NewRegisterAssetRequest ¶
func NewRegisterAssetRequest(server string, params *RegisterAssetParams, body RegisterAssetJSONRequestBody) (*http.Request, error)
NewRegisterAssetRequest calls the generic RegisterAsset builder with application/json body
func NewRegisterAssetRequestWithBody ¶
func NewRegisterAssetRequestWithBody(server string, params *RegisterAssetParams, contentType string, body io.Reader) (*http.Request, error)
NewRegisterAssetRequestWithBody generates requests for RegisterAsset with any type of body
func NewSearchAssetsRequest ¶
func NewSearchAssetsRequest(server string, params *SearchAssetsParams, body SearchAssetsJSONRequestBody) (*http.Request, error)
NewSearchAssetsRequest calls the generic SearchAssets builder with application/json body
func NewSearchAssetsRequestWithBody ¶
func NewSearchAssetsRequestWithBody(server string, params *SearchAssetsParams, contentType string, body io.Reader) (*http.Request, error)
NewSearchAssetsRequestWithBody generates requests for SearchAssets with any type of body
Types ¶
type CaAccounts ¶
type CaAccounts = []string
CaAccounts The list of advertiser accounts the asset can be shared with. All the accounts within this list will be able to search this asset. Additional validation of checking that the accounts are associated will be done as part of this call.
type CaAdPolicyModerationResult ¶
type CaAdPolicyModerationResult struct { Locale *string `json:"locale,omitempty"` MarketplaceId *string `json:"marketplaceId,omitempty"` ModerationStatus *CaModerationStatus `json:"moderationStatus,omitempty"` PolicyName *string `json:"policyName,omitempty"` }
CaAdPolicyModerationResult defines model for caAdPolicyModerationResult.
type CaArgumentList ¶
type CaArgumentList = []string
CaArgumentList List of arguments for translation string
type CaAsins ¶
type CaAsins = []string
CaAsins Tagging assets with ASIN, promotes asset discoverability downstream. If ASIN is provided at the time of upload/during asset registration, it is applied as a tag on that asset. This allows for that asset to be searchable using that ASIN#. For e.g., An advertiser may want to search for assets tagged with ASIN BC10001, so they can create a store spotlight ad with product images for that ASIN.
type CaAsset ¶
type CaAsset struct { AssetId *string `json:"assetId,omitempty"` AssetSubTypes *[]CaAssetSubType `json:"assetSubTypes,omitempty"` // AssetType The asset type you are registering [`IMAGE`, `VIDEO`] AssetType *CaAssetType `json:"assetType,omitempty"` AssociatedAccountIds *[]string `json:"associatedAccountIds,omitempty"` // AssociatedContexts A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0 AssociatedContexts *CaAssociatedContextTypeMapping `json:"associatedContexts,omitempty"` Collections *[]string `json:"collections,omitempty"` CreatedBy *string `json:"createdBy,omitempty"` CreationTime *int64 `json:"creationTime,omitempty"` FileMetadata *CaFileMetadata `json:"fileMetadata,omitempty"` LastUpdatedBy *string `json:"lastUpdatedBy,omitempty"` LastUpdatedTime *int64 `json:"lastUpdatedTime,omitempty"` Marketplaces *[]string `json:"marketplaces,omitempty"` // ModerationPolicyMap A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0 ModerationPolicyMap *CaModerationPolicyMap `json:"moderationPolicyMap,omitempty"` Name *string `json:"name,omitempty"` // SpecCheckApprovedPrograms List of spec programs for which asset spec check is approved SpecCheckApprovedPrograms *CaSpecCheckApprovedPrograms `json:"specCheckApprovedPrograms,omitempty"` Status *CaAssetStatus `json:"status,omitempty"` StorageLocationUrls *CaStorageLocationUrls `json:"storageLocationUrls,omitempty"` Tags *[]string `json:"tags,omitempty"` Version *string `json:"version,omitempty"` }
CaAsset defines model for caAsset.
type CaAssetFiles ¶
type CaAssetFiles struct { DefaultUrl *string `json:"defaultUrl,omitempty"` ProcessedFiles *[]CaProcessedFile `json:"processedFiles,omitempty"` }
CaAssetFiles Structure containing processed transcode files for an asset
defaultUrl: This is the location of the original source. processedFiles: List of processed files with metadata.
type CaAssetGlobal ¶
type CaAssetGlobal struct { // AccountIds The list of advertiser accounts the asset can be shared with. All the accounts within this list will be able to search this asset. Additional validation of checking that the accounts are associated will be done as part of this call. AccountIds *CaAccounts `json:"accountIds,omitempty"` // AssetId The asset identifier. AssetId *CaAssetId `json:"assetId,omitempty"` // AssetType The asset type you are registering [`IMAGE`, `VIDEO`] AssetType *CaAssetType `json:"assetType,omitempty"` // MarketplaceId The list of marketplace Ids. MarketplaceId *CaMarketplaceIds `json:"marketplaceId,omitempty"` }
CaAssetGlobal defines model for caAssetGlobal.
type CaAssetIdentifier ¶
type CaAssetIdentifier struct { // AssetId The asset identifier. AssetId *CaAssetId `json:"assetId,omitempty"` // Version The version of the asset. Version *CaVersion `json:"version,omitempty"` }
CaAssetIdentifier defines model for caAssetIdentifier.
type CaAssetName ¶
type CaAssetName = string
CaAssetName The name to be given to the asset being registered.
type CaAssetSortCriteria ¶
type CaAssetSortCriteria struct { Field *CaAssetSortCriteriaField `json:"field,omitempty"` Order *CaAssetSortCriteriaOrder `json:"order,omitempty"` }
CaAssetSortCriteria defines model for caAssetSortCriteria.
type CaAssetSortCriteriaField ¶
type CaAssetSortCriteriaField string
CaAssetSortCriteriaField defines model for CaAssetSortCriteria.Field.
const ( CaAssetSortCriteriaFieldCREATEDTIME CaAssetSortCriteriaField = "CREATED_TIME" CaAssetSortCriteriaFieldEXTENSION CaAssetSortCriteriaField = "EXTENSION" CaAssetSortCriteriaFieldIMAGEHEIGHT CaAssetSortCriteriaField = "IMAGE_HEIGHT" CaAssetSortCriteriaFieldIMAGEWIDTH CaAssetSortCriteriaField = "IMAGE_WIDTH" CaAssetSortCriteriaFieldNAME CaAssetSortCriteriaField = "NAME" CaAssetSortCriteriaFieldSIZE CaAssetSortCriteriaField = "SIZE" )
Defines values for CaAssetSortCriteriaField.
type CaAssetSortCriteriaOrder ¶
type CaAssetSortCriteriaOrder string
CaAssetSortCriteriaOrder defines model for CaAssetSortCriteria.Order.
const ( ASC CaAssetSortCriteriaOrder = "ASC" DESC CaAssetSortCriteriaOrder = "DESC" )
Defines values for CaAssetSortCriteriaOrder.
type CaAssetStatus ¶
type CaAssetStatus string
CaAssetStatus defines model for caAssetStatus.
const ( ACTIVE CaAssetStatus = "ACTIVE" ARCHIVED CaAssetStatus = "ARCHIVED" PROCESSING CaAssetStatus = "PROCESSING" )
Defines values for CaAssetStatus.
type CaAssetSubType ¶
type CaAssetSubType string
CaAssetSubType 1. For assetType `IMAGE` acceptable assetSubTypes are `LOGO`, `PRODUCT_IMAGE`, `AUTHOR_IMAGE`, `LIFESTYLE_IMAGE`, `OTHER_IMAGE` 2. For assetType `VIDEO` acceptable assetSubtype is `BACKGROUND_VIDEO`.
const ( AUTHORIMAGE CaAssetSubType = "AUTHOR_IMAGE" BACKGROUNDVIDEO CaAssetSubType = "BACKGROUND_VIDEO" LIFESTYLEIMAGE CaAssetSubType = "LIFESTYLE_IMAGE" LOGO CaAssetSubType = "LOGO" OTHERIMAGE CaAssetSubType = "OTHER_IMAGE" PRODUCTIMAGE CaAssetSubType = "PRODUCT_IMAGE" )
Defines values for CaAssetSubType.
type CaAssetType ¶
type CaAssetType string
CaAssetType The asset type you are registering [`IMAGE`, `VIDEO`]
const ( IMAGE CaAssetType = "IMAGE" VIDEO CaAssetType = "VIDEO" )
Defines values for CaAssetType.
type CaAssetUploadLocation ¶
type CaAssetUploadLocation = string
CaAssetUploadLocation The url to upload the asset. The url expires in 15 minutes.
type CaAssetVersion ¶
type CaAssetVersion struct { // AssetFiles Structure containing processed transcode files for an asset // defaultUrl: This is the location of the original source. // processedFiles: List of processed files with metadata. AssetFiles *CaAssetFiles `json:"assetFiles,omitempty"` AssetIdentifier *CaAssetIdentifier `json:"assetIdentifier,omitempty"` AssetStatus *CaAssetStatus `json:"assetStatus,omitempty"` AssetSubTypes *CaassetSubTypes `json:"assetSubTypes,omitempty"` CreatedBy *string `json:"createdBy,omitempty"` CreationTime *int64 `json:"creationTime,omitempty"` // FailedSpecChecks Specification Checks for all programs FailedSpecChecks *CaProgramSpecificationsList `json:"failedSpecChecks,omitempty"` FileMetadata *CaFileMetadata `json:"fileMetadata,omitempty"` LastUpdatedBy *string `json:"lastUpdatedBy,omitempty"` LastUpdatedTime *int64 `json:"lastUpdatedTime,omitempty"` ModerationContentList *[]CaModerationContent `json:"moderationContentList,omitempty"` // Name The fileName of the asset. Name *CaFileName `json:"name,omitempty"` // OtherMetadata Include key-value pairs related to the asset. For DSP use "dspAdvertiserId" = "ID". Include program as AMAZON_DSP. OtherMetadata *CaMetadataMap `json:"otherMetadata,omitempty"` // SpecCheckApprovedPrograms List of spec programs for which asset spec check is approved SpecCheckApprovedPrograms *CaSpecCheckApprovedPrograms `json:"specCheckApprovedPrograms,omitempty"` StorageLocationUrls *CaStorageLocationUrls `json:"storageLocationUrls,omitempty"` // Url The URL of the asset. Url *CaURL `json:"url,omitempty"` // VersionNotes The URL of the asset VersionNotes *string `json:"versionNotes,omitempty"` }
CaAssetVersion defines model for caAssetVersion.
type CaAssetVersionList ¶
type CaAssetVersionList = []CaAssetVersion
CaAssetVersionList The asset version list.
type CaAssociatedContextTypeMapping ¶
type CaAssociatedContextTypeMapping = map[string]interface{}
CaAssociatedContextTypeMapping A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0
type CaAssociatedProgram ¶
type CaAssociatedProgram struct { // Metadata Include key-value pairs related to the asset. For DSP use "dspAdvertiserId" = "ID". Include program as AMAZON_DSP. Metadata *CaMetadataMap `json:"metadata,omitempty"` // ProgramName Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser. ProgramName *CaProgram `json:"programName,omitempty"` }
CaAssociatedProgram defines model for caAssociatedProgram.
type CaAssociatedSubEntity ¶
type CaAssociatedSubEntity struct { // BrandEntityId The entity id of brand, which can be retrieved using GET /brands. BrandEntityId *string `json:"brandEntityId,omitempty"` }
CaAssociatedSubEntity defines model for caAssociatedSubEntity.
type CaAssociatedSubEntityList ¶
type CaAssociatedSubEntityList = []CaAssociatedSubEntity
CaAssociatedSubEntityList This field is required for sellers, but not required for vendors. The brandEntityId is required for sellers uploading assets for use in Sponsored Brands. As a best practice, ensure to include brandEntityId when uploading assets for sellers.
type CaAudioStreamMetadata ¶
type CaAudioStreamMetadata struct { BitRate *int64 `json:"bitRate,omitempty"` ChannelLayout *string `json:"channelLayout,omitempty"` CodecName *string `json:"codecName,omitempty"` CodecType *string `json:"codecType,omitempty"` Duration *float64 `json:"duration,omitempty"` Profile *string `json:"profile,omitempty"` SampleRate *int64 `json:"sampleRate,omitempty"` }
CaAudioStreamMetadata Structure containing metadata of Video Stream.
profile: This is the profile of the stream. duration: This is the duration of the stream in secs. codecName: This tells the codec of the media stream. codecType: This is the codec type of stream. bitRate: This tells the bit rate of the stream. channelLayout: This tells the channel of the stream sampleRate: This is the sample rate of the stream
type CaBadRequest ¶
type CaBadRequest struct {
Message *string `json:"message,omitempty"`
}
CaBadRequest 400 bad request
type CaFileMetadata ¶
type CaFileMetadata struct { // AspectRatio The aspect ration of the asset. AspectRatio *string `json:"aspectRatio,omitempty"` AudioSampleRate *float64 `json:"audioSampleRate,omitempty"` // ContentType The content type of the asset. ContentType *CaFileMetadataContentType `json:"contentType,omitempty"` Duration *float64 `json:"duration,omitempty"` // Extension The extension of the file name. Extension *string `json:"extension,omitempty"` // FileSize The asset size in bytes. FileSize *float32 `json:"fileSize,omitempty"` // Height The height of the asset in pixels. Height *float32 `json:"height,omitempty"` ResolutionHeight *int `json:"resolutionHeight,omitempty"` ResolutionWidth *int `json:"resolutionWidth,omitempty"` // Width The width of the asset in pixels. Width *float32 `json:"width,omitempty"` }
CaFileMetadata defines model for caFileMetadata.
type CaFileMetadataContentType ¶
type CaFileMetadataContentType string
CaFileMetadataContentType The content type of the asset.
const ( Imagejpeg CaFileMetadataContentType = "image/jpeg" Imagejpg CaFileMetadataContentType = "image/jpg" Imagepng CaFileMetadataContentType = "image/png" Jpeg CaFileMetadataContentType = "jpeg" Jpg CaFileMetadataContentType = "jpg" Mp4 CaFileMetadataContentType = "mp4" Png CaFileMetadataContentType = "png" )
Defines values for CaFileMetadataContentType.
type CaFilterCriteria ¶
type CaFilterCriteria struct { RangeFilters *[]CaRangeFilter `json:"rangeFilters,omitempty"` ValueFilters *[]CaValueFilter `json:"valueFilters,omitempty"` }
CaFilterCriteria **Optional** this is used to filter results, we support two types of filters, valueFilter and rangeFilter
type CaForbiddenRequest ¶
type CaForbiddenRequest struct {
Message *string `json:"message,omitempty"`
}
CaForbiddenRequest 403 forbidden request
type CaInternalError ¶
type CaInternalError struct {
Message *string `json:"message,omitempty"`
}
CaInternalError 500 internal server error
type CaMarketplaceIds ¶
type CaMarketplaceIds = []string
CaMarketplaceIds The list of marketplace Ids.
type CaMetadataMap ¶
CaMetadataMap Include key-value pairs related to the asset. For DSP use "dspAdvertiserId" = "ID". Include program as AMAZON_DSP.
type CaModerationContent ¶
type CaModerationContent struct { AdPolicyModerationResultList *[]CaAdPolicyModerationResult `json:"adPolicyModerationResultList,omitempty"` // AssetSubType 1. For assetType `IMAGE` acceptable assetSubTypes are `LOGO`, `PRODUCT_IMAGE`, `AUTHOR_IMAGE`, `LIFESTYLE_IMAGE`, `OTHER_IMAGE` // 2. For assetType `VIDEO` acceptable assetSubtype is `BACKGROUND_VIDEO`. AssetSubType *CaAssetSubType `json:"assetSubType,omitempty"` ModerationContentStatus *CaModerationContentStatus `json:"moderationContentStatus,omitempty"` }
CaModerationContent defines model for caModerationContent.
type CaModerationContentStatus ¶
type CaModerationContentStatus string
CaModerationContentStatus defines model for caModerationContentStatus.
const ( COMPLETED CaModerationContentStatus = "COMPLETED" FAILED CaModerationContentStatus = "FAILED" INPROGRESS CaModerationContentStatus = "IN_PROGRESS" )
Defines values for CaModerationContentStatus.
type CaModerationPolicyMap ¶
type CaModerationPolicyMap = map[string]interface{}
CaModerationPolicyMap A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0
type CaModerationStatus ¶
type CaModerationStatus string
CaModerationStatus defines model for caModerationStatus.
const ( APPROVED CaModerationStatus = "APPROVED" PENDING CaModerationStatus = "PENDING" REJECTED CaModerationStatus = "REJECTED" )
Defines values for CaModerationStatus.
type CaPageCriteria ¶
type CaPageCriteria struct { Identifier *CaPageIdentifier `json:"identifier,omitempty"` Size *CaPageSize `json:"size,omitempty"` }
CaPageCriteria used for pagination
when searching for the first page, no need to put anything, otherwise, use the token returned from previous search call
type CaPageIdentifier ¶
type CaPageIdentifier struct { PageNumber *int `json:"pageNumber,omitempty"` Token *string `json:"token,omitempty"` }
CaPageIdentifier defines model for caPageIdentifier.
type CaProcessedFile ¶
type CaProcessedFile struct { // FileMetadata Structure containing metadata of processed file. // contentHash: This is the location of the original source. // contentType: This is the location of the original source. // videoStreams: This contains the metadata of Video streams. // audioStreams: This contains the metadata of Audio streams. FileMetadata *CaProcessedFileMetadata `json:"fileMetadata,omitempty"` // Profile Enum containing different type of processed urls // 1. `MODERATION`: This is an internal url that will be used to moderate the asset. // 2. `IMAGE_THUMBNAIL_500`: This is the url for image asset type to support thumbnail rendering of max side 500px. // 3. `VIDEO_DEFAULT_OPTIMIZED`: This is the default processed url for video asset type for optimized rendering. // 4. `PRODUCT_VIDEO_OPTIMIZED`: This is the processed url for video that can be used for product. // 5. `BACKGROUND_VIDEO_TILE`: This is the processed url for video that can be used for background video tile. // 6. `VIDEO_TILE`: This is the processed url for video that can be used for video tile. // 7. `INTRO_SPLASH`: This is the processed url for video that can be used for intro splash. // 8. `MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 260KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 64KBS audio bit rate, 180p height and generated with codec profile H.264/ Baseline. // 9. `MP4_300KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. // 10. `MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. // 11. `MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 320KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High. // 12. `MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 375KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 360p height and generated with codec profile H.264/ High. // 13. `MP4_450KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. // 14. `MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. // 15. `MP4_600KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. // 16. `MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline. // 17. `MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. // 18. `MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. // 19. `MP4_700KBS_24FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 700KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. // 20. `MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 432p height and generated with codec profile H.264/ High. // 21. `MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High. // 22. `MP4_900KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. // 23. `MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline. // 24. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 1350KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. // 25. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High. // 26. `MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 540p height and generated with codec profile H.264/ Main. // 27. `MP4_1500KBS_24FPS_48KHZ_96KBS_576P`: This is the processed url for video that can be used with mp4 container, 1500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 576p height. // 28. `MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 540p height and generated with codec profile H.264/ High. // 29. `MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 576p height and generated with codec profile H.264/ High. // 30. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 2000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. // 31. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High. // 32. `MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 720p height and generated with codec profile H.264/ High. // 33. `MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 576p height and generated with codec profile H.264/ High. // 34. `MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 480p height and generated with codec profile H.264/ Main. // 35. `MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. // 36. `MP4_3500KBS_24FPS_48KHZ_96KBS_1080P`: This is the processed url for video that can be used with mp4 container, 3500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 1080p height. // 37. `MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 720p height and generated with codec profile H.264/ High. // 38. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P`: This is the processed url for video that can be used with mp4 container, 4000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate and 1080p height. // 39. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. // 40. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P`: This is the processed url for video that can be used with mp4 container, 10000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate and 1080p height. // 41. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 10MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. // 42. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS`: This is the processed url for video that can be used with mp4 container, 20000KBS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate. // 43. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 20MBPS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. // 44. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. // 45. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ Main. Profile *CaProcessedUrlType `json:"profile,omitempty"` Programs *[]CaProgram `json:"programs,omitempty"` Url *string `json:"url,omitempty"` }
CaProcessedFile Structure containing url, program, profile and metadata of processed output
program: This is the program for which this transcoding is done. profile: This is the profile/outformat of the processed file. url: This is the location of the processed file. fileMetadata: This contains the metadata of file.
type CaProcessedFileMetadata ¶
type CaProcessedFileMetadata struct { AudioStreams *[]CaAudioStreamMetadata `json:"audioStreams,omitempty"` ContentHash *string `json:"contentHash,omitempty"` ContentType *string `json:"contentType,omitempty"` VideoStreams *[]CaVideoStreamMetadata `json:"videoStreams,omitempty"` }
CaProcessedFileMetadata Structure containing metadata of processed file.
contentHash: This is the location of the original source. contentType: This is the location of the original source. videoStreams: This contains the metadata of Video streams. audioStreams: This contains the metadata of Audio streams.
type CaProcessedUrlType ¶
type CaProcessedUrlType string
CaProcessedUrlType Enum containing different type of processed urls 1. `MODERATION`: This is an internal url that will be used to moderate the asset. 2. `IMAGE_THUMBNAIL_500`: This is the url for image asset type to support thumbnail rendering of max side 500px. 3. `VIDEO_DEFAULT_OPTIMIZED`: This is the default processed url for video asset type for optimized rendering. 4. `PRODUCT_VIDEO_OPTIMIZED`: This is the processed url for video that can be used for product. 5. `BACKGROUND_VIDEO_TILE`: This is the processed url for video that can be used for background video tile. 6. `VIDEO_TILE`: This is the processed url for video that can be used for video tile. 7. `INTRO_SPLASH`: This is the processed url for video that can be used for intro splash. 8. `MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 260KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 64KBS audio bit rate, 180p height and generated with codec profile H.264/ Baseline. 9. `MP4_300KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. 10. `MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. 11. `MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 320KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High. 12. `MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 375KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 360p height and generated with codec profile H.264/ High. 13. `MP4_450KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. 14. `MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. 15. `MP4_600KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. 16. `MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline. 17. `MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. 18. `MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline. 19. `MP4_700KBS_24FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 700KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. 20. `MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 432p height and generated with codec profile H.264/ High. 21. `MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High. 22. `MP4_900KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. 23. `MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline. 24. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 1350KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. 25. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High. 26. `MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 540p height and generated with codec profile H.264/ Main. 27. `MP4_1500KBS_24FPS_48KHZ_96KBS_576P`: This is the processed url for video that can be used with mp4 container, 1500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 576p height. 28. `MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 540p height and generated with codec profile H.264/ High. 29. `MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 576p height and generated with codec profile H.264/ High. 30. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 2000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. 31. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High. 32. `MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 720p height and generated with codec profile H.264/ High. 33. `MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 576p height and generated with codec profile H.264/ High. 34. `MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 480p height and generated with codec profile H.264/ Main. 35. `MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. 36. `MP4_3500KBS_24FPS_48KHZ_96KBS_1080P`: This is the processed url for video that can be used with mp4 container, 3500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 1080p height. 37. `MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 720p height and generated with codec profile H.264/ High. 38. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P`: This is the processed url for video that can be used with mp4 container, 4000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate and 1080p height. 39. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. 40. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P`: This is the processed url for video that can be used with mp4 container, 10000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate and 1080p height. 41. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 10MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. 42. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS`: This is the processed url for video that can be used with mp4 container, 20000KBS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate. 43. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 20MBPS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. 44. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High. 45. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ Main.
const ( BACKGROUNDVIDEOTILE CaProcessedUrlType = "BACKGROUND_VIDEO_TILE" IMAGETHUMBNAIL500 CaProcessedUrlType = "IMAGE_THUMBNAIL_500" INTROSPLASH CaProcessedUrlType = "INTRO_SPLASH" MODERATION CaProcessedUrlType = "MODERATION" MP410000KBS30FPS48KHZ320KBS1080P CaProcessedUrlType = "MP4_10000KBS_30FPS_48KHZ_320KBS_1080P" MP410000KBS30FPS48KHZ320KBS1080PH264HIGH CaProcessedUrlType = "MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH" MP41350KBS25FPS48KHZ128KBS540PH264MAIN CaProcessedUrlType = "MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN" MP41350KBS30FPS48KHZ96KBS720P CaProcessedUrlType = "MP4_1350KBS_30FPS_48KHZ_96KBS_720P" MP41350KBS30FPS48KHZ96KBS720PH264HIGH CaProcessedUrlType = "MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH" MP41500KBS24FPS48KHZ96KBS576P CaProcessedUrlType = "MP4_1500KBS_24FPS_48KHZ_96KBS_576P" MP41500KBS25FPS48KHZ128KBS576PH264HIGH CaProcessedUrlType = "MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH" MP41500KBS30FPS48KHZ192KBS540PH264HIGH CaProcessedUrlType = "MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH" MP420000KBSAUTOFPS48KHZ320KBS CaProcessedUrlType = "MP4_20000KBS_AUTOFPS_48KHZ_320KBS" MP420000KBSAUTOFPS48KHZ320KBS1080PH264HIGH CaProcessedUrlType = "MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH" MP42000KBS30FPS48KHZ192KBS720PH264HIGH CaProcessedUrlType = "MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH" MP42000KBS30FPS48KHZ96KBS720P CaProcessedUrlType = "MP4_2000KBS_30FPS_48KHZ_96KBS_720P" MP42000KBS30FPS48KHZ96KBS720PH264HIGH CaProcessedUrlType = "MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH" MP42100KBS30FPS48KHZ192KBS480PH264MAIN CaProcessedUrlType = "MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN" MP42100KBS30FPS48KHZ192KBS576PH264HIGH CaProcessedUrlType = "MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH" MP425000KBS30FPS48KHZ192KBS1080PH264HIGH CaProcessedUrlType = "MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH" MP425000KBS30FPS48KHZ192KBS1080PH264MAIN CaProcessedUrlType = "MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN" MP4260KBS25FPS48KHZ64KBS180PH264BASELINE CaProcessedUrlType = "MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE" MP4300KBS15FPS48KHZ96KBS360P CaProcessedUrlType = "MP4_300KBS_15FPS_48KHZ_96KBS_360P" MP4300KBS30FPS48KHZ96KBS360PH264BASELINE CaProcessedUrlType = "MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE" MP4320KBS25FPS48KHZ96KBS576PH264HIGH CaProcessedUrlType = "MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH" MP43400KBS30FPS48KHZ192KBS1080PH264HIGH CaProcessedUrlType = "MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH" MP43500KBS24FPS48KHZ96KBS1080P CaProcessedUrlType = "MP4_3500KBS_24FPS_48KHZ_96KBS_1080P" MP43500KBS30FPS48KHZ128KBS720PH264HIGH CaProcessedUrlType = "MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH" MP4375KBS30FPS48KHZ192KBS360PH264HIGH CaProcessedUrlType = "MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH" MP44000KBS30FPS48KHZ192KBS1080P CaProcessedUrlType = "MP4_4000KBS_30FPS_48KHZ_192KBS_1080P" MP44000KBS30FPS48KHZ192KBS1080PH264HIGH CaProcessedUrlType = "MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH" MP4450KBS15FPS48KHZ96KBS360P CaProcessedUrlType = "MP4_450KBS_15FPS_48KHZ_96KBS_360P" MP4450KBS30FPS48KHZ96KBS360PH264BASELINE CaProcessedUrlType = "MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE" MP4600KBS15FPS48KHZ96KBS480P CaProcessedUrlType = "MP4_600KBS_15FPS_48KHZ_96KBS_480P" MP4600KBS25FPS48KHZ128KBS360PH264BASELINE CaProcessedUrlType = "MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE" MP4600KBS30FPS48KHZ128KBS360PH264BASELINE CaProcessedUrlType = "MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE" MP4600KBS30FPS48KHZ96KBS480PH264BASELINE CaProcessedUrlType = "MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE" MP4700KBS24FPS48KHZ96KBS360P CaProcessedUrlType = "MP4_700KBS_24FPS_48KHZ_96KBS_360P" MP4750KBS25FPS48KHZ96KBS576PH264HIGH CaProcessedUrlType = "MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH" MP4750KBS30FPS48KHZ192KBS432PH264HIGH CaProcessedUrlType = "MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH" MP4900KBS15FPS48KHZ96KBS480P CaProcessedUrlType = "MP4_900KBS_15FPS_48KHZ_96KBS_480P" MP4900KBS30FPS48KHZ96KBS480PH264BASELINE CaProcessedUrlType = "MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE" PRODUCTVIDEOOPTIMIZED CaProcessedUrlType = "PRODUCT_VIDEO_OPTIMIZED" VIDEODEFAULTOPTIMIZED CaProcessedUrlType = "VIDEO_DEFAULT_OPTIMIZED" VIDEOTILE CaProcessedUrlType = "VIDEO_TILE" )
Defines values for CaProcessedUrlType.
type CaProcessedUrlsMap ¶
CaProcessedUrlsMap Map containing processed urls of the asset. Key is the processed type and value is the url
type CaProgram ¶
type CaProgram string
CaProgram Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.
const (
AMAZONDSP CaProgram = "AMAZON_DSP"
)
Defines values for CaProgram.
type CaProgramSpecifications ¶
type CaProgramSpecifications struct { SpecProgramName *CaSpecificationProgram `json:"specProgramName,omitempty"` // Specifications List of specifications Specifications *CaSpecificationList `json:"specifications,omitempty"` }
CaProgramSpecifications Specification Check for program, This contains program name and specifications
type CaProgramSpecificationsList ¶
type CaProgramSpecificationsList = []CaProgramSpecifications
CaProgramSpecificationsList Specification Checks for all programs
type CaRangeFilter ¶
type CaRangeFilter struct { Range *[]CaRange `json:"range,omitempty"` RangeField *CaValueRangeFilterOptions `json:"rangeField,omitempty"` }
CaRangeFilter Filter assets which have certain ranges of asset attributes.
For example, filter assets which have file size in the range of [10,20] or [40,50].
type CaRegistrationContext ¶
type CaRegistrationContext struct {
AssociatedPrograms *[]CaAssociatedProgram `json:"associatedPrograms,omitempty"`
}
CaRegistrationContext This is used on registration of an asset, to associate DSP assets to a specific advertiser. This is **required** for assets being uploaded for use in DSP.
type CaResourceNotFound ¶
type CaResourceNotFound struct {
Message *string `json:"message,omitempty"`
}
CaResourceNotFound 404 requested resource not found
type CaSearchAssetText ¶
type CaSearchAssetText = string
CaSearchAssetText The text used for searching assets, it matches asset name, asset name prefix, tags and ASINs associated with the assets
type CaSearchRequestCommon ¶
type CaSearchRequestCommon struct { // FilterCriteria **Optional** this is used to filter results, we support two types of filters, valueFilter and rangeFilter FilterCriteria *CaFilterCriteria `json:"filterCriteria,omitempty"` // PageCriteria used for pagination // // when searching for the first page, no need to put anything, otherwise, use the token returned from previous search call PageCriteria *CaPageCriteria `json:"pageCriteria,omitempty"` SortCriteria *CaAssetSortCriteria `json:"sortCriteria,omitempty"` // Text The text used for searching assets, it matches asset name, asset name prefix, tags and ASINs associated with the assets Text *CaSearchAssetText `json:"text,omitempty"` }
CaSearchRequestCommon defines model for caSearchRequestCommon.
type CaSpecCheckApprovedPrograms ¶
type CaSpecCheckApprovedPrograms = []CaSpecificationProgram
CaSpecCheckApprovedPrograms List of spec programs for which asset spec check is approved
type CaSpecification ¶
type CaSpecification struct { ActualValue *string `json:"actualValue,omitempty"` // Arguments List of arguments for translation string Arguments *CaArgumentList `json:"arguments,omitempty"` FailureReason *string `json:"failureReason,omitempty"` IsPassed *bool `json:"isPassed,omitempty"` StringId *string `json:"stringId,omitempty"` }
CaSpecification Structure containing specification
stringId: This is the translated string Id, client will be retrieving the translation corresponding to this string. failureReason: This specifies the failure reason of specification. arguments: Arguments required for translation string. isPassed: Whether spec got passed or failed. actualValue: If spec got failed then this attribute represent the actual value of the spec parameter in the file.
type CaSpecificationList ¶
type CaSpecificationList = []CaSpecification
CaSpecificationList List of specifications
type CaSpecificationProgram ¶
type CaSpecificationProgram string
CaSpecificationProgram defines model for caSpecificationProgram.
const ( DEMANDSIDEPLATFORMOLV CaSpecificationProgram = "DEMAND_SIDE_PLATFORM_OLV" DEMANDSIDEPLATFORMOTT CaSpecificationProgram = "DEMAND_SIDE_PLATFORM_OTT" SPONSOREDBRANDSVIDEO CaSpecificationProgram = "SPONSORED_BRANDS_VIDEO" SPONSOREDDISPLAYVIDEO CaSpecificationProgram = "SPONSORED_DISPLAY_VIDEO" STORESBACKGROUNDVIDEOTILE CaSpecificationProgram = "STORES_BACKGROUND_VIDEO_TILE" STORESINTROSPLASH CaSpecificationProgram = "STORES_INTRO_SPLASH" STORESVIDEOTILE CaSpecificationProgram = "STORES_VIDEO_TILE" )
Defines values for CaSpecificationProgram.
type CaStorageLocationUrls ¶
type CaStorageLocationUrls struct { DefaultUrl *string `json:"defaultUrl,omitempty"` // ProcessedUrls Map containing processed urls of the asset. Key is the processed type and value is the url ProcessedUrls *CaProcessedUrlsMap `json:"processedUrls,omitempty"` }
CaStorageLocationUrls defines model for caStorageLocationUrls.
type CaUnauthorizedRequest ¶
type CaUnauthorizedRequest struct {
}CaUnauthorizedRequest 401 unauthorized request
type CaValueFilter ¶
type CaValueFilter struct { ValueField *CaValueFilterValueField `json:"valueField,omitempty"` Values *[]string `json:"values,omitempty"` }
CaValueFilter Filter for certain values of asset attributes
type CaValueFilterValueField ¶
type CaValueFilterValueField string
CaValueFilterValueField defines model for CaValueFilter.ValueField.
const ( APPROVEDADPOLICY CaValueFilterValueField = "APPROVED_AD_POLICY" ASIN CaValueFilterValueField = "ASIN" ASSETEXTENSION CaValueFilterValueField = "ASSET_EXTENSION" ASSETSUBTYPE CaValueFilterValueField = "ASSET_SUB_TYPE" ASSETTYPE CaValueFilterValueField = "ASSET_TYPE" CAMPAIGNID CaValueFilterValueField = "CAMPAIGN_ID" CAMPAIGNNAME CaValueFilterValueField = "CAMPAIGN_NAME" PROGRAM CaValueFilterValueField = "PROGRAM" TAG CaValueFilterValueField = "TAG" )
Defines values for CaValueFilterValueField.
type CaValueRangeFilterOptions ¶
type CaValueRangeFilterOptions struct {
// contains filtered or unexported fields
}
CaValueRangeFilterOptions defines model for caValueRangeFilterOptions.
func (CaValueRangeFilterOptions) AsDATEUPLOADED ¶
func (t CaValueRangeFilterOptions) AsDATEUPLOADED() (DATEUPLOADED, error)
AsDATEUPLOADED returns the union data inside the CaValueRangeFilterOptions as a DATEUPLOADED
func (CaValueRangeFilterOptions) AsSIZE ¶
func (t CaValueRangeFilterOptions) AsSIZE() (SIZE, error)
AsSIZE returns the union data inside the CaValueRangeFilterOptions as a SIZE
func (*CaValueRangeFilterOptions) FromDATEUPLOADED ¶
func (t *CaValueRangeFilterOptions) FromDATEUPLOADED(v DATEUPLOADED) error
FromDATEUPLOADED overwrites any union data inside the CaValueRangeFilterOptions as the provided DATEUPLOADED
func (*CaValueRangeFilterOptions) FromSIZE ¶
func (t *CaValueRangeFilterOptions) FromSIZE(v SIZE) error
FromSIZE overwrites any union data inside the CaValueRangeFilterOptions as the provided SIZE
func (CaValueRangeFilterOptions) MarshalJSON ¶
func (t CaValueRangeFilterOptions) MarshalJSON() ([]byte, error)
func (*CaValueRangeFilterOptions) MergeDATEUPLOADED ¶
func (t *CaValueRangeFilterOptions) MergeDATEUPLOADED(v DATEUPLOADED) error
MergeDATEUPLOADED performs a merge with any union data inside the CaValueRangeFilterOptions, using the provided DATEUPLOADED
func (*CaValueRangeFilterOptions) MergeSIZE ¶
func (t *CaValueRangeFilterOptions) MergeSIZE(v SIZE) error
MergeSIZE performs a merge with any union data inside the CaValueRangeFilterOptions, using the provided SIZE
func (*CaValueRangeFilterOptions) UnmarshalJSON ¶
func (t *CaValueRangeFilterOptions) UnmarshalJSON(b []byte) error
type CaVersionInfo ¶
type CaVersionInfo struct { // LinkedAssetId The registering asset will be created as a new version of this linkedAssetId. LinkedAssetId *string `json:"linkedAssetId,omitempty"` // VersionNotes The version notes that client can associate to the asset.Versioning enables users to update an old asset, so that you can ensure the latest asset is being used. You can upload a new version of an existing asset along with version notes. Any tags/ASINs from previous version, will be retained on the new version too. VersionNotes *string `json:"versionNotes,omitempty"` }
CaVersionInfo defines model for caVersionInfo.
type CaVideoStreamMetadata ¶
type CaVideoStreamMetadata struct { BitRate *int64 `json:"bitRate,omitempty"` CodecName *string `json:"codecName,omitempty"` CodecType *string `json:"codecType,omitempty"` DisplayAspectRatio *string `json:"displayAspectRatio,omitempty"` Duration *float64 `json:"duration,omitempty"` FrameRate *float64 `json:"frameRate,omitempty"` Height *int `json:"height,omitempty"` Profile *string `json:"profile,omitempty"` Width *int `json:"width,omitempty"` }
CaVideoStreamMetadata Structure containing metadata of Video Stream.
profile: This is the profile of the stream. width: This is the resolution width of stream. height: This is the resolution height of stream. duration: This is the duration of the stream in secs. codecName: This tells the codec of the media stream. codecType: This is the codec type of stream. displayAspectRatio: This tells the aspect ratio of the stream. bitRate: This tells the bit rate of the stream. frameRate: This is the frame rate of video stream per sec.
type CaassetSubTypes ¶
type CaassetSubTypes = []CaAssetSubType
CaassetSubTypes defines model for caassetSubTypes.
type Client ¶
type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn // A callback for modifying response which are generated after receive from the network. ResponseEditors []ResponseEditorFn // The user agent header identifies your application, its version number, and the platform and programming language you are using. // You must include a user agent header in each request submitted to the sales partner API. UserAgent string }
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) GetUploadLocation ¶
func (c *Client) GetUploadLocation(ctx context.Context, params *GetUploadLocationParams, body GetUploadLocationJSONRequestBody) (*http.Response, error)
func (*Client) GetUploadLocationWithBody ¶
func (*Client) RegisterAsset ¶
func (c *Client) RegisterAsset(ctx context.Context, params *RegisterAssetParams, body RegisterAssetJSONRequestBody) (*http.Response, error)
func (*Client) RegisterAssetWithBody ¶
func (*Client) SearchAssets ¶
func (c *Client) SearchAssets(ctx context.Context, params *SearchAssetsParams, body SearchAssetsJSONRequestBody) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface { // GetAsset request GetAsset(ctx context.Context, params *GetAssetParams) (*http.Response, error) // RegisterAssetWithBody request with any body RegisterAssetWithBody(ctx context.Context, params *RegisterAssetParams, contentType string, body io.Reader) (*http.Response, error) RegisterAsset(ctx context.Context, params *RegisterAssetParams, body RegisterAssetJSONRequestBody) (*http.Response, error) // SearchAssetsWithBody request with any body SearchAssetsWithBody(ctx context.Context, params *SearchAssetsParams, contentType string, body io.Reader) (*http.Response, error) SearchAssets(ctx context.Context, params *SearchAssetsParams, body SearchAssetsJSONRequestBody) (*http.Response, error) // GetUploadLocationWithBody request with any body GetUploadLocationWithBody(ctx context.Context, params *GetUploadLocationParams, contentType string, body io.Reader) (*http.Response, error) GetUploadLocation(ctx context.Context, params *GetUploadLocationParams, body GetUploadLocationJSONRequestBody) (*http.Response, error) }
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
func WithResponseEditorFn ¶ added in v0.0.2
func WithResponseEditorFn(fn ResponseEditorFn) ClientOption
WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetAssetWithResponse ¶
func (c *ClientWithResponses) GetAssetWithResponse(ctx context.Context, params *GetAssetParams) (*GetAssetResp, error)
GetAssetWithResponse request returning *GetAssetResp
func (*ClientWithResponses) GetUploadLocationWithBodyWithResponse ¶
func (c *ClientWithResponses) GetUploadLocationWithBodyWithResponse(ctx context.Context, params *GetUploadLocationParams, contentType string, body io.Reader) (*GetUploadLocationResp, error)
GetUploadLocationWithBodyWithResponse request with arbitrary body returning *GetUploadLocationResp
func (*ClientWithResponses) GetUploadLocationWithResponse ¶
func (c *ClientWithResponses) GetUploadLocationWithResponse(ctx context.Context, params *GetUploadLocationParams, body GetUploadLocationJSONRequestBody) (*GetUploadLocationResp, error)
func (*ClientWithResponses) RegisterAssetWithBodyWithResponse ¶
func (c *ClientWithResponses) RegisterAssetWithBodyWithResponse(ctx context.Context, params *RegisterAssetParams, contentType string, body io.Reader) (*RegisterAssetResp, error)
RegisterAssetWithBodyWithResponse request with arbitrary body returning *RegisterAssetResp
func (*ClientWithResponses) RegisterAssetWithResponse ¶
func (c *ClientWithResponses) RegisterAssetWithResponse(ctx context.Context, params *RegisterAssetParams, body RegisterAssetJSONRequestBody) (*RegisterAssetResp, error)
func (*ClientWithResponses) SearchAssetsWithBodyWithResponse ¶
func (c *ClientWithResponses) SearchAssetsWithBodyWithResponse(ctx context.Context, params *SearchAssetsParams, contentType string, body io.Reader) (*SearchAssetsResp, error)
SearchAssetsWithBodyWithResponse request with arbitrary body returning *SearchAssetsResp
func (*ClientWithResponses) SearchAssetsWithResponse ¶
func (c *ClientWithResponses) SearchAssetsWithResponse(ctx context.Context, params *SearchAssetsParams, body SearchAssetsJSONRequestBody) (*SearchAssetsResp, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // GetAssetWithResponse request GetAssetWithResponse(ctx context.Context, params *GetAssetParams) (*GetAssetResp, error) // RegisterAssetWithBodyWithResponse request with any body RegisterAssetWithBodyWithResponse(ctx context.Context, params *RegisterAssetParams, contentType string, body io.Reader) (*RegisterAssetResp, error) RegisterAssetWithResponse(ctx context.Context, params *RegisterAssetParams, body RegisterAssetJSONRequestBody) (*RegisterAssetResp, error) // SearchAssetsWithBodyWithResponse request with any body SearchAssetsWithBodyWithResponse(ctx context.Context, params *SearchAssetsParams, contentType string, body io.Reader) (*SearchAssetsResp, error) SearchAssetsWithResponse(ctx context.Context, params *SearchAssetsParams, body SearchAssetsJSONRequestBody) (*SearchAssetsResp, error) // GetUploadLocationWithBodyWithResponse request with any body GetUploadLocationWithBodyWithResponse(ctx context.Context, params *GetUploadLocationParams, contentType string, body io.Reader) (*GetUploadLocationResp, error) GetUploadLocationWithResponse(ctx context.Context, params *GetUploadLocationParams, body GetUploadLocationJSONRequestBody) (*GetUploadLocationResp, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type DATEUPLOADED ¶
type DATEUPLOADED = string
DATEUPLOADED The value for this should be timestamp in milliseconds. It is the same as creation date.
type GetAssetParams ¶
type GetAssetParams struct { // AssetId The assetId AssetId string `form:"assetId" json:"assetId"` // Version The versionId of the asset, if not included all versions will return. Version *string `form:"version,omitempty" json:"version,omitempty"` // AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"` // AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header. AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"` }
GetAssetParams defines parameters for GetAsset.
type GetAssetResp ¶
type GetAssetResp struct { Body []byte HTTPResponse *http.Response ApplicationvndCreativeassetsgetresponseV3JSON200 *struct { AssetGlobal *CaAssetGlobal `json:"assetGlobal,omitempty"` // AssetVersionList The asset version list. AssetVersionList *CaAssetVersionList `json:"assetVersionList,omitempty"` } ApplicationvndCreativeassetsgetresponseV3JSON400 *CaBadRequest ApplicationvndCreativeassetsgetresponseV3JSON401 *CaUnauthorizedRequest ApplicationvndCreativeassetsgetresponseV3JSON403 *CaForbiddenRequest ApplicationvndCreativeassetsgetresponseV3JSON500 *CaInternalError }
func ParseGetAssetResp ¶
func ParseGetAssetResp(rsp *http.Response) (*GetAssetResp, error)
ParseGetAssetResp parses an HTTP response from a GetAssetWithResponse call
func (GetAssetResp) Status ¶
func (r GetAssetResp) Status() string
Status returns HTTPResponse.Status
func (GetAssetResp) StatusCode ¶
func (r GetAssetResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetUploadLocationJSONBody ¶
type GetUploadLocationJSONBody struct { // FileName The fileName of the asset. FileName *CaFileName `json:"fileName,omitempty"` }
GetUploadLocationJSONBody defines parameters for GetUploadLocation.
type GetUploadLocationJSONRequestBody ¶
type GetUploadLocationJSONRequestBody GetUploadLocationJSONBody
GetUploadLocationJSONRequestBody defines body for GetUploadLocation for application/json ContentType.
type GetUploadLocationParams ¶
type GetUploadLocationParams struct { // AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"` // AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header. AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"` }
GetUploadLocationParams defines parameters for GetUploadLocation.
type GetUploadLocationResp ¶
type GetUploadLocationResp struct { Body []byte HTTPResponse *http.Response ApplicationvndCreativeassetsuploadresponseV3JSON200 *struct { // Url The url to upload the asset. The url expires in 15 minutes. Url *CaAssetUploadLocation `json:"url,omitempty"` } ApplicationvndCreativeassetsuploadresponseV3JSON400 *CaBadRequest ApplicationvndCreativeassetsuploadresponseV3JSON401 *CaUnauthorizedRequest ApplicationvndCreativeassetsuploadresponseV3JSON403 *CaForbiddenRequest ApplicationvndCreativeassetsuploadresponseV3JSON500 *CaInternalError }
func ParseGetUploadLocationResp ¶
func ParseGetUploadLocationResp(rsp *http.Response) (*GetUploadLocationResp, error)
ParseGetUploadLocationResp parses an HTTP response from a GetUploadLocationWithResponse call
func (GetUploadLocationResp) Status ¶
func (r GetUploadLocationResp) Status() string
Status returns HTTPResponse.Status
func (GetUploadLocationResp) StatusCode ¶
func (r GetUploadLocationResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type RegisterAssetJSONBody ¶
type RegisterAssetJSONBody struct { // AsinList Tagging assets with ASIN, promotes asset discoverability downstream. If ASIN is provided at the time of upload/during asset registration, it is applied as a tag on that asset. This allows for that asset to be searchable using that ASIN#. For e.g., An advertiser may want to search for assets tagged with ASIN BC10001, so they can create a store spotlight ad with product images for that ASIN. AsinList *CaAsins `json:"asinList,omitempty"` AssetSubTypeList *CaassetSubTypes `json:"assetSubTypeList,omitempty"` // AssetType The asset type you are registering [`IMAGE`, `VIDEO`] AssetType *CaAssetType `json:"assetType,omitempty"` // AssociatedSubEntityList This field is required for sellers, but not required for vendors. The brandEntityId is required for sellers uploading assets for use in Sponsored Brands. As a best practice, ensure to include brandEntityId when uploading assets for sellers. AssociatedSubEntityList *CaAssociatedSubEntityList `json:"associatedSubEntityList,omitempty"` // Name The name to be given to the asset being registered. Name *CaAssetName `json:"name,omitempty"` // RegistrationContext This is used on registration of an asset, to associate DSP assets to a specific advertiser. This is **required** for assets being uploaded for use in DSP. RegistrationContext *CaRegistrationContext `json:"registrationContext,omitempty"` // SkipAssetSubTypesDetection Select true if you want to set an asset to a specific assetSubType, if this is not included the system may reclassify your asset based on specifications. SkipAssetSubTypesDetection *bool `json:"skipAssetSubTypesDetection,omitempty"` Tags *[]string `json:"tags,omitempty"` // Url The url to upload the asset. The url expires in 15 minutes. Url *CaAssetUploadLocation `json:"url,omitempty"` VersionInfo *CaVersionInfo `json:"versionInfo,omitempty"` }
RegisterAssetJSONBody defines parameters for RegisterAsset.
type RegisterAssetJSONRequestBody ¶
type RegisterAssetJSONRequestBody RegisterAssetJSONBody
RegisterAssetJSONRequestBody defines body for RegisterAsset for application/json ContentType.
type RegisterAssetParams ¶
type RegisterAssetParams struct { // AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"` // AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header. AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"` }
RegisterAssetParams defines parameters for RegisterAsset.
type RegisterAssetResp ¶
type RegisterAssetResp struct { Body []byte HTTPResponse *http.Response ApplicationvndCreativeassetsregisterresponseV3JSON200 *struct { // AssetId The asset identifier. AssetId *CaAssetId `json:"assetId,omitempty"` // FailedSpecChecks Specification Checks for all programs FailedSpecChecks *CaProgramSpecificationsList `json:"failedSpecChecks,omitempty"` // VersionId The version of the asset. VersionId *CaVersion `json:"versionId,omitempty"` } ApplicationvndCreativeassetsregisterresponseV3JSON400 *CaBadRequest ApplicationvndCreativeassetsregisterresponseV3JSON401 *CaUnauthorizedRequest ApplicationvndCreativeassetsregisterresponseV3JSON403 *CaForbiddenRequest ApplicationvndCreativeassetsregisterresponseV3JSON404 *CaResourceNotFound ApplicationvndCreativeassetsregisterresponseV3JSON500 *CaInternalError }
func ParseRegisterAssetResp ¶
func ParseRegisterAssetResp(rsp *http.Response) (*RegisterAssetResp, error)
ParseRegisterAssetResp parses an HTTP response from a RegisterAssetWithResponse call
func (RegisterAssetResp) Status ¶
func (r RegisterAssetResp) Status() string
Status returns HTTPResponse.Status
func (RegisterAssetResp) StatusCode ¶
func (r RegisterAssetResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ResponseEditorFn ¶ added in v0.0.2
ResponseEditorFn is the function signature for the ResponseEditor callback function
type SearchAssetsJSONRequestBody ¶
type SearchAssetsJSONRequestBody = CaSearchRequestCommon
SearchAssetsJSONRequestBody defines body for SearchAssets for application/json ContentType.
type SearchAssetsParams ¶
type SearchAssetsParams struct { // AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"` // AmazonAdvertisingAPIScope The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header. AmazonAdvertisingAPIScope string `json:"Amazon-Advertising-API-Scope"` }
SearchAssetsParams defines parameters for SearchAssets.
type SearchAssetsResp ¶
type SearchAssetsResp struct { Body []byte HTTPResponse *http.Response ApplicationvndCreativeassetssearchassetsresponseV3JSON200 *struct { AssetList *[]CaAsset `json:"assetList,omitempty"` Token *string `json:"token,omitempty"` TotalRecords *int64 `json:"totalRecords,omitempty"` } ApplicationvndCreativeassetssearchassetsresponseV3JSON400 *CaBadRequest ApplicationvndCreativeassetssearchassetsresponseV3JSON401 *CaUnauthorizedRequest ApplicationvndCreativeassetssearchassetsresponseV3JSON403 *CaForbiddenRequest ApplicationvndCreativeassetssearchassetsresponseV3JSON500 *CaInternalError }
func ParseSearchAssetsResp ¶
func ParseSearchAssetsResp(rsp *http.Response) (*SearchAssetsResp, error)
ParseSearchAssetsResp parses an HTTP response from a SearchAssetsWithResponse call
func (SearchAssetsResp) Status ¶
func (r SearchAssetsResp) Status() string
Status returns HTTPResponse.Status
func (SearchAssetsResp) StatusCode ¶
func (r SearchAssetsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode