\CreativePoolsAPI

All URIs are relative to https://up.go-adserver.com

Method	HTTP request	Description
ApiV1CreativePoolsGet	Get /api/v1/creative-pools	List creative pools.
ApiV1CreativePoolsIdAddCreativesPost	Post /api/v1/creative-pools/{id}/add-creatives	Add media-bank creatives to a pool.
ApiV1CreativePoolsIdAddUrlsPost	Post /api/v1/creative-pools/{id}/add-urls	Add hotlinked image / video / HTML URLs to a pool.
ApiV1CreativePoolsIdClonePost	Post /api/v1/creative-pools/{id}/clone	Clone a creative pool with all its items.
ApiV1CreativePoolsIdDelete	Delete /api/v1/creative-pools/{id}	Soft-delete a creative pool.
ApiV1CreativePoolsIdGet	Get /api/v1/creative-pools/{id}	Show a single creative pool.
ApiV1CreativePoolsIdItemsExportGet	Get /api/v1/creative-pools/{id}/items/export	Download pool items' creative files as a ZIP.
ApiV1CreativePoolsIdItemsGet	Get /api/v1/creative-pools/{id}/items	List items in a creative pool.
ApiV1CreativePoolsIdItemsItemIdDelete	Delete /api/v1/creative-pools/{id}/items/{itemId}	Soft-delete a single pool item.
ApiV1CreativePoolsIdItemsItemIdPut	Put /api/v1/creative-pools/{id}/items/{itemId}	Update a single pool item.
ApiV1CreativePoolsIdItemsItemIdTogglePut	Put /api/v1/creative-pools/{id}/items/{itemId}/toggle	Toggle a pool item on / off.
ApiV1CreativePoolsIdItemsMassActionPut	Put /api/v1/creative-pools/{id}/items/mass-action	Bulk-change items of a creative pool.
ApiV1CreativePoolsIdItemsPost	Post /api/v1/creative-pools/{id}/items	Add an item to a creative pool.
ApiV1CreativePoolsIdItemsRecoverPost	Post /api/v1/creative-pools/{id}/items/recover	Put removed items back into a creative pool.
ApiV1CreativePoolsIdPut	Put /api/v1/creative-pools/{id}	Update creative pool meta.
ApiV1CreativePoolsIdRecoverPost	Post /api/v1/creative-pools/{id}/recover	Restore an archived creative pool.
ApiV1CreativePoolsIdUsedInGet	Get /api/v1/creative-pools/{id}/used-in	List campaigns / ads that reference this pool.
ApiV1CreativePoolsPost	Post /api/v1/creative-pools	Create a creative pool.
ApiV1CreativesBulkDeletePost	Post /api/v1/creatives/bulk-delete	Soft-delete many media-bank creatives.
ApiV1CreativesBulkUndeletePost	Post /api/v1/creatives/bulk-undelete	Restore many deleted creatives.
ApiV1CreativesIdUndeletePut	Put /api/v1/creatives/{id}/undelete	Restore one deleted creative.

ApiV1CreativePoolsGet

ApiV1CreativePoolsGet200Response ApiV1CreativePoolsGet(ctx).FilterType(filterType).FilterTypes(filterTypes).FilterTitle(filterTitle).FilterId(filterId).FilterName(filterName).FilterOrientation(filterOrientation).State(state).Search(search).FitOrientation(fitOrientation).SelectStats(selectStats).From(from).To(to).Page(page).PerPage(perPage).SortBy(sortBy).SortDir(sortDir).Execute()

List creative pools.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	filterType := "filterType_example" // string |  (optional)
	filterTypes := "native,creator" // string | Comma-separated list of pool types (banner, video, reel, image, native, creator). (optional)
	filterTitle := "filterTitle_example" // string | Title contains. (optional)
	filterId := int32(56) // int32 |  (optional)
	filterName := "filterName_example" // string | Same as filter_title. (optional)
	filterOrientation := "filterOrientation_example" // string | The pool's own orientation label — empty on most pools; fit_orientation looks at the creatives instead. (optional)
	state := "state_example" // string | deleted = the archived pools (deleted from the pool page or archived from Cleanup), to restore with POST /{id}/recover. Purged pools are in neither list. (optional) (default to "live")
	search := "search_example" // string | Title contains. (optional)
	fitOrientation := "fitOrientation_example" // string | Adds how many of each pool's servable creatives have this orientation, so a pool that would produce an unservable ad can be told apart. (optional)
	selectStats := "selectStats_example" // string | 1 = add views, clicks and conversions per pool for the from / to window (default the last 7 days). (optional)
	from := time.Now() // string | With select_stats=1: first day of the stats window (YYYY-MM-DD). Both from and to are needed; otherwise the last 7 days. (optional)
	to := time.Now() // string | With select_stats=1: last day of the stats window (YYYY-MM-DD). (optional)
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := openapiclient._api_v1_creative_pools_get_per_page_parameter{Int32: new(int32)} // ApiV1CreativePoolsGetPerPageParameter |  (optional)
	sortBy := "sortBy_example" // string |  (optional) (default to "id")
	sortDir := "sortDir_example" // string |  (optional) (default to "desc")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsGet(context.Background()).FilterType(filterType).FilterTypes(filterTypes).FilterTitle(filterTitle).FilterId(filterId).FilterName(filterName).FilterOrientation(filterOrientation).State(state).Search(search).FitOrientation(fitOrientation).SelectStats(selectStats).From(from).To(to).Page(page).PerPage(perPage).SortBy(sortBy).SortDir(sortDir).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsGet`: ApiV1CreativePoolsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsGetRequest struct via the builder pattern

Name	Type	Description	Notes
filterType	string
filterTypes	string	Comma-separated list of pool types (banner, video, reel, image, native, creator).
filterTitle	string	Title contains.
filterId	int32
filterName	string	Same as filter_title.
filterOrientation	string	The pool's own orientation label — empty on most pools; fit_orientation looks at the creatives instead.
state	string	deleted = the archived pools (deleted from the pool page or archived from Cleanup), to restore with POST /{id}/recover. Purged pools are in neither list.	[default to "live"]
search	string	Title contains.
fitOrientation	string	Adds how many of each pool's servable creatives have this orientation, so a pool that would produce an unservable ad can be told apart.
selectStats	string	1 = add views, clicks and conversions per pool for the from / to window (default the last 7 days).
from	string	With select_stats=1: first day of the stats window (YYYY-MM-DD). Both from and to are needed; otherwise the last 7 days.
to	string	With select_stats=1: last day of the stats window (YYYY-MM-DD).
page	int32		[default to 1]
perPage	ApiV1CreativePoolsGetPerPageParameter
sortBy	string		[default to "id"]
sortDir	string		[default to "desc"]

Return type

ApiV1CreativePoolsGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdAddCreativesPost

ApiV1CreativePoolsIdAddCreativesPost(ctx, id).ApiV1CreativePoolsIdAddCreativesPostRequest(apiV1CreativePoolsIdAddCreativesPostRequest).Execute()

Add media-bank creatives to a pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1CreativePoolsIdAddCreativesPostRequest := *openapiclient.NewApiV1CreativePoolsIdAddCreativesPostRequest([]int32{int32(123)}) // ApiV1CreativePoolsIdAddCreativesPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdAddCreativesPost(context.Background(), id).ApiV1CreativePoolsIdAddCreativesPostRequest(apiV1CreativePoolsIdAddCreativesPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdAddCreativesPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdAddCreativesPostRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdAddCreativesPostRequest | ApiV1CreativePoolsIdAddCreativesPostRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdAddUrlsPost

ApiV1CreativePoolsIdAddUrlsPost(ctx, id).ApiV1CreativePoolsIdAddUrlsPostRequest(apiV1CreativePoolsIdAddUrlsPostRequest).Execute()

Add hotlinked image / video / HTML URLs to a pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1CreativePoolsIdAddUrlsPostRequest := *openapiclient.NewApiV1CreativePoolsIdAddUrlsPostRequest("Urls_example") // ApiV1CreativePoolsIdAddUrlsPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdAddUrlsPost(context.Background(), id).ApiV1CreativePoolsIdAddUrlsPostRequest(apiV1CreativePoolsIdAddUrlsPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdAddUrlsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdAddUrlsPostRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdAddUrlsPostRequest | ApiV1CreativePoolsIdAddUrlsPostRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdClonePost

ApiV1CreativePoolsIdClonePost201Response ApiV1CreativePoolsIdClonePost(ctx, id).Execute()

Clone a creative pool with all its items.

Example

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)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdClonePost(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdClonePost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsIdClonePost`: ApiV1CreativePoolsIdClonePost201Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsIdClonePost`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdClonePostRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiV1CreativePoolsIdClonePost201Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdDelete

ApiV1CreativePoolsIdDelete200Response ApiV1CreativePoolsIdDelete(ctx, id).Execute()

Soft-delete a creative pool.

Example

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)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdDelete(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsIdDelete`: ApiV1CreativePoolsIdDelete200Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsIdDelete`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiV1CreativePoolsIdDelete200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdGet

ApiV1CreativePoolsIdGet200Response ApiV1CreativePoolsIdGet(ctx, id).Execute()

Show a single creative pool.

Example

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)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdGet(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsIdGet`: ApiV1CreativePoolsIdGet200Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsIdGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiV1CreativePoolsIdGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsExportGet

*os.File ApiV1CreativePoolsIdItemsExportGet(ctx, id).Ids(ids).Execute()

Download pool items' creative files as a ZIP.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	ids := "ids_example" // string | Comma-separated item ids, e.g. `55120,55121`.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsExportGet(context.Background(), id).Ids(ids).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsExportGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsIdItemsExportGet`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsIdItemsExportGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsExportGetRequest struct via the builder pattern

Name	Type	Description	Notes

ids | string | Comma-separated item ids, e.g. `55120,55121`. |

Return type

*os.File

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/zip, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsGet

ApiV1CreativesGet200Response ApiV1CreativePoolsIdItemsGet(ctx, id).IncludeSizes(includeSizes).SelectStats(selectStats).From(from).To(to).Page(page).PerPage(perPage).FilterBansizeid(filterBansizeid).FilterIsactive(filterIsactive).SortBy(sortBy).SortDir(sortDir).Execute()

List items in a creative pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	includeSizes := "includeSizes_example" // string | Banner pools: 1 = also return the pool's banner sizes with an item count each, saving a second request. (optional)
	selectStats := "selectStats_example" // string | 1 = add stats per item for the from / to window (default the last 7 days). (optional)
	from := time.Now() // string | With select_stats=1: first day of the stats window (YYYY-MM-DD). Both from and to are needed; otherwise the last 7 days. (optional)
	to := time.Now() // string | With select_stats=1: last day of the stats window (YYYY-MM-DD). (optional)
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := int32(56) // int32 |  (optional) (default to 20)
	filterBansizeid := int32(56) // int32 | Banner size id. (optional)
	filterIsactive := int32(56) // int32 |  (optional)
	sortBy := "sortBy_example" // string |  (optional) (default to "id")
	sortDir := "sortDir_example" // string |  (optional) (default to "desc")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsGet(context.Background(), id).IncludeSizes(includeSizes).SelectStats(selectStats).From(from).To(to).Page(page).PerPage(perPage).FilterBansizeid(filterBansizeid).FilterIsactive(filterIsactive).SortBy(sortBy).SortDir(sortDir).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsIdItemsGet`: ApiV1CreativesGet200Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsIdItemsGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiV1CreativesGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsItemIdDelete

ApiV1CreativePoolsIdItemsItemIdDelete(ctx, id, itemId).Execute()

Soft-delete a single pool item.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	itemId := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsItemIdDelete(context.Background(), id, itemId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsItemIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32
itemId	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsItemIdDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsItemIdPut

ApiV1CreativePoolsIdItemsItemIdPut(ctx, id, itemId).ApiV1CreativePoolsIdItemsItemIdPutRequest(apiV1CreativePoolsIdItemsItemIdPutRequest).Execute()

Update a single pool item.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	itemId := int32(56) // int32 | 
	apiV1CreativePoolsIdItemsItemIdPutRequest := *openapiclient.NewApiV1CreativePoolsIdItemsItemIdPutRequest() // ApiV1CreativePoolsIdItemsItemIdPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsItemIdPut(context.Background(), id, itemId).ApiV1CreativePoolsIdItemsItemIdPutRequest(apiV1CreativePoolsIdItemsItemIdPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsItemIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32
itemId	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsItemIdPutRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdItemsItemIdPutRequest | ApiV1CreativePoolsIdItemsItemIdPutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsItemIdTogglePut

ApiV1CreativePoolsIdItemsItemIdTogglePut(ctx, id, itemId).Execute()

Toggle a pool item on / off.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	itemId := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsItemIdTogglePut(context.Background(), id, itemId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsItemIdTogglePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32
itemId	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsItemIdTogglePutRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsMassActionPut

ApiV1CreativePoolsIdItemsMassActionPut(ctx, id).ApiV1CreativePoolsIdItemsMassActionPutRequest(apiV1CreativePoolsIdItemsMassActionPutRequest).Execute()

Bulk-change items of a creative pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1CreativePoolsIdItemsMassActionPutRequest := *openapiclient.NewApiV1CreativePoolsIdItemsMassActionPutRequest("Action_example", []int32{int32(123)}) // ApiV1CreativePoolsIdItemsMassActionPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsMassActionPut(context.Background(), id).ApiV1CreativePoolsIdItemsMassActionPutRequest(apiV1CreativePoolsIdItemsMassActionPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsMassActionPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsMassActionPutRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdItemsMassActionPutRequest | ApiV1CreativePoolsIdItemsMassActionPutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsPost

ApiV1CreativePoolsIdItemsPost(ctx, id).ApiV1CreativePoolsIdItemsPostRequest(apiV1CreativePoolsIdItemsPostRequest).Execute()

Add an item to a creative pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1CreativePoolsIdItemsPostRequest := *openapiclient.NewApiV1CreativePoolsIdItemsPostRequest() // ApiV1CreativePoolsIdItemsPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsPost(context.Background(), id).ApiV1CreativePoolsIdItemsPostRequest(apiV1CreativePoolsIdItemsPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsPostRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdItemsPostRequest | ApiV1CreativePoolsIdItemsPostRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdItemsRecoverPost

ApiV1CreativePoolsIdItemsRecoverPost(ctx, id).ApiV1CreativePoolsIdItemsRecoverPostRequest(apiV1CreativePoolsIdItemsRecoverPostRequest).Execute()

Put removed items back into a creative pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1CreativePoolsIdItemsRecoverPostRequest := *openapiclient.NewApiV1CreativePoolsIdItemsRecoverPostRequest([]int32{int32(123)}) // ApiV1CreativePoolsIdItemsRecoverPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdItemsRecoverPost(context.Background(), id).ApiV1CreativePoolsIdItemsRecoverPostRequest(apiV1CreativePoolsIdItemsRecoverPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdItemsRecoverPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdItemsRecoverPostRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdItemsRecoverPostRequest | ApiV1CreativePoolsIdItemsRecoverPostRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdPut

ApiV1CreativePoolsIdPut(ctx, id).ApiV1CreativePoolsIdPutRequest(apiV1CreativePoolsIdPutRequest).Execute()

Update creative pool meta.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1CreativePoolsIdPutRequest := *openapiclient.NewApiV1CreativePoolsIdPutRequest() // ApiV1CreativePoolsIdPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdPut(context.Background(), id).ApiV1CreativePoolsIdPutRequest(apiV1CreativePoolsIdPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdPutRequest struct via the builder pattern

Name	Type	Description	Notes

apiV1CreativePoolsIdPutRequest | ApiV1CreativePoolsIdPutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdRecoverPost

ApiV1CreativePoolsIdRecoverPost(ctx, id).Execute()

Restore an archived creative pool.

Example

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.CreativePoolsAPI.ApiV1CreativePoolsIdRecoverPost(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdRecoverPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdRecoverPostRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsIdUsedInGet

ApiV1CreativePoolsIdUsedInGet200Response ApiV1CreativePoolsIdUsedInGet(ctx, id).Execute()

List campaigns / ads that reference this pool.

Example

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)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsIdUsedInGet(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsIdUsedInGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsIdUsedInGet`: ApiV1CreativePoolsIdUsedInGet200Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsIdUsedInGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsIdUsedInGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ApiV1CreativePoolsIdUsedInGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativePoolsPost

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response ApiV1CreativePoolsPost(ctx).ApiV1CreativePoolsPostRequest(apiV1CreativePoolsPostRequest).Execute()

Create a creative pool.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1CreativePoolsPostRequest := *openapiclient.NewApiV1CreativePoolsPostRequest("300x250 Promo Q3") // ApiV1CreativePoolsPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CreativePoolsAPI.ApiV1CreativePoolsPost(context.Background()).ApiV1CreativePoolsPostRequest(apiV1CreativePoolsPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativePoolsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1CreativePoolsPost`: ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response
	fmt.Fprintf(os.Stdout, "Response from `CreativePoolsAPI.ApiV1CreativePoolsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativePoolsPostRequest struct via the builder pattern

Name	Type	Description	Notes
apiV1CreativePoolsPostRequest	ApiV1CreativePoolsPostRequest

Return type

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativesBulkDeletePost

ApiV1CreativesBulkDeletePost(ctx).ApiV1CreativesBulkDeletePostRequest(apiV1CreativesBulkDeletePostRequest).Execute()

Soft-delete many media-bank creatives.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1CreativesBulkDeletePostRequest := *openapiclient.NewApiV1CreativesBulkDeletePostRequest([]int32{int32(123)}) // ApiV1CreativesBulkDeletePostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativesBulkDeletePost(context.Background()).ApiV1CreativesBulkDeletePostRequest(apiV1CreativesBulkDeletePostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativesBulkDeletePost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativesBulkDeletePostRequest struct via the builder pattern

Name	Type	Description	Notes
apiV1CreativesBulkDeletePostRequest	ApiV1CreativesBulkDeletePostRequest

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativesBulkUndeletePost

ApiV1CreativesBulkUndeletePost(ctx).ApiV1CreativesBulkUndeletePostRequest(apiV1CreativesBulkUndeletePostRequest).Execute()

Restore many deleted creatives.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1CreativesBulkUndeletePostRequest := *openapiclient.NewApiV1CreativesBulkUndeletePostRequest([]int32{int32(123)}) // ApiV1CreativesBulkUndeletePostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CreativePoolsAPI.ApiV1CreativesBulkUndeletePost(context.Background()).ApiV1CreativesBulkUndeletePostRequest(apiV1CreativesBulkUndeletePostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativesBulkUndeletePost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativesBulkUndeletePostRequest struct via the builder pattern

Name	Type	Description	Notes
apiV1CreativesBulkUndeletePostRequest	ApiV1CreativesBulkUndeletePostRequest

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1CreativesIdUndeletePut

ApiV1CreativesIdUndeletePut(ctx, id).Execute()

Restore one deleted creative.

Example

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.CreativePoolsAPI.ApiV1CreativesIdUndeletePut(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CreativePoolsAPI.ApiV1CreativesIdUndeletePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1CreativesIdUndeletePutRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

CreativePoolsAPI.md

Latest commit

History

CreativePoolsAPI.md

File metadata and controls

\CreativePoolsAPI

ApiV1CreativePoolsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdAddCreativesPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdAddUrlsPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdClonePost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdItemsExportGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdItemsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdItemsItemIdDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdItemsItemIdPut

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CreativePoolsIdItemsItemIdTogglePut

Example

Path Parameters