All URIs are relative to https://up.go-adserver.com
| Method | HTTP request | Description |
|---|---|---|
| ApiV1CreativeFoldersGet | Get /api/v1/creative-folders | List media-bank folders. |
| ApiV1CreativeFoldersIdDelete | Delete /api/v1/creative-folders/{id} | Delete a folder. |
| ApiV1CreativeFoldersIdPut | Put /api/v1/creative-folders/{id} | Rename or move a folder. |
| ApiV1CreativeFoldersPost | Post /api/v1/creative-folders | Create a folder. |
| ApiV1CreativesBulkMovePost | Post /api/v1/creatives/bulk-move | File creatives into a folder. |
| ApiV1CreativesGet | Get /api/v1/creatives | List the creative library. |
| ApiV1CreativesIdDelete | Delete /api/v1/creatives/{id} | Delete a creative. |
| ApiV1CreativesIdGet | Get /api/v1/creatives/{id} | Show one creative. |
| ApiV1CreativesIdNamePut | Put /api/v1/creatives/{id}/name | Rename a creative (panel inline edit). |
| ApiV1CreativesIdPut | Put /api/v1/creatives/{id} | Rename and/or re-tag a creative. |
| ApiV1CreativesIdTagsPut | Put /api/v1/creatives/{id}/tags | Replace a creative's tags (panel inline edit). |
| ApiV1CreativesIdUsedInGet | Get /api/v1/creatives/{id}/used-in | List ads / pools referencing this creative. |
| ApiV1CreativesUploadPost | Post /api/v1/creatives/upload | Upload creative files. |
ApiV1CreativeFoldersGet(ctx).WithCounts(withCounts).CreativeType(creativeType).Execute()
List media-bank folders.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
withCounts := "withCounts_example" // string | Add `count` (live creatives) per folder plus meta.unfiled_count and meta.creative_count. (optional)
creativeType := "creativeType_example" // string | Narrow the counts to one creative type (comma-separated list accepted). (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativeFoldersGet(context.Background()).WithCounts(withCounts).CreativeType(creativeType).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativeFoldersGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiApiV1CreativeFoldersGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| withCounts | string | Add `count` (live creatives) per folder plus meta.unfiled_count and meta.creative_count. | |
| creativeType | string | Narrow the counts to one creative type (comma-separated list accepted). |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativeFoldersIdDelete(ctx, id).MoveTo(moveTo).Execute()
Delete a folder.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
moveTo := int32(56) // int32 | File the folder's creatives here instead of unfiling them. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativeFoldersIdDelete(context.Background(), id).MoveTo(moveTo).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativeFoldersIdDelete``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativeFoldersIdDeleteRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
moveTo | int32 | File the folder's creatives here instead of unfiling them. |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativeFoldersIdPut(ctx, id).ApiV1CreativeFoldersIdPutRequest(apiV1CreativeFoldersIdPutRequest).Execute()
Rename or move a folder.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
apiV1CreativeFoldersIdPutRequest := *openapiclient.NewApiV1CreativeFoldersIdPutRequest("Name_example") // ApiV1CreativeFoldersIdPutRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativeFoldersIdPut(context.Background(), id).ApiV1CreativeFoldersIdPutRequest(apiV1CreativeFoldersIdPutRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativeFoldersIdPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativeFoldersIdPutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiV1CreativeFoldersIdPutRequest | ApiV1CreativeFoldersIdPutRequest | |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativeFoldersPost(ctx).ApiV1CreativeFoldersPostRequest(apiV1CreativeFoldersPostRequest).Execute()
Create a folder.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
apiV1CreativeFoldersPostRequest := *openapiclient.NewApiV1CreativeFoldersPostRequest("Name_example") // ApiV1CreativeFoldersPostRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativeFoldersPost(context.Background()).ApiV1CreativeFoldersPostRequest(apiV1CreativeFoldersPostRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativeFoldersPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiApiV1CreativeFoldersPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| apiV1CreativeFoldersPostRequest | ApiV1CreativeFoldersPostRequest |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesBulkMovePost(ctx).ApiV1CreativesBulkMovePostRequest(apiV1CreativesBulkMovePostRequest).Execute()
File creatives into a folder.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
apiV1CreativesBulkMovePostRequest := *openapiclient.NewApiV1CreativesBulkMovePostRequest(int32(123)) // ApiV1CreativesBulkMovePostRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesBulkMovePost(context.Background()).ApiV1CreativesBulkMovePostRequest(apiV1CreativesBulkMovePostRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesBulkMovePost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiApiV1CreativesBulkMovePostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| apiV1CreativesBulkMovePostRequest | ApiV1CreativesBulkMovePostRequest |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesGet200Response ApiV1CreativesGet(ctx).CreativeType(creativeType).Sizeid(sizeid).Orientation(orientation).Deleted(deleted).All(all).FilterName(filterName).Search(search).SortBy(sortBy).SortDir(sortDir).FolderId(folderId).IncludeSubfolders(includeSubfolders).Page(page).PerPage(perPage).Limit(limit).Offset(offset).FilterId(filterId).FilterType(filterType).FilterSizeid(filterSizeid).Execute()
List the creative library.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
creativeType := "native,creator" // string | One creative type, or a comma-separated list: banner, icon, native, push, video, reel, image, creator. (A bare `type` parameter is not read.) (optional)
sizeid := int32(56) // int32 | Banner size id. (optional)
orientation := "orientation_example" // string | (optional)
deleted := "deleted_example" // string | 1 = only deleted creatives. (optional)
all := "all_example" // string | 1 = live and deleted creatives together. (optional)
filterName := "filterName_example" // string | Name contains. (optional)
search := "search_example" // string | Name contains. (optional)
sortBy := "sortBy_example" // string | (optional) (default to "id")
sortDir := "sortDir_example" // string | (optional) (default to "desc")
folderId := int32(56) // int32 | Media-bank folder id. 0 selects the unfiled creatives; omit for every folder. (optional)
includeSubfolders := "includeSubfolders_example" // string | With folder_id, also return creatives filed in that folder's subfolders. (optional) (default to "1")
page := int32(56) // int32 | (optional) (default to 1)
perPage := openapiclient._api_v1_creatives_get_per_page_parameter{Int32: new(int32)} // ApiV1CreativesGetPerPageParameter | Page size (max 100), or `all` for the whole library in one page. (optional)
limit := int32(56) // int32 | Offset paging: page size (per_page wins when both are sent). (optional)
offset := int32(56) // int32 | Offset paging: rows to skip. (optional)
filterId := int32(56) // int32 | (optional)
filterType := "filterType_example" // string | Exactly one type; creative_type also takes a list. (optional)
filterSizeid := int32(56) // int32 | Same as sizeid. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.CreativesAPI.ApiV1CreativesGet(context.Background()).CreativeType(creativeType).Sizeid(sizeid).Orientation(orientation).Deleted(deleted).All(all).FilterName(filterName).Search(search).SortBy(sortBy).SortDir(sortDir).FolderId(folderId).IncludeSubfolders(includeSubfolders).Page(page).PerPage(perPage).Limit(limit).Offset(offset).FilterId(filterId).FilterType(filterType).FilterSizeid(filterSizeid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ApiV1CreativesGet`: ApiV1CreativesGet200Response
fmt.Fprintf(os.Stdout, "Response from `CreativesAPI.ApiV1CreativesGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiApiV1CreativesGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| creativeType | string | One creative type, or a comma-separated list: banner, icon, native, push, video, reel, image, creator. (A bare `type` parameter is not read.) | |
| sizeid | int32 | Banner size id. | |
| orientation | string | ||
| deleted | string | 1 = only deleted creatives. | |
| all | string | 1 = live and deleted creatives together. | |
| filterName | string | Name contains. | |
| search | string | Name contains. | |
| sortBy | string | [default to "id"] | |
| sortDir | string | [default to "desc"] | |
| folderId | int32 | Media-bank folder id. 0 selects the unfiled creatives; omit for every folder. | |
| includeSubfolders | string | With folder_id, also return creatives filed in that folder's subfolders. | [default to "1"] |
| page | int32 | [default to 1] | |
| perPage | ApiV1CreativesGetPerPageParameter | Page size (max 100), or `all` for the whole library in one page. | |
| limit | int32 | Offset paging: page size (per_page wins when both are sent). | |
| offset | int32 | Offset paging: rows to skip. | |
| filterId | int32 | ||
| filterType | string | Exactly one type; creative_type also takes a list. | |
| filterSizeid | int32 | Same as sizeid. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesIdDelete(ctx, id).Execute()
Delete a creative.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesIdDelete(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesIdDelete``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativesIdDeleteRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesIdGet(ctx, id).Execute()
Show one creative.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesIdGet(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesIdGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativesIdGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesIdNamePut(ctx, id).ApiV1CreativesIdNamePutRequest(apiV1CreativesIdNamePutRequest).Execute()
Rename a creative (panel inline edit).
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
apiV1CreativesIdNamePutRequest := *openapiclient.NewApiV1CreativesIdNamePutRequest("Name_example") // ApiV1CreativesIdNamePutRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesIdNamePut(context.Background(), id).ApiV1CreativesIdNamePutRequest(apiV1CreativesIdNamePutRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesIdNamePut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativesIdNamePutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiV1CreativesIdNamePutRequest | ApiV1CreativesIdNamePutRequest | |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesIdPut(ctx, id).ApiV1CreativesIdPutRequest(apiV1CreativesIdPutRequest).Execute()
Rename and/or re-tag a creative.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
apiV1CreativesIdPutRequest := *openapiclient.NewApiV1CreativesIdPutRequest() // ApiV1CreativesIdPutRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesIdPut(context.Background(), id).ApiV1CreativesIdPutRequest(apiV1CreativesIdPutRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesIdPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativesIdPutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiV1CreativesIdPutRequest | ApiV1CreativesIdPutRequest | |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesIdTagsPut(ctx, id).ApiV1CreativesIdTagsPutRequest(apiV1CreativesIdTagsPutRequest).Execute()
Replace a creative's tags (panel inline edit).
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
apiV1CreativesIdTagsPutRequest := *openapiclient.NewApiV1CreativesIdTagsPutRequest([]int32{int32(123)}) // ApiV1CreativesIdTagsPutRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesIdTagsPut(context.Background(), id).ApiV1CreativesIdTagsPutRequest(apiV1CreativesIdTagsPutRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesIdTagsPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativesIdTagsPutRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
apiV1CreativesIdTagsPutRequest | ApiV1CreativesIdTagsPutRequest | |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesIdUsedInGet(ctx, id).Execute()
List ads / pools referencing this creative.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
id := int32(56) // int32 |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesIdUsedInGet(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesIdUsedInGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiApiV1CreativesIdUsedInGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApiV1CreativesUploadPost(ctx).Files(files).Type_(type_).BannerSize(bannerSize).Tags(tags).FolderId(folderId).FolderName(folderName).UploadZip(uploadZip).FolderFromZip(folderFromZip).FolderFromZipPaths(folderFromZipPaths).Zipfile(zipfile).Icontags(icontags).Properties(properties).Skiperrors(skiperrors).UseOverlays(useOverlays).ClonePerOverlay(clonePerOverlay).Overlay(overlay).OverlaysZip(overlaysZip).Execute()
Upload creative files.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/goadserver/goadserver-go"
)
func main() {
files := []*os.File{"TODO"} // []*os.File | One or more creative files.
type_ := "type__example" // string | audio = audio-ad creatives (mp3, m4a, aac, ogg, opus or wav, 3-120 s): re-encoded to a 128 kbps mp3, stored as <id>.mp3, the duration measured. Use the id as creative_id with video_type=creative on an audio ad (adtype 43). (optional) (default to "banner")
bannerSize := int32(56) // int32 | Banner size id; auto-derived from image dimensions when omitted. An image exactly 2x or 3x a size is kept at full resolution under that size (served at the size, sharp on high-density screens); pass the 1x size id when the 2x dimensions are a size of their own. (optional)
tags := "tags_example" // string | (optional)
folderId := int32(56) // int32 | File the batch into this existing media-bank folder. Omit or 0 for unfiled. (optional)
folderName := "folderName_example" // string | Create-or-reuse a folder with this name under folder_id and file the batch there. (optional)
uploadZip := "uploadZip_example" // string | Send one archive as `zipfile` instead of `files`; the server extracts it. (optional)
folderFromZip := "folderFromZip_example" // string | ZIP uploads only: name the folder after the archive (extension dropped), under folder_id / folder_name. (optional)
folderFromZipPaths := "folderFromZipPaths_example" // string | ZIP uploads only: recreate the archive's own directories as subfolders, up to 3 tiers. (optional)
zipfile := os.NewFile(1234, "some_file") // *os.File | With upload_zip=1: the archive to extract. (optional)
icontags := "icontags_example" // string | type=icon only: tags for the icons; overrides `tags` when sent. (optional)
properties := "properties_example" // string | Comma-separated property ids stamped on every created creative. (optional)
skiperrors := "skiperrors_example" // string | 1 = keep going past a file that fails and report it in `errors`; 0 stops at the first failure. (optional)
useOverlays := "useOverlays_example" // string | 1 = composite the PNG overlays sent on `overlay` / `overlays_zip` onto the uploaded images. (optional)
clonePerOverlay := "clonePerOverlay_example" // string | With use_overlays=1: create one variant per overlay instead of rotating the overlays across the files. (optional)
overlay := []*os.File{"TODO"} // []*os.File | Overlay PNGs (repeatable, also accepted as overlay[]). Order sets the rotation. (optional)
overlaysZip := []*os.File{"TODO"} // []*os.File | ZIP archives of overlay PNGs (repeatable, also overlays_zip[]); entries are used in name order after the loose overlays. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.CreativesAPI.ApiV1CreativesUploadPost(context.Background()).Files(files).Type_(type_).BannerSize(bannerSize).Tags(tags).FolderId(folderId).FolderName(folderName).UploadZip(uploadZip).FolderFromZip(folderFromZip).FolderFromZipPaths(folderFromZipPaths).Zipfile(zipfile).Icontags(icontags).Properties(properties).Skiperrors(skiperrors).UseOverlays(useOverlays).ClonePerOverlay(clonePerOverlay).Overlay(overlay).OverlaysZip(overlaysZip).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CreativesAPI.ApiV1CreativesUploadPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiApiV1CreativesUploadPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| files | *[]os.File | One or more creative files. | |
| type_ | string | audio = audio-ad creatives (mp3, m4a, aac, ogg, opus or wav, 3-120 s): re-encoded to a 128 kbps mp3, stored as <id>.mp3, the duration measured. Use the id as creative_id with video_type=creative on an audio ad (adtype 43). | [default to "banner"] |
| bannerSize | int32 | Banner size id; auto-derived from image dimensions when omitted. An image exactly 2x or 3x a size is kept at full resolution under that size (served at the size, sharp on high-density screens); pass the 1x size id when the 2x dimensions are a size of their own. | |
| tags | string | ||
| folderId | int32 | File the batch into this existing media-bank folder. Omit or 0 for unfiled. | |
| folderName | string | Create-or-reuse a folder with this name under folder_id and file the batch there. | |
| uploadZip | string | Send one archive as `zipfile` instead of `files`; the server extracts it. | |
| folderFromZip | string | ZIP uploads only: name the folder after the archive (extension dropped), under folder_id / folder_name. | |
| folderFromZipPaths | string | ZIP uploads only: recreate the archive's own directories as subfolders, up to 3 tiers. | |
| zipfile | *os.File | With upload_zip=1: the archive to extract. | |
| icontags | string | type=icon only: tags for the icons; overrides `tags` when sent. | |
| properties | string | Comma-separated property ids stamped on every created creative. | |
| skiperrors | string | 1 = keep going past a file that fails and report it in `errors`; 0 stops at the first failure. | |
| useOverlays | string | 1 = composite the PNG overlays sent on `overlay` / `overlays_zip` onto the uploaded images. | |
| clonePerOverlay | string | With use_overlays=1: create one variant per overlay instead of rotating the overlays across the files. | |
| overlay | *[]os.File | Overlay PNGs (repeatable, also accepted as overlay[]). Order sets the rotation. | |
| overlaysZip | *[]os.File | ZIP archives of overlay PNGs (repeatable, also overlays_zip[]); entries are used in name order after the loose overlays. |
(empty response body)
- Content-Type: multipart/form-data
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]