\CleanupAPI

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

Method	HTTP request	Description
ApiV1CleanupAdvertiserArchivedGet	Get /api/v1/cleanup/advertiser/archived	Archived advertiser items that can be purged.
ApiV1CleanupAdvertiserExportGet	Get /api/v1/cleanup/advertiser/export	Download the advertiser cleanup candidates.
ApiV1CleanupAdvertiserGet	Get /api/v1/cleanup/advertiser	List advertiser items that no longer serve.
ApiV1CleanupAdvertiserLinkedGet	Get /api/v1/cleanup/advertiser/linked	What still uses advertiser cleanup rows.
ApiV1CleanupAdvertiserPurgePost	Post /api/v1/cleanup/advertiser/purge	Purge archived advertiser items for good.
ApiV1CleanupAdvertiserRunsGet	Get /api/v1/cleanup/advertiser/runs	Recent advertiser cleanup runs.
ApiV1CleanupAdvertiserRunsIdGet	Get /api/v1/cleanup/advertiser/runs/{id}	One advertiser cleanup run with its items.
ApiV1CleanupAdvertiserRunsIdUndonePost	Post /api/v1/cleanup/advertiser/runs/{id}/undone	Mark a advertiser cleanup run as undone.
ApiV1CleanupAdvertiserRunsPost	Post /api/v1/cleanup/advertiser/runs	Record a advertiser cleanup run.
ApiV1CleanupAdvertiserSummaryGet	Get /api/v1/cleanup/advertiser/summary	Count the advertiser cleanup candidates per kind.
ApiV1CleanupPublisherArchivedGet	Get /api/v1/cleanup/publisher/archived	Archived publisher items that can be purged.
ApiV1CleanupPublisherExportGet	Get /api/v1/cleanup/publisher/export	Download the publisher cleanup candidates.
ApiV1CleanupPublisherGet	Get /api/v1/cleanup/publisher	List publisher items that no longer serve.
ApiV1CleanupPublisherLinkedGet	Get /api/v1/cleanup/publisher/linked	What still uses publisher cleanup rows.
ApiV1CleanupPublisherPurgePost	Post /api/v1/cleanup/publisher/purge	Purge archived publisher items for good.
ApiV1CleanupPublisherRunsGet	Get /api/v1/cleanup/publisher/runs	Recent publisher cleanup runs.
ApiV1CleanupPublisherRunsIdGet	Get /api/v1/cleanup/publisher/runs/{id}	One publisher cleanup run with its items.
ApiV1CleanupPublisherRunsIdUndonePost	Post /api/v1/cleanup/publisher/runs/{id}/undone	Mark a publisher cleanup run as undone.
ApiV1CleanupPublisherRunsPost	Post /api/v1/cleanup/publisher/runs	Record a publisher cleanup run.
ApiV1CleanupPublisherSummaryGet	Get /api/v1/cleanup/publisher/summary	Count the publisher cleanup candidates per kind.

ApiV1CleanupAdvertiserArchivedGet

ApiV1CleanupAdvertiserArchivedGet(ctx).Execute()

Archived advertiser items that can be purged.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupAdvertiserExportGet

ApiV1CleanupAdvertiserExportGet(ctx).Format(format).Kinds(kinds).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()

Download the advertiser cleanup candidates.

Example

package main

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

func main() {
	format := "format_example" // string |  (optional) (default to "xlsx")
	kinds := "kinds_example" // string | Comma-separated subset of: campaign,ad,creative,creative_pool,url_pool. (optional)
	inactiveDays := int32(56) // int32 |  (optional) (default to 90)
	neverServed := true // bool |  (optional) (default to false)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupAdvertiserExportGet(context.Background()).Format(format).Kinds(kinds).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupAdvertiserExportGet``: %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 apiApiV1CleanupAdvertiserExportGetRequest struct via the builder pattern

Name	Type	Description	Notes
format	string		[default to "xlsx"]
kinds	string	Comma-separated subset of: campaign,ad,creative,creative_pool,url_pool.
inactiveDays	int32		[default to 90]
neverServed	bool		[default to false]

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv, application/json

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

ApiV1CleanupAdvertiserGet

ApiV1CleanupAdvertiserGet(ctx).Kind(kind).InactiveDays(inactiveDays).NeverServed(neverServed).Search(search).Sort(sort).Dir(dir).Page(page).PerPage(perPage).Execute()

List advertiser items that no longer serve.

Example

package main

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

func main() {
	kind := "kind_example" // string |  (optional)
	inactiveDays := int32(56) // int32 |  (optional) (default to 90)
	neverServed := true // bool |  (optional) (default to false)
	search := "search_example" // string | Substring of the name. (optional)
	sort := "sort_example" // string | last_served ascending = never served first, then the longest idle. (optional) (default to "last_served")
	dir := "dir_example" // string |  (optional) (default to "asc")
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := int32(56) // int32 |  (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupAdvertiserGet(context.Background()).Kind(kind).InactiveDays(inactiveDays).NeverServed(neverServed).Search(search).Sort(sort).Dir(dir).Page(page).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupAdvertiserGet``: %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 apiApiV1CleanupAdvertiserGetRequest struct via the builder pattern

Name	Type	Description	Notes
kind	string
inactiveDays	int32		[default to 90]
neverServed	bool		[default to false]
search	string	Substring of the name.
sort	string	last_served ascending = never served first, then the longest idle.	[default to "last_served"]
dir	string		[default to "asc"]
page	int32		[default to 1]
perPage	int32		[default to 100]

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]

ApiV1CleanupAdvertiserLinkedGet

ApiV1CleanupAdvertiserLinkedGet(ctx).Kind(kind).Ids(ids).Execute()

What still uses advertiser cleanup rows.

Example

package main

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

func main() {
	kind := "kind_example" // string | 
	ids := "ids_example" // string | Comma-separated row ids, 1 to 5000.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupAdvertiserLinkedGet(context.Background()).Kind(kind).Ids(ids).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupAdvertiserLinkedGet``: %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 apiApiV1CleanupAdvertiserLinkedGetRequest struct via the builder pattern

Name	Type	Description	Notes
kind	string
ids	string	Comma-separated row ids, 1 to 5000.

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]

ApiV1CleanupAdvertiserPurgePost

ApiV1CleanupAdvertiserPurgePost(ctx).Execute()

Purge archived advertiser items for good.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupAdvertiserRunsGet

ApiV1CleanupAdvertiserRunsGet(ctx).Execute()

Recent advertiser cleanup runs.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupAdvertiserRunsIdGet

ApiV1CleanupAdvertiserRunsIdGet(ctx, id).Execute()

One advertiser cleanup run with 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)
	r, err := apiClient.CleanupAPI.ApiV1CleanupAdvertiserRunsIdGet(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupAdvertiserRunsIdGet``: %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 apiApiV1CleanupAdvertiserRunsIdGetRequest 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]

ApiV1CleanupAdvertiserRunsIdUndonePost

ApiV1CleanupAdvertiserRunsIdUndonePost(ctx, id).Execute()

Mark a advertiser cleanup run as undone.

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.CleanupAPI.ApiV1CleanupAdvertiserRunsIdUndonePost(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupAdvertiserRunsIdUndonePost``: %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 apiApiV1CleanupAdvertiserRunsIdUndonePostRequest 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]

ApiV1CleanupAdvertiserRunsPost

ApiV1CleanupAdvertiserRunsPost(ctx).Execute()

Record a advertiser cleanup run.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupAdvertiserSummaryGet

ApiV1CleanupAdvertiserSummaryGet(ctx).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()

Count the advertiser cleanup candidates per kind.

Example

package main

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

func main() {
	inactiveDays := int32(56) // int32 |  (optional) (default to 90)
	neverServed := true // bool |  (optional) (default to false)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupAdvertiserSummaryGet(context.Background()).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupAdvertiserSummaryGet``: %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 apiApiV1CleanupAdvertiserSummaryGetRequest struct via the builder pattern

Name	Type	Description	Notes
inactiveDays	int32		[default to 90]
neverServed	bool		[default to false]

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]

ApiV1CleanupPublisherArchivedGet

ApiV1CleanupPublisherArchivedGet(ctx).Execute()

Archived publisher items that can be purged.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupPublisherExportGet

ApiV1CleanupPublisherExportGet(ctx).Format(format).Kinds(kinds).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()

Download the publisher cleanup candidates.

Example

package main

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

func main() {
	format := "format_example" // string |  (optional) (default to "xlsx")
	kinds := "kinds_example" // string | Comma-separated subset of: adzone,website. (optional)
	inactiveDays := int32(56) // int32 |  (optional) (default to 90)
	neverServed := true // bool |  (optional) (default to false)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupPublisherExportGet(context.Background()).Format(format).Kinds(kinds).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupPublisherExportGet``: %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 apiApiV1CleanupPublisherExportGetRequest struct via the builder pattern

Name	Type	Description	Notes
format	string		[default to "xlsx"]
kinds	string	Comma-separated subset of: adzone,website.
inactiveDays	int32		[default to 90]
neverServed	bool		[default to false]

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv, application/json

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

ApiV1CleanupPublisherGet

ApiV1CleanupPublisherGet(ctx).Kind(kind).InactiveDays(inactiveDays).NeverServed(neverServed).Search(search).Sort(sort).Dir(dir).Page(page).PerPage(perPage).Execute()

List publisher items that no longer serve.

Example

package main

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

func main() {
	kind := "kind_example" // string |  (optional)
	inactiveDays := int32(56) // int32 |  (optional) (default to 90)
	neverServed := true // bool |  (optional) (default to false)
	search := "search_example" // string | Substring of the name. (optional)
	sort := "sort_example" // string | last_served ascending = never served first, then the longest idle. (optional) (default to "last_served")
	dir := "dir_example" // string |  (optional) (default to "asc")
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := int32(56) // int32 |  (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupPublisherGet(context.Background()).Kind(kind).InactiveDays(inactiveDays).NeverServed(neverServed).Search(search).Sort(sort).Dir(dir).Page(page).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupPublisherGet``: %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 apiApiV1CleanupPublisherGetRequest struct via the builder pattern

Name	Type	Description	Notes
kind	string
inactiveDays	int32		[default to 90]
neverServed	bool		[default to false]
search	string	Substring of the name.
sort	string	last_served ascending = never served first, then the longest idle.	[default to "last_served"]
dir	string		[default to "asc"]
page	int32		[default to 1]
perPage	int32		[default to 100]

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]

ApiV1CleanupPublisherLinkedGet

ApiV1CleanupPublisherLinkedGet(ctx).Kind(kind).Ids(ids).Execute()

What still uses publisher cleanup rows.

Example

package main

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

func main() {
	kind := "kind_example" // string | 
	ids := "ids_example" // string | Comma-separated row ids, 1 to 5000.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupPublisherLinkedGet(context.Background()).Kind(kind).Ids(ids).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupPublisherLinkedGet``: %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 apiApiV1CleanupPublisherLinkedGetRequest struct via the builder pattern

Name	Type	Description	Notes
kind	string
ids	string	Comma-separated row ids, 1 to 5000.

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]

ApiV1CleanupPublisherPurgePost

ApiV1CleanupPublisherPurgePost(ctx).Execute()

Purge archived publisher items for good.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupPublisherRunsGet

ApiV1CleanupPublisherRunsGet(ctx).Execute()

Recent publisher cleanup runs.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupPublisherRunsIdGet

ApiV1CleanupPublisherRunsIdGet(ctx, id).Execute()

One publisher cleanup run with 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)
	r, err := apiClient.CleanupAPI.ApiV1CleanupPublisherRunsIdGet(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupPublisherRunsIdGet``: %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 apiApiV1CleanupPublisherRunsIdGetRequest 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]

ApiV1CleanupPublisherRunsIdUndonePost

ApiV1CleanupPublisherRunsIdUndonePost(ctx, id).Execute()

Mark a publisher cleanup run as undone.

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.CleanupAPI.ApiV1CleanupPublisherRunsIdUndonePost(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupPublisherRunsIdUndonePost``: %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 apiApiV1CleanupPublisherRunsIdUndonePostRequest 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]

ApiV1CleanupPublisherRunsPost

ApiV1CleanupPublisherRunsPost(ctx).Execute()

Record a publisher cleanup run.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

ApiV1CleanupPublisherSummaryGet

ApiV1CleanupPublisherSummaryGet(ctx).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()

Count the publisher cleanup candidates per kind.

Example

package main

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

func main() {
	inactiveDays := int32(56) // int32 |  (optional) (default to 90)
	neverServed := true // bool |  (optional) (default to false)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CleanupAPI.ApiV1CleanupPublisherSummaryGet(context.Background()).InactiveDays(inactiveDays).NeverServed(neverServed).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CleanupAPI.ApiV1CleanupPublisherSummaryGet``: %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 apiApiV1CleanupPublisherSummaryGetRequest struct via the builder pattern

Name	Type	Description	Notes
inactiveDays	int32		[default to 90]
neverServed	bool		[default to false]

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

CleanupAPI.md

Latest commit

History

CleanupAPI.md

File metadata and controls

\CleanupAPI

ApiV1CleanupAdvertiserArchivedGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserExportGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserLinkedGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserPurgePost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserRunsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserRunsIdGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserRunsIdUndonePost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserRunsPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupAdvertiserSummaryGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1CleanupPublisherArchivedGet

Example

Path Parameters