Skip to content

TrackerOffersAPI.md

Latest commit

 

History

History
642 lines (407 loc) · 19.2 KB

TrackerOffersAPI.md

File metadata and controls

642 lines (407 loc) · 19.2 KB
Raw

\TrackerOffersAPI

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

Method HTTP request Description
ApiV1TrackerOffersBulkPost Post /api/v1/tracker/offers/bulk Pause, activate or delete many offers.
ApiV1TrackerOffersGet Get /api/v1/tracker/offers List tracker offers.
ApiV1TrackerOffersIdDelete Delete /api/v1/tracker/offers/{id} Delete an offer.
ApiV1TrackerOffersIdGet Get /api/v1/tracker/offers/{id} Get one offer.
ApiV1TrackerOffersIdPut Put /api/v1/tracker/offers/{id} Update an offer.
ApiV1TrackerOffersIdUrlsPost Post /api/v1/tracker/offers/{id}/urls Add a landing URL to an offer.
ApiV1TrackerOffersIdUrlsUrlIdDelete Delete /api/v1/tracker/offers/{id}/urls/{urlId} Delete one landing URL.
ApiV1TrackerOffersIdUrlsUrlIdPut Put /api/v1/tracker/offers/{id}/urls/{urlId} Update one landing URL.
ApiV1TrackerOffersPost Post /api/v1/tracker/offers Create an offer.

ApiV1TrackerOffersBulkPost

ApiV1PublisherPushSubscribersActionPost200Response ApiV1TrackerOffersBulkPost(ctx).ApiV1TrackerOffersBulkPostRequest(apiV1TrackerOffersBulkPostRequest).Execute()

Pause, activate or delete many offers.

Example

package main

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

func main() {
	apiV1TrackerOffersBulkPostRequest := *openapiclient.NewApiV1TrackerOffersBulkPostRequest("Action_example", []int32{int32(123)}) // ApiV1TrackerOffersBulkPostRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1TrackerOffersBulkPostRequest ApiV1TrackerOffersBulkPostRequest

Return type

ApiV1PublisherPushSubscribersActionPost200Response

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]

ApiV1TrackerOffersGet

ApiV1TrackerOffersGet200Response ApiV1TrackerOffersGet(ctx).Execute()

List tracker offers.

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerOffersGet200Response

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]

ApiV1TrackerOffersIdDelete

ApiV1PublisherPushCampaignsIdDelete200Response ApiV1TrackerOffersIdDelete(ctx, id).Execute()

Delete an offer.

Example

package main

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

func main() {
	id := int32(56) // int32 | Offer ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ApiV1PublisherPushCampaignsIdDelete200Response

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]

ApiV1TrackerOffersIdGet

ApiV1TrackerOffersIdGet200Response ApiV1TrackerOffersIdGet(ctx, id).Execute()

Get one offer.

Example

package main

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

func main() {
	id := int32(56) // int32 | Offer ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

ApiV1TrackerOffersIdGet200Response

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]

ApiV1TrackerOffersIdPut

ApiV1PublisherPushCampaignsPost200Response ApiV1TrackerOffersIdPut(ctx, id).ApiV1TrackerOffersIdPutRequest(apiV1TrackerOffersIdPutRequest).Execute()

Update an offer.

Example

package main

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

func main() {
	id := int32(56) // int32 | Offer ID.
	apiV1TrackerOffersIdPutRequest := *openapiclient.NewApiV1TrackerOffersIdPutRequest() // ApiV1TrackerOffersIdPutRequest | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

apiV1TrackerOffersIdPutRequest | ApiV1TrackerOffersIdPutRequest | |

Return type

ApiV1PublisherPushCampaignsPost200Response

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]

ApiV1TrackerOffersIdUrlsPost

ApiV1PublisherPushCampaignsPost200Response ApiV1TrackerOffersIdUrlsPost(ctx, id).ApiV1TrackerOffersIdUrlsPostRequest(apiV1TrackerOffersIdUrlsPostRequest).Execute()

Add a landing URL to an offer.

Example

package main

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

func main() {
	id := int32(56) // int32 | Offer ID.
	apiV1TrackerOffersIdUrlsPostRequest := *openapiclient.NewApiV1TrackerOffersIdUrlsPostRequest("https://partner.example.com/lp2?clickid={clickid}") // ApiV1TrackerOffersIdUrlsPostRequest | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

apiV1TrackerOffersIdUrlsPostRequest | ApiV1TrackerOffersIdUrlsPostRequest | |

Return type

ApiV1PublisherPushCampaignsPost200Response

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]

ApiV1TrackerOffersIdUrlsUrlIdDelete

ApiV1PublisherPushCampaignsIdDelete200Response ApiV1TrackerOffersIdUrlsUrlIdDelete(ctx, id, urlId).Execute()

Delete one landing URL.

Example

package main

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

func main() {
	id := int32(56) // int32 | Offer ID.
	urlId := int32(56) // int32 | URL row ID.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 Offer ID.
urlId int32 URL row ID.

Other Parameters

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

Name Type Description Notes

Return type

ApiV1PublisherPushCampaignsIdDelete200Response

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]

ApiV1TrackerOffersIdUrlsUrlIdPut

ApiV1PublisherPushCampaignsPost200Response ApiV1TrackerOffersIdUrlsUrlIdPut(ctx, id, urlId).ApiV1TrackerOffersIdUrlsUrlIdPutRequest(apiV1TrackerOffersIdUrlsUrlIdPutRequest).Execute()

Update one landing URL.

Example

package main

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

func main() {
	id := int32(56) // int32 | Offer ID.
	urlId := int32(56) // int32 | URL row ID.
	apiV1TrackerOffersIdUrlsUrlIdPutRequest := *openapiclient.NewApiV1TrackerOffersIdUrlsUrlIdPutRequest() // ApiV1TrackerOffersIdUrlsUrlIdPutRequest | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 Offer ID.
urlId int32 URL row ID.

Other Parameters

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

Name Type Description Notes

apiV1TrackerOffersIdUrlsUrlIdPutRequest | ApiV1TrackerOffersIdUrlsUrlIdPutRequest | |

Return type

ApiV1PublisherPushCampaignsPost200Response

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]

ApiV1TrackerOffersPost

ApiV1PublisherPushCampaignsPost200Response ApiV1TrackerOffersPost(ctx).ApiV1TrackerOffersPostRequest(apiV1TrackerOffersPostRequest).Execute()

Create an offer.

Example

package main

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

func main() {
	apiV1TrackerOffersPostRequest := *openapiclient.NewApiV1TrackerOffersPostRequest("CrakRevenue — Dating US") // ApiV1TrackerOffersPostRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1TrackerOffersPostRequest ApiV1TrackerOffersPostRequest

Return type

ApiV1PublisherPushCampaignsPost200Response

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]