Files

13 KiB

\AdAPI

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
DeleteAdCampaignsById Delete /v1/ad/campaigns/{id} Removes one of the caller org's campaigns and answers 204 with no body.
GetAdCampaigns Get /v1/ad/campaigns Returns the caller org's ad campaigns, most recently updated first, optionally narrowed to one lifecycle status.
GetAdCampaignsById Get /v1/ad/campaigns/{id} Returns one of the caller org's campaigns.
GetAdSummary Get /v1/ad/summary Rolls the caller org's ad campaigns up into four numbers: how many campaigns exist, how many are active, and the summed budget and spend across all of them.
PostAdCampaigns Post /v1/ad/campaigns Registers a new ad campaign for the caller's org and answers 201 with the stored row.
PostAdCampaignsByIdLaunch Post /v1/ad/campaigns/{id}/launch Run one of your stored campaigns on its ad network
PutAdCampaignsById Put /v1/ad/campaigns/{id} Replaces the user-owned fields of one of the caller org's campaigns and answers the stored row.

DeleteAdCampaignsById

DeleteAdCampaignsById(ctx, id).Execute()

Removes one of the caller org's campaigns and answers 204 with no body.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "camp_2f9c1d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdAPI.DeleteAdCampaignsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdAPI.DeleteAdCampaignsById``: %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 string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

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

GetAdCampaigns

AdCampaignList GetAdCampaigns(ctx).Status(status).Limit(limit).Execute()

Returns the caller org's ad campaigns, most recently updated first, optionally narrowed to one lifecycle status.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	status := "active" // string | Status filters to one lifecycle state (draft, active, paused, completed). Empty returns every campaign the org has. (optional)
	limit := int64(50) // int64 | Limit caps how many campaigns come back: default 200, maximum 1000. A value that is not a positive integer reads as the default. (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
status string Status filters to one lifecycle state (draft, active, paused, completed). Empty returns every campaign the org has.
limit int64 Limit caps how many campaigns come back: default 200, maximum 1000. A value that is not a positive integer reads as the default.

Return type

AdCampaignList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

GetAdCampaignsById

AdAdCampaign GetAdCampaignsById(ctx, id).Execute()

Returns one of the caller org's campaigns.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "camp_2f9c1d" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

AdAdCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

GetAdSummary

AdAdSummary GetAdSummary(ctx).Execute()

Rolls the caller org's ad campaigns up into four numbers: how many campaigns exist, how many are active, and the summed budget and spend across all of them.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AdAdSummary

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

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

PostAdCampaigns

AdAdCampaign PostAdCampaigns(ctx).AdCampaignInput(adCampaignInput).Execute()

Registers a new ad campaign for the caller's org and answers 201 with the stored row.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	adCampaignInput := *openapiclient.NewAdCampaignInput() // AdCampaignInput | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
adCampaignInput AdCampaignInput

Return type

AdAdCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

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

PostAdCampaignsByIdLaunch

PostAdCampaignsByIdLaunch(ctx, id).Execute()

Run one of your stored campaigns on its ad network

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdAPI.PostAdCampaignsByIdLaunch(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdAPI.PostAdCampaignsByIdLaunch``: %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 string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

PutAdCampaignsById

AdAdCampaign PutAdCampaignsById(ctx, id).AdUpdateCampaignIn(adUpdateCampaignIn).Execute()

Replaces the user-owned fields of one of the caller org's campaigns and answers the stored row.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "camp_2f9c1d" // string | 
	adUpdateCampaignIn := *openapiclient.NewAdUpdateCampaignIn() // AdUpdateCampaignIn | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

adUpdateCampaignIn | AdUpdateCampaignIn | |

Return type

AdAdCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

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