Skip to content

SourceOptimizersAPI.md

Latest commit

 

History

History
794 lines (494 loc) · 19 KB

SourceOptimizersAPI.md

File metadata and controls

794 lines (494 loc) · 19 KB
Raw

\SourceOptimizersAPI

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

Method HTTP request Description
ApiV1CpaOptimizersGet Get /api/v1/cpa-optimizers List CPA optimizers.
ApiV1CpaOptimizersIdDelete Delete /api/v1/cpa-optimizers/{id} Delete a CPA optimizer.
ApiV1CpaOptimizersIdGet Get /api/v1/cpa-optimizers/{id} Show a CPA optimizer.
ApiV1CpaOptimizersIdPut Put /api/v1/cpa-optimizers/{id} Replace a CPA optimizer.
ApiV1CpaOptimizersPost Post /api/v1/cpa-optimizers Create a CPA optimizer.
ApiV1CpmOptimizersActiveGet Get /api/v1/cpm-optimizers/active Does the account have any CPM optimizer?
ApiV1CpmOptimizersGet Get /api/v1/cpm-optimizers List CPM optimizers.
ApiV1CpmOptimizersIdDelete Delete /api/v1/cpm-optimizers/{id} Delete a CPM optimizer.
ApiV1CpmOptimizersIdGet Get /api/v1/cpm-optimizers/{id} Show a CPM optimizer.
ApiV1CpmOptimizersIdPut Put /api/v1/cpm-optimizers/{id} Replace a CPM optimizer.
ApiV1CpmOptimizersPost Post /api/v1/cpm-optimizers Create a CPM optimizer.
ApiV1SourceOptimizerConfigGet Get /api/v1/source-optimizer/config Option values for the optimizer forms.

ApiV1CpaOptimizersGet

ApiV1CpaOptimizersGet(ctx).Execute()

List CPA optimizers.

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

ApiV1CpaOptimizersIdDelete

ApiV1CpaOptimizersIdDelete(ctx, id).Execute()

Delete a CPA optimizer.

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

ApiV1CpaOptimizersIdGet

ApiV1CpaOptimizersIdGet(ctx, id).Execute()

Show a CPA optimizer.

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

ApiV1CpaOptimizersIdPut

ApiV1CpaOptimizersIdPut(ctx, id).CpaOptimizerBody(cpaOptimizerBody).Execute()

Replace a CPA optimizer.

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	cpaOptimizerBody := *openapiclient.NewCpaOptimizerBody("Title_example", float32(123)) // CpaOptimizerBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SourceOptimizersAPI.ApiV1CpaOptimizersIdPut(context.Background(), id).CpaOptimizerBody(cpaOptimizerBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SourceOptimizersAPI.ApiV1CpaOptimizersIdPut``: %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 apiApiV1CpaOptimizersIdPutRequest struct via the builder pattern

Name Type Description Notes

cpaOptimizerBody | CpaOptimizerBody | |

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]

ApiV1CpaOptimizersPost

ApiV1CpaOptimizersPost(ctx).CpaOptimizerBody(cpaOptimizerBody).Execute()

Create a CPA optimizer.

Example

package main

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

func main() {
	cpaOptimizerBody := *openapiclient.NewCpaOptimizerBody("Title_example", float32(123)) // CpaOptimizerBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SourceOptimizersAPI.ApiV1CpaOptimizersPost(context.Background()).CpaOptimizerBody(cpaOptimizerBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SourceOptimizersAPI.ApiV1CpaOptimizersPost``: %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 apiApiV1CpaOptimizersPostRequest struct via the builder pattern

Name Type Description Notes
cpaOptimizerBody CpaOptimizerBody

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]

ApiV1CpmOptimizersActiveGet

ApiV1CpmOptimizersActiveGet(ctx).Execute()

Does the account have any CPM optimizer?

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

ApiV1CpmOptimizersGet

ApiV1CpmOptimizersGet(ctx).Execute()

List CPM optimizers.

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

ApiV1CpmOptimizersIdDelete

ApiV1CpmOptimizersIdDelete(ctx, id).Execute()

Delete a CPM optimizer.

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

ApiV1CpmOptimizersIdGet

ApiV1CpmOptimizersIdGet(ctx, id).Execute()

Show a CPM optimizer.

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

ApiV1CpmOptimizersIdPut

ApiV1CpmOptimizersIdPut(ctx, id).CpmOptimizerBody(cpmOptimizerBody).Execute()

Replace a CPM optimizer.

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	cpmOptimizerBody := *openapiclient.NewCpmOptimizerBody("Title_example", float32(123)) // CpmOptimizerBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SourceOptimizersAPI.ApiV1CpmOptimizersIdPut(context.Background(), id).CpmOptimizerBody(cpmOptimizerBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SourceOptimizersAPI.ApiV1CpmOptimizersIdPut``: %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 apiApiV1CpmOptimizersIdPutRequest struct via the builder pattern

Name Type Description Notes

cpmOptimizerBody | CpmOptimizerBody | |

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]

ApiV1CpmOptimizersPost

ApiV1CpmOptimizersPost(ctx).CpmOptimizerBody(cpmOptimizerBody).Execute()

Create a CPM optimizer.

Example

package main

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

func main() {
	cpmOptimizerBody := *openapiclient.NewCpmOptimizerBody("Title_example", float32(123)) // CpmOptimizerBody | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SourceOptimizersAPI.ApiV1CpmOptimizersPost(context.Background()).CpmOptimizerBody(cpmOptimizerBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SourceOptimizersAPI.ApiV1CpmOptimizersPost``: %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 apiApiV1CpmOptimizersPostRequest struct via the builder pattern

Name Type Description Notes
cpmOptimizerBody CpmOptimizerBody

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]

ApiV1SourceOptimizerConfigGet

ApiV1SourceOptimizerConfigGet(ctx).Execute()

Option values for the optimizer forms.

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