_go

package module
v0.0.0-...-44e64e0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 29, 2025 License: GPL-3.0 Imports: 7 Imported by: 0

README

adselect-go

Detailed documentation is available on the wiki: http://wiki.vektorone.goodguysoft.com/

The Go SDK from vektorone.co lets you integrate intelligent ad generation into your Go-based chat or web systems. It enables you to:

  • Send full chat history
  • Retrieve contextual ads based on conversations or web page content
  • Render ads in multiple formats (JSON, HTML, JavaScript)

All SDK functions use idiomatic Go error handling.

Installation

Install the SDK:

go get github.com/goodguysoft/adselect-go

Import in your application:

import adselect "github.com/goodguysoft/adselect-go"

Sending Chat History

Use SendChatHistory() to send complete conversation data to the API.

Function Signature:

func SendChatHistory(apiId string, apiKey string, userID string, conversationID string, messages []adselect.ChatMessage) error

Parameters:

  • apiId — Your VektorOne API ID (provided by support)
  • apiKey — Your VektorOne API Key
  • userID — Unique identifier for the human user receiving the ad
  • conversationID — Unique identifier for the chat session
  • messages — Slice of message objects containing roles and text

Message Format:

type ChatMessage struct {
    Role string // "User" or "Bot"
    Text string // Message content
}
  • Role — "User" (end user) or "Bot" (assistant, system, or agent)
  • Text — Message text content

Example:

messages := []adselect.ChatMessage{
    {Role: "User", Text: "I'm looking for dog food."},
    {Role: "Bot", Text: "We have natural dog food options."},
}

err := adselect.SendChatHistory("YOUR_API_ID", "YOUR_API_KEY", "user-123", "conv-456", messages)
if err != nil {
    log.Fatalf("failed to send chat history: %v", err)
}

Getting Ad for a Chat Session

Use GetChatAd() to fetch an ad based on chat context.

Function Signature:

func GetChatAd(apiId string, apiKey string, userID string, conversationID string, adType string, jsFunc string) (string, error)

Parameters:

  • apiId, apiKey — Credentials provided by VektorOne support
  • userID — Unique user identifier
  • conversationID — Current chat session ID
  • adType — Ad format:
    • adselect.AdTypeJsonText
    • adselect.AdTypeJsonImage
    • adselect.AdTypeHtmlTextAd
    • adselect.AdTypeHtmlImageAd
    • adselect.AdTypeJavaScriptText
    • adselect.AdTypeJavaScriptImage
    • adselect.AdTypeBannerMediumRectJson
    • adselect.AdTypeBannerMediumRectHtml
    • adselect.AdTypeBannerLeaderboardJson
    • adselect.AdTypeBannerLeaderboardHtml
    • adselect.AdTypeBannerWideSkyJson
    • adselect.AdTypeBannerWideSkyHtml
  • jsFunc — JavaScript callback name (for JavaScript ad type only)

Example:

adHtml, err := adselect.GetChatAd("YOUR_API_ID", "YOUR_API_KEY", "user-123", "conv-456", adselect.AdTypeHtmlTextAd, "")
if err != nil {
    log.Printf("failed to get ad: %v", err)
} else {
    fmt.Println("Ad HTML:", adHtml)
}

Getting Ad for a Web Page

Use GetPageAd() to retrieve an ad based on HTML page content.

Function Signature:

func GetPageAd(apiId string, apiKey string, pageContent string, adType adsdk.AdType, jsFunc string) (string, error)

Parameters:

  • apiId, apiKey — Your API credentials
  • pageContent — Raw HTML or text content of the page
  • adType — Desired ad output format:
    • adsdk.AdTypeJsonText
    • adsdk.AdTypeJsonImage
    • adsdk.AdTypeHtmlTextAd
    • adsdk.AdTypeHtmlImageAd
    • adsdk.AdTypeJavaScriptText
    • adsdk.AdTypeJavaScriptImage
    • adsdk.AdTypeBannerMediumRectJson
    • adsdk.AdTypeBannerMediumRectHtml
    • adsdk.AdTypeBannerLeaderboardJson
    • adsdk.AdTypeBannerLeaderboardHtml
    • adsdk.AdTypeBannerWideSkyJson
    • adsdk.AdTypeBannerWideSkyHtml
  • jsFunc — JavaScript callback name (for JavaScript ads only)

Example:

html := "<html><body><h1>Best dog food 2024</h1><p>Our guide covers natural ingredients...</p></body></html>"

adScript, err := adsdk.GetPageAd("YOUR_API_ID", "YOUR_API_KEY", html, adsdk.AdTypeJavaScript, "renderAd")
if err != nil {
    log.Printf("ad error: %v", err)
} else {
    fmt.Println("<script>" + adScript + "</script>")
}

AdType Constants

const (
    AdTypeJsonText              = "JsonText"
    AdTypeJsonImage             = "JsonImage"
    AdTypeHtmlText              = "HtmlTextAd"
    AdTypeHtmlImage             = "HtmlImageAd"
    AdTypeJavaScriptText        = "JavaScriptTextAd"
    AdTypeJavaScriptImage       = "JavaScriptImageAd"
    AdTypeBannerMediumRectJson  = "BannerMediumRectJson"
    AdTypeBannerMediumRectHtml  = "BannerMediumRectHtml"
    AdTypeBannerLeaderboardJson = "BannerLeaderboardJson"
    AdTypeBannerLeaderboardHtml = "BannerLeaderboardHtml"
    AdTypeBannerWideSkyJson     = "BannerWideSkyJson"
    AdTypeBannerWideSkyHtml     = "BannerWideSkyHtml"
)

Error Handling

All functions return a standard Go error type.

Always validate return values using:

if err != nil {
    // handle failure
}

See Also

Documentation

Index

Constants

View Source 
const (
	AdTypeText              = "text"
	AdTypeImage             = "image"
	AdTypeBannerMediumRect  = "Medium Rectangle Banner"
	AdTypeBannerLeaderboard = "Leaderboard Banner"
	AdTypeBannerWideSky     = "Wide Skyscraper Banner"
)
View Source 
const (
	ChatMessageRoleUser = "User"
	ChatMessageRoleBot  = "Bot"
)
View Source 
const (
	AdTypeJsonText              = "JsonText"
	AdTypeJsonImage             = "JsonImage"
	AdTypeHtmlText              = "HtmlTextAd"
	AdTypeHtmlImage             = "HtmlImageAd"
	AdTypeJavaScriptText        = "AdTypeJavaScriptText"
	AdTypeJavaScriptImage       = "AdTypeJavaScriptImage"
	AdTypeBannerMediumRectJson  = "AdTypeBannerMediumRectJson"
	AdTypeBannerLeaderboardJson = "AdTypeBannerLeaderboardJson"
	AdTypeBannerWideSkyJson     = "AdTypeBannerWideSkyJson"
	AdTypeBannerMediumRectHtml  = "AdTypeBannerMediumRectHtml"
	AdTypeBannerLeaderboardHtml = "AdTypeBannerLeaderboardHtml"
	AdTypeBannerWideSkyHtml     = "AdTypeBannerWideSkyHtml"
)
View Source 
const APIBaseURL = "http://147.93.43.199"

Variables

This section is empty.

Functions

func GenerateAd 

func GenerateAd(ad *Ad, adType string, jsFunc string) (string, error)

func GetChatAd 

func GetChatAd(apiId string, apiKey string, userID string, conversationID string, adType string, jsFunc string) (string, error)

func GetPageAd 

func GetPageAd(apiId string, apiKey string, pageContent string, adType string, jsFunc string) (string, error)

func PostAPIRequest 

func PostAPIRequest(relativeURL string, payload interface{}) (interface{}, error)

func SendChatHistory 

func SendChatHistory(apiId string, apiKey string, userID string, conversationID string, messages []ChatMessage) error

Types 

type Ad struct {
	ID          int    `json:"id"`
	URL         string `json:"url"`
	Title       string `json:"title"`
	Description string `json:"description"`
	ImageURL    string `json:"imageUrl"`
}

Ad represents an advertisement with basic properties.

type ChatMessage 

type ChatMessage struct {
	Role string `json:"Role"` // "User" or "Bot"
	Text string `json:"Text"` // Message content
}

type GetChatAdRequest 

type GetChatAdRequest struct {
	ApiID          string `json:"apiId"`
	ApiKey         string `json:"apiKey"`
	UserID         string `json:"userID"`
	ConversationID string `json:"conversationID"`
	Type           string `json:"type"`
}

type GetPageAdRequest 

type GetPageAdRequest struct {
	ApiID        string `json:"apiId"`
	ApiKey       string `json:"apiKey"`
	Type         string `json:"type"`
	PageContents string `json:"pageContents"` // Page HTML or plain text contents
}

GetPageAdRequest represents a request to get an ad for a page.

type SendChatHistoryRequest 

type SendChatHistoryRequest struct {
	ApiID          string        `json:"apiId"`
	ApiKey         string        `json:"apiKey"`
	UserID         string        `json:"userID"`
	ConversationID string        `json:"conversationID"`
	Messages       []ChatMessage `json:"messages"`
}

type ServiceResult 

type ServiceResult struct {
	Success bool        `json:"Success"`
	Data    interface{} `json:"Data,omitempty"`
	Errors  []string    `json:"Errors,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis
adselect module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.