Skip to content

MarketDataAPI.md

Latest commit

 

History

History
403 lines (254 loc) · 9.58 KB

MarketDataAPI.md

File metadata and controls

403 lines (254 loc) · 9.58 KB
Raw

\MarketDataAPI

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

Method HTTP request Description
ApiV1PricingFiltersGet Get /api/v1/pricing/filters Labels for the pricing table's ids.
ApiV1PricingGet Get /api/v1/pricing Network floor prices (minimum bids).
ApiV1SmartNetworksGet Get /api/v1/smart-networks List the network's active smart networks.
ApiV1SmartNetworksIdGet Get /api/v1/smart-networks/{id} One smart network.
ApiV1VolumesFiltersGet Get /api/v1/volumes/filters Option lists for the volume query.
ApiV1VolumesGet Get /api/v1/volumes Available traffic volume per country (traffic estimate).

ApiV1PricingFiltersGet

ApiV1PricingFiltersGet(ctx).Execute()

Labels for the pricing table's ids.

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

ApiV1PricingGet

ApiV1PricingGet(ctx).Execute()

Network floor prices (minimum bids).

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

ApiV1SmartNetworksGet

ApiV1SmartNetworksGet(ctx).Search(search).FilterId(filterId).FilterName(filterName).Sort(sort).Page(page).PerPage(perPage).Execute()

List the network's active smart networks.

Example

package main

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

func main() {
	search := "search_example" // string |  (optional)
	filterId := int32(56) // int32 |  (optional)
	filterName := "filterName_example" // string |  (optional)
	sort := "sort_example" // string |  (optional)
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := int32(56) // int32 |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketDataAPI.ApiV1SmartNetworksGet(context.Background()).Search(search).FilterId(filterId).FilterName(filterName).Sort(sort).Page(page).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketDataAPI.ApiV1SmartNetworksGet``: %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 apiApiV1SmartNetworksGetRequest struct via the builder pattern

Name Type Description Notes
search string
filterId int32
filterName string
sort string
page int32 [default to 1]
perPage int32

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]

ApiV1SmartNetworksIdGet

ApiV1SmartNetworksIdGet(ctx, id).Execute()

One smart network.

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

ApiV1VolumesFiltersGet

ApiV1VolumesFiltersGet(ctx).Execute()

Option lists for the volume query.

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

ApiV1VolumesGet

ApiV1VolumesGet(ctx).Adtypeid(adtypeid).DeviceTypeid(deviceTypeid).ConnectionTypeid(connectionTypeid).Paytype(paytype).Execute()

Available traffic volume per country (traffic estimate).

Example

package main

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

func main() {
	adtypeid := int32(56) // int32 | 
	deviceTypeid := int32(56) // int32 | 
	connectionTypeid := int32(56) // int32 | 
	paytype := int32(56) // int32 | 0 CPC, 1 CPM (GET /api/v1/volumes/filters → pay_types). (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketDataAPI.ApiV1VolumesGet(context.Background()).Adtypeid(adtypeid).DeviceTypeid(deviceTypeid).ConnectionTypeid(connectionTypeid).Paytype(paytype).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketDataAPI.ApiV1VolumesGet``: %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 apiApiV1VolumesGetRequest struct via the builder pattern

Name Type Description Notes
adtypeid int32
deviceTypeid int32
connectionTypeid int32
paytype int32 0 CPC, 1 CPM (GET /api/v1/volumes/filters → pay_types).

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]