Skip to content

Latest commit

 

History

History
1226 lines (769 loc) · 32.6 KB

LookupsAPI.md

File metadata and controls

1226 lines (769 loc) · 32.6 KB

\LookupsAPI

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

Method HTTP request Description
ApiV1LookupsAdspaceTypesGet Get /api/v1/lookups/adspace-types Adspace types the caller can publish on this tenant.
ApiV1LookupsAdzoneLocationsGet Get /api/v1/lookups/adzone-locations Adzone locations for the tenant.
ApiV1LookupsAdzonesGet Get /api/v1/lookups/adzones Find adzone ids (for adzone filters).
ApiV1LookupsBannerSizesGet Get /api/v1/lookups/banner-sizes Banner sizes for banner-flavored adspaces.
ApiV1LookupsBrowsersGet Get /api/v1/lookups/browsers Browser ids (optionally scoped by device type).
ApiV1LookupsCarriersGet Get /api/v1/lookups/carriers Mobile carriers (ids for carrier targeting).
ApiV1LookupsCategoriesGet Get /api/v1/lookups/categories Active sub-categories (optionally scoped to a main).
ApiV1LookupsDeviceTypesGet Get /api/v1/lookups/device-types Active device types for this tenant.
ApiV1LookupsDomainsGet Get /api/v1/lookups/domains Resolve domains to the ids domain filters store.
ApiV1LookupsIspsGet Get /api/v1/lookups/isps Find ISP ids (for ISP filters).
ApiV1LookupsLinkTypesGet Get /api/v1/lookups/link-types Active link types for the tenant.
ApiV1LookupsMainCategoriesGet Get /api/v1/lookups/main-categories Active main categories for the tenant.
ApiV1LookupsOperatingSystemsGet Get /api/v1/lookups/operating-systems Operating-system ids (optionally scoped by device type).
ApiV1LookupsPublishersGet Get /api/v1/lookups/publishers Find publisher ids (for publisher_excl filters).
ApiV1LookupsRatingsGet Get /api/v1/lookups/ratings Active content ratings for the tenant.
ApiV1LookupsReelTypesGet Get /api/v1/lookups/reel-types Active reel types for the tenant.
ApiV1LookupsRegionsGet Get /api/v1/lookups/regions Walk the geo region tree (one level per call).
ApiV1LookupsWebsiteLanguagesGet Get /api/v1/lookups/website-languages Supported website languages (ISO codes).
ApiV1LookupsWebsiteTypesGet Get /api/v1/lookups/website-types Active website types for the tenant.

ApiV1LookupsAdspaceTypesGet

ApiV1LookupsAdspaceTypesGet200Response ApiV1LookupsAdspaceTypesGet(ctx).Execute()

Adspace types the caller can publish on this tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsAdspaceTypesGet200Response

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]

ApiV1LookupsAdzoneLocationsGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsAdzoneLocationsGet(ctx).Execute()

Adzone locations for the tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]

ApiV1LookupsAdzonesGet

ApiV1LookupsAdzonesGet(ctx).Term(term).Bulk(bulk).Execute()

Find adzone ids (for adzone filters).

Example

package main

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

func main() {
	term := "term_example" // string |  (optional)
	bulk := "bulk_example" // string | Newline-separated adzone ids; wins over term. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.LookupsAPI.ApiV1LookupsAdzonesGet(context.Background()).Term(term).Bulk(bulk).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LookupsAPI.ApiV1LookupsAdzonesGet``: %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 apiApiV1LookupsAdzonesGetRequest struct via the builder pattern

Name Type Description Notes
term string
bulk string Newline-separated adzone ids; wins over term.

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]

ApiV1LookupsBannerSizesGet

ApiV1LookupsBannerSizesGet200Response ApiV1LookupsBannerSizesGet(ctx).Execute()

Banner sizes for banner-flavored adspaces.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsBannerSizesGet200Response

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]

ApiV1LookupsBrowsersGet

ApiV1LookupsBrowsersGet200Response ApiV1LookupsBrowsersGet(ctx).DeviceTypeIds(deviceTypeIds).Execute()

Browser ids (optionally scoped by device type).

Example

package main

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

func main() {
	deviceTypeIds := "1,2" // string | Comma-separated device-type ids from `GET /api/v1/lookups/device-types`. Empty = all. (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deviceTypeIds string Comma-separated device-type ids from `GET /api/v1/lookups/device-types`. Empty = all.

Return type

ApiV1LookupsBrowsersGet200Response

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]

ApiV1LookupsCarriersGet

ApiV1LookupsCarriersGet200Response ApiV1LookupsCarriersGet(ctx).Execute()

Mobile carriers (ids for carrier targeting).

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsCarriersGet200Response

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]

ApiV1LookupsCategoriesGet

ApiV1LookupsCategoriesGet200Response ApiV1LookupsCategoriesGet(ctx).MainCatid(mainCatid).Execute()

Active sub-categories (optionally scoped to a main).

Example

package main

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

func main() {
	mainCatid := int32(56) // int32 | Filter to categories under this main. (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
mainCatid int32 Filter to categories under this main.

Return type

ApiV1LookupsCategoriesGet200Response

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]

ApiV1LookupsDeviceTypesGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsDeviceTypesGet(ctx).Execute()

Active device types for this tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]

ApiV1LookupsDomainsGet

ApiV1LookupsDomainsGet(ctx).Bulk(bulk).Execute()

Resolve domains to the ids domain filters store.

Example

package main

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

func main() {
	bulk := "example.com https://www.spam.test/x 123" // string | 

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

Name Type Description Notes
bulk string

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]

ApiV1LookupsIspsGet

ApiV1LookupsIspsGet(ctx).Term(term).Bulk(bulk).Execute()

Find ISP ids (for ISP filters).

Example

package main

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

func main() {
	term := "term_example" // string |  (optional)
	bulk := "bulk_example" // string | Newline-separated name fragments; wins over term. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.LookupsAPI.ApiV1LookupsIspsGet(context.Background()).Term(term).Bulk(bulk).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LookupsAPI.ApiV1LookupsIspsGet``: %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 apiApiV1LookupsIspsGetRequest struct via the builder pattern

Name Type Description Notes
term string
bulk string Newline-separated name fragments; wins over term.

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]

ApiV1LookupsLinkTypesGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsLinkTypesGet(ctx).Execute()

Active link types for the tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]

ApiV1LookupsMainCategoriesGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsMainCategoriesGet(ctx).Execute()

Active main categories for the tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]

ApiV1LookupsOperatingSystemsGet

ApiV1LookupsBrowsersGet200Response ApiV1LookupsOperatingSystemsGet(ctx).DeviceTypeIds(deviceTypeIds).Execute()

Operating-system ids (optionally scoped by device type).

Example

package main

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

func main() {
	deviceTypeIds := "2" // string | Comma-separated device-type ids from `GET /api/v1/lookups/device-types`. Empty = all. (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deviceTypeIds string Comma-separated device-type ids from `GET /api/v1/lookups/device-types`. Empty = all.

Return type

ApiV1LookupsBrowsersGet200Response

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]

ApiV1LookupsPublishersGet

ApiV1LookupsPublishersGet(ctx).Term(term).Bulk(bulk).Execute()

Find publisher ids (for publisher_excl filters).

Example

package main

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

func main() {
	term := "term_example" // string |  (optional)
	bulk := "bulk_example" // string | Newline-separated publisher ids; wins over term. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.LookupsAPI.ApiV1LookupsPublishersGet(context.Background()).Term(term).Bulk(bulk).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `LookupsAPI.ApiV1LookupsPublishersGet``: %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 apiApiV1LookupsPublishersGetRequest struct via the builder pattern

Name Type Description Notes
term string
bulk string Newline-separated publisher ids; wins over term.

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]

ApiV1LookupsRatingsGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsRatingsGet(ctx).Execute()

Active content ratings for the tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]

ApiV1LookupsReelTypesGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsReelTypesGet(ctx).Execute()

Active reel types for the tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]

ApiV1LookupsRegionsGet

ApiV1LookupsRegionsGet200Response ApiV1LookupsRegionsGet(ctx).ParentId(parentId).Ids(ids).Execute()

Walk the geo region tree (one level per call).

Example

package main

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

func main() {
	parentId := int32(56) // int32 | Parent region id to list children of. 0 (default) returns continents. (optional) (default to 0)
	ids := "2300660,2635167" // string | Comma-separated region ids to look up directly instead of walking the tree (e.g. the ids in a campaign's `regions` field), up to 500; unknown ids are left out. The answer then carries `ids: true` and no `parent_id`. (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
parentId int32 Parent region id to list children of. 0 (default) returns continents. [default to 0]
ids string Comma-separated region ids to look up directly instead of walking the tree (e.g. the ids in a campaign's `regions` field), up to 500; unknown ids are left out. The answer then carries `ids: true` and no `parent_id`.

Return type

ApiV1LookupsRegionsGet200Response

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]

ApiV1LookupsWebsiteLanguagesGet

ApiV1LookupsWebsiteLanguagesGet200Response ApiV1LookupsWebsiteLanguagesGet(ctx).Execute()

Supported website languages (ISO codes).

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsWebsiteLanguagesGet200Response

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]

ApiV1LookupsWebsiteTypesGet

ApiV1LookupsDeviceTypesGet200Response ApiV1LookupsWebsiteTypesGet(ctx).Execute()

Active website types for the tenant.

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1LookupsDeviceTypesGet200Response

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]