github.com/thetradedesk/ttd-workflows-go

Developer-friendly & type-safe Go SDK specifically catered to leverage github.com/thetradedesk/ttd-workflows-go API.

Summary

Workflows Service: This service provides operations for commonly used workflows on The Trade Desk's platform. In addition, this service provides generic operations for submitting:

GraphQL API requests
REST API requests

For further explanation on the entities encountered in this documentation (e.g., campaigns and ad groups), visit the Partner Portal.

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/thetradedesk/ttd-workflows-go

SDK Example Usage

Example: Submit job to retrieve third-party data

package main

import (
	"context"
	"fmt"
	"os"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"log"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("sandbox"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)
	res, err := s.Dmps.GetThirdPartyDataJob(ctx, &components.ThirdPartyDataInput{
		PartnerID: "<id>",
		QueryShape: ttdworkflows.String("nodes {id name}"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.StandardJobSubmitResponse != nil {
		if jobPtr := res.StandardJobSubmitResponse.GetID(); jobPtr != 0 {
			fmt.Println("Submitted job ID:", jobPtr)
		} else {
			fmt.Println("Job ID is nil")
		}
	} else {
		fmt.Println("Job submission failed")
	}
}

(Reference)

Example: Check status for third-party data retrieval job using job ID returned from submit job

package main

import (
	"context"
	"fmt"
	"log"
	"os"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("sandbox"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.JobStatus.Get(ctx, <id>)
	if err != nil {
		log.Fatal(err)
	}
	if res.StandardJobStatusResponse != nil {
		if completionPtr := res.StandardJobStatusResponse.CompletionPercentage; completionPtr != nil {
			fmt.Println("Job completion percentage:", *completionPtr)
			} else {
			fmt.Println("Job completion percentage is nil")
		}
	} else {
		fmt.Println("Getting job completion status failed")
	}
}

(Reference)

Example: Create campaign with minimal configuration

package main

import (
	"context"
	"fmt"
	"log"
	"os"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"github.com/thetradedesk/ttd-workflows-go/types"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("sandbox"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	var seedID = "<id>"

	res, err := s.Campaigns.CreateCampaign(ctx, &components.CampaignCreateWorkflowInputWithValidation{
		PrimaryInput: components.CampaignCreateWorkflowPrimaryInput{
			Name: "<value>",
			AdvertiserID: "<id>",
			SeedID: &seedID, // required, unless the advertiser has a default seed defined
			StartDateInUtc: types.MustNewTimeFromString("2026-07-08T10:52:56.944Z"),
			PrimaryChannel: components.CampaignChannelTypeDooh,
			PrimaryGoal: components.CampaignWorkflowROIGoalInput{
				MaximizeReach: ttdworkflows.Bool(true),
			},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.CampaignPayload != nil {
		if idPtr := res.CampaignPayload.GetCampaign().ID; idPtr != nil {
			fmt.Println("Campaign ID: ", *idPtr)
		} else {
			fmt.Println("Campaign ID is nil")
		}
	} else {
		fmt.Println("Campaign creation failed")
	}
}

(Reference)

Example: Submit GraphQL request

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("sandbox"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	query := `
query Advertiser($id: ID!) {
	advertiser(id: $id) {
		name
		totalCampaignChannelCount
		totalFunnelLocationCount
		useImpressionsOnlyBudgeting
		vettingStatus
		suggestedMeasurementProviderCategories
	}
}
`

	res, err := s.GraphQlRequests.Submit(ctx, &components.GraphQLRequestInput{
		Request: query,
		Variables: map[string]any{
			"id": "<id>",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		fmt.Println(res.Object)
	}
}

(Reference)

Example: Submit bulk GraphQL query job

Note: If you submit a GraphQL bulk query job (instead of a standard GraphQL request as shown above), any paginated and nested data is fully iterated and returned in a single output file.

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("sandbox"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	query := `
query AudiencesAcrossAdvertisers {
  partner(id: "<id>") {
	id
	name
	advertisers {
	  nodes {
		id
		name
		adGroups {
		  nodes {
			id
			name
			audience {
			  id
			  name
			  activeUniques {
				householdCount
				idsConnectedTvCount
				idsCount
				idsInAppCount
				idsWebCount
				lastUpdated
				personsCount
			  }
			}
		  }
		}
	  }
	}
  }
}
`

	res, err := s.GraphQlRequests.SubmitBulkQueryJob(ctx, &components.GraphQlQueryJobInput{
		Query: query,
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.GraphQlQueryJobResponse != nil {
		if jobPtr := res.GraphQlQueryJobResponse.GetPayload(); jobPtr != nil {
			fmt.Println(jobPtr.Data.ID);
		} else {
			fmt.Println("Job ID is nil")
		}
	} else {
		fmt.Println("Job submission failed")
	}
}

(Reference)

Example: Check status for bulk GraphQL query job

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("sandbox"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.Jobs.GetStatus(ctx, "<id>")
	if err != nil {
		log.Fatal(err)
	}
	if res.GraphQLQueryJobRetrievalResponse != nil {
		if jobPtr := res.GraphQLQueryJobRetrievalResponse.GetJob(); jobPtr != nil {
			fmt.Printf("Job completion: %.1f%%\n", *jobPtr.CompletionPercentage)
			if *jobPtr.CompletionPercentage == 100 {
				fmt.Println("\nResult URL:", *jobPtr.URL)
				fmt.Println("\nRaw result:", *jobPtr.RawResult)
			}
		}
	}
}

(Reference)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`TTDAuth`	apiKey	API key	`WORKFLOWS_TTD_AUTH`

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.AdGroups.Create(ctx, &components.AdGroupCreateWorkflowInputWithValidation{
		PrimaryInput: components.AdGroupCreateWorkflowPrimaryInput{
			IsEnabled:   ttdworkflows.Pointer(false),
			Description: ttdworkflows.Pointer("twine from gosh poor safely editor astride vice lost and"),
			Budget: &components.AdGroupWorkflowBudgetInput{
				AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
				BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](3786.02),
				BudgetInImpressions:             ttdworkflows.Pointer[int64](783190),
				DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](9747.02),
				DailyTargetInImpressions:        ttdworkflows.Pointer[int64](985999),
			},
			BaseBidCPMInAdvertiserCurrency: ttdworkflows.Pointer[float64](3785.04),
			MaxBidCPMInAdvertiserCurrency:  ttdworkflows.Pointer[float64](7447.3),
			AudienceTargeting: &components.AdGroupWorkflowAudienceTargetingInput{
				AudienceID:                           ttdworkflows.Pointer("<id>"),
				AudienceAcceleratorExclusionsEnabled: ttdworkflows.Pointer(true),
				AudienceBoosterEnabled:               ttdworkflows.Pointer(true),
				AudienceExcluderEnabled:              ttdworkflows.Pointer(true),
				AudiencePredictorEnabled:             ttdworkflows.Pointer(false),
				CrossDeviceVendorListForAudience: []int{
					107263,
				},
				RecencyExclusionWindowInMinutes: ttdworkflows.Pointer[int](90062),
				TargetTrackableUsersEnabled:     ttdworkflows.Pointer(true),
				UseMcIDAsPrimary:                ttdworkflows.Pointer(true),
			},
			RoiGoal: &components.AdGroupWorkflowROIGoalInput{
				MaximizeReach:               ttdworkflows.Pointer(true),
				MaximizeLtvIncrementalReach: ttdworkflows.Pointer(false),
				CpcInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2280.31),
				CtrInPercent:                nil,
				NielsenOTPInPercent:         ttdworkflows.Pointer[float64](5175.21),
				CpaInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2544.37),
				ReturnOnAdSpendPercent:      ttdworkflows.Pointer[float64](8201.47),
				VcrInPercent:                ttdworkflows.Pointer[float64](4846.08),
				ViewabilityInPercent:        nil,
				VcpmInAdvertiserCurrency:    ttdworkflows.Pointer[float64](4649.53),
				CpcvInAdvertiserCurrency:    ttdworkflows.Pointer[float64](313.95),
				MiaozhenOTPInPercent:        ttdworkflows.Pointer[float64](4704.1),
			},
			CreativeIds: nil,
			AssociatedBidLists: []components.AdGroupWorkflowAssociateBidListInput{
				components.AdGroupWorkflowAssociateBidListInput{
					BidListID:             "<id>",
					IsEnabled:             ttdworkflows.Pointer(false),
					IsDefaultForDimension: ttdworkflows.Pointer(true),
				},
			},
			Name:                                    ttdworkflows.Pointer("<value>"),
			Channel:                                 components.AdGroupChannelDisplay,
			FunnelLocation:                          components.AdGroupFunnelLocationConsideration,
			MarketType:                              components.MarketTypePrivateMarketOnly.ToPointer(),
			ProgrammaticGuaranteedPrivateContractID: ttdworkflows.Pointer("<id>"),
			IncludeDefaultsFromCampaign:             ttdworkflows.Pointer(false),
		},
		CampaignID: ttdworkflows.Pointer("<id>"),
		AdvancedInput: &components.AdGroupWorkflowAdvancedInput{
			KoaOptimizationSettings: &components.AdGroupWorkflowKoaOptimizationSettingsInput{
				AreFutureKoaFeaturesEnabled: ttdworkflows.Pointer(false),
				PredictiveClearingEnabled:   ttdworkflows.Pointer(false),
			},
			ComscoreSettings: &components.AdGroupWorkflowComscoreSettingsInput{
				IsEnabled:    false,
				PopulationID: nil,
				DemographicMemberIds: []int{
					959580,
					236376,
				},
				MobileDemographicMemberIds: []int{
					664689,
					827980,
					21321,
				},
			},
			ContractTargeting: &components.AdGroupWorkflowContractTargetingInput{
				AllowOpenMarketBiddingWhenTargetingContracts: ttdworkflows.Pointer(true),
			},
			DimensionalBiddingAutoOptimizationSettings: [][]components.DimensionalBiddingDimensions{
				[]components.DimensionalBiddingDimensions{},
				[]components.DimensionalBiddingDimensions{},
			},
			IsUseClicksAsConversionsEnabled:  ttdworkflows.Pointer(false),
			IsUseSecondaryConversionsEnabled: ttdworkflows.Pointer(false),
			NielsenTrackingAttributes: &components.AdGroupWorkflowNielsenTrackingAttributesInput{
				EnhancedReportingOption: components.EnhancedNielsenReportingOptionsInputSite.ToPointer(),
				Gender:                  components.TargetingGenderInputMale,
				StartAge:                components.TargetingStartAgeInputTwentyFive,
				EndAge:                  components.TargetingEndAgeInputSeventeen,
				Countries: []string{
					"<value 1>",
					"<value 2>",
					"<value 3>",
				},
			},
			NewFrequencyConfigs: []components.AdGroupWorkflowNewFrequencyConfigInput{
				components.AdGroupWorkflowNewFrequencyConfigInput{
					CounterName:            nil,
					FrequencyCap:           ttdworkflows.Pointer[int](375286),
					FrequencyGoal:          ttdworkflows.Pointer[int](534735),
					ResetIntervalInMinutes: ttdworkflows.Pointer[int](788122),
				},
			},
			Flights: []components.AdGroupWorkflowFlightInput{
				components.AdGroupWorkflowFlightInput{
					AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
					BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](4070.96),
					BudgetInImpressions:             ttdworkflows.Pointer[int64](901477),
					DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](5847.35),
					DailyTargetInImpressions:        ttdworkflows.Pointer[int64](257517),
					CampaignFlightID:                874887,
				},
			},
			CallerSource: ttdworkflows.Pointer("<value>"),
		},
		ValidateInputOnly: ttdworkflows.Pointer(true),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.AdGroupPayload != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

AdGroups

Create - Create a new ad group
Update - Update an ad group
Archive - Archive multiple ad groups
BulkCreate - Submit a job to create multiple new ad groups
BulkUpdate - Submit a job to update multiple ad groups

Campaigns

CreateCampaign - Create a new campaign
Update - Update a campaign
BulkCreate - Submit a job to create multiple new campaigns
BulkUpdate - Submit a job to update multiple campaigns
Archive - Archive multiple campaigns
GetCampaignVersion - Get a campaign's version

Dmps

GetFirstPartyDataJob - Submit a job for first-party data retrieval for an advertiser
GetThirdPartyDataJob - Submit a job for third-party data retrieval for a partner

GraphQLRequest

SubmitGraphQlBulkQueryJob - Submit a valid bulk GraphQL query job

GraphQlRequests

Submit - Submit a valid GraphQL query or mutation

JobStatus

GetGraphQlBulkJobStatus - Get the status of a previously submitted GraphQL bulk job
Get - Get the status of a previously submitted job

RestRequests

Submit - Submit a valid REST request

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"github.com/thetradedesk/ttd-workflows-go/retry"
	"log"
	"models/operations"
	"os"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.AdGroups.Create(ctx, &components.AdGroupCreateWorkflowInputWithValidation{
		PrimaryInput: components.AdGroupCreateWorkflowPrimaryInput{
			IsEnabled:   ttdworkflows.Pointer(false),
			Description: ttdworkflows.Pointer("twine from gosh poor safely editor astride vice lost and"),
			Budget: &components.AdGroupWorkflowBudgetInput{
				AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
				BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](3786.02),
				BudgetInImpressions:             ttdworkflows.Pointer[int64](783190),
				DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](9747.02),
				DailyTargetInImpressions:        ttdworkflows.Pointer[int64](985999),
			},
			BaseBidCPMInAdvertiserCurrency: ttdworkflows.Pointer[float64](3785.04),
			MaxBidCPMInAdvertiserCurrency:  ttdworkflows.Pointer[float64](7447.3),
			AudienceTargeting: &components.AdGroupWorkflowAudienceTargetingInput{
				AudienceID:                           ttdworkflows.Pointer("<id>"),
				AudienceAcceleratorExclusionsEnabled: ttdworkflows.Pointer(true),
				AudienceBoosterEnabled:               ttdworkflows.Pointer(true),
				AudienceExcluderEnabled:              ttdworkflows.Pointer(true),
				AudiencePredictorEnabled:             ttdworkflows.Pointer(false),
				CrossDeviceVendorListForAudience: []int{
					107263,
				},
				RecencyExclusionWindowInMinutes: ttdworkflows.Pointer[int](90062),
				TargetTrackableUsersEnabled:     ttdworkflows.Pointer(true),
				UseMcIDAsPrimary:                ttdworkflows.Pointer(true),
			},
			RoiGoal: &components.AdGroupWorkflowROIGoalInput{
				MaximizeReach:               ttdworkflows.Pointer(true),
				MaximizeLtvIncrementalReach: ttdworkflows.Pointer(false),
				CpcInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2280.31),
				CtrInPercent:                nil,
				NielsenOTPInPercent:         ttdworkflows.Pointer[float64](5175.21),
				CpaInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2544.37),
				ReturnOnAdSpendPercent:      ttdworkflows.Pointer[float64](8201.47),
				VcrInPercent:                ttdworkflows.Pointer[float64](4846.08),
				ViewabilityInPercent:        nil,
				VcpmInAdvertiserCurrency:    ttdworkflows.Pointer[float64](4649.53),
				CpcvInAdvertiserCurrency:    ttdworkflows.Pointer[float64](313.95),
				MiaozhenOTPInPercent:        ttdworkflows.Pointer[float64](4704.1),
			},
			CreativeIds: nil,
			AssociatedBidLists: []components.AdGroupWorkflowAssociateBidListInput{
				components.AdGroupWorkflowAssociateBidListInput{
					BidListID:             "<id>",
					IsEnabled:             ttdworkflows.Pointer(false),
					IsDefaultForDimension: ttdworkflows.Pointer(true),
				},
			},
			Name:                                    ttdworkflows.Pointer("<value>"),
			Channel:                                 components.AdGroupChannelDisplay,
			FunnelLocation:                          components.AdGroupFunnelLocationConsideration,
			MarketType:                              components.MarketTypePrivateMarketOnly.ToPointer(),
			ProgrammaticGuaranteedPrivateContractID: ttdworkflows.Pointer("<id>"),
			IncludeDefaultsFromCampaign:             ttdworkflows.Pointer(false),
		},
		CampaignID: ttdworkflows.Pointer("<id>"),
		AdvancedInput: &components.AdGroupWorkflowAdvancedInput{
			KoaOptimizationSettings: &components.AdGroupWorkflowKoaOptimizationSettingsInput{
				AreFutureKoaFeaturesEnabled: ttdworkflows.Pointer(false),
				PredictiveClearingEnabled:   ttdworkflows.Pointer(false),
			},
			ComscoreSettings: &components.AdGroupWorkflowComscoreSettingsInput{
				IsEnabled:    false,
				PopulationID: nil,
				DemographicMemberIds: []int{
					959580,
					236376,
				},
				MobileDemographicMemberIds: []int{
					664689,
					827980,
					21321,
				},
			},
			ContractTargeting: &components.AdGroupWorkflowContractTargetingInput{
				AllowOpenMarketBiddingWhenTargetingContracts: ttdworkflows.Pointer(true),
			},
			DimensionalBiddingAutoOptimizationSettings: [][]components.DimensionalBiddingDimensions{
				[]components.DimensionalBiddingDimensions{},
				[]components.DimensionalBiddingDimensions{},
			},
			IsUseClicksAsConversionsEnabled:  ttdworkflows.Pointer(false),
			IsUseSecondaryConversionsEnabled: ttdworkflows.Pointer(false),
			NielsenTrackingAttributes: &components.AdGroupWorkflowNielsenTrackingAttributesInput{
				EnhancedReportingOption: components.EnhancedNielsenReportingOptionsInputSite.ToPointer(),
				Gender:                  components.TargetingGenderInputMale,
				StartAge:                components.TargetingStartAgeInputTwentyFive,
				EndAge:                  components.TargetingEndAgeInputSeventeen,
				Countries: []string{
					"<value 1>",
					"<value 2>",
					"<value 3>",
				},
			},
			NewFrequencyConfigs: []components.AdGroupWorkflowNewFrequencyConfigInput{
				components.AdGroupWorkflowNewFrequencyConfigInput{
					CounterName:            nil,
					FrequencyCap:           ttdworkflows.Pointer[int](375286),
					FrequencyGoal:          ttdworkflows.Pointer[int](534735),
					ResetIntervalInMinutes: ttdworkflows.Pointer[int](788122),
				},
			},
			Flights: []components.AdGroupWorkflowFlightInput{
				components.AdGroupWorkflowFlightInput{
					AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
					BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](4070.96),
					BudgetInImpressions:             ttdworkflows.Pointer[int64](901477),
					DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](5847.35),
					DailyTargetInImpressions:        ttdworkflows.Pointer[int64](257517),
					CampaignFlightID:                874887,
				},
			},
			CallerSource: ttdworkflows.Pointer("<value>"),
		},
		ValidateInputOnly: ttdworkflows.Pointer(true),
	}, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.AdGroupPayload != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"github.com/thetradedesk/ttd-workflows-go/retry"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.AdGroups.Create(ctx, &components.AdGroupCreateWorkflowInputWithValidation{
		PrimaryInput: components.AdGroupCreateWorkflowPrimaryInput{
			IsEnabled:   ttdworkflows.Pointer(false),
			Description: ttdworkflows.Pointer("twine from gosh poor safely editor astride vice lost and"),
			Budget: &components.AdGroupWorkflowBudgetInput{
				AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
				BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](3786.02),
				BudgetInImpressions:             ttdworkflows.Pointer[int64](783190),
				DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](9747.02),
				DailyTargetInImpressions:        ttdworkflows.Pointer[int64](985999),
			},
			BaseBidCPMInAdvertiserCurrency: ttdworkflows.Pointer[float64](3785.04),
			MaxBidCPMInAdvertiserCurrency:  ttdworkflows.Pointer[float64](7447.3),
			AudienceTargeting: &components.AdGroupWorkflowAudienceTargetingInput{
				AudienceID:                           ttdworkflows.Pointer("<id>"),
				AudienceAcceleratorExclusionsEnabled: ttdworkflows.Pointer(true),
				AudienceBoosterEnabled:               ttdworkflows.Pointer(true),
				AudienceExcluderEnabled:              ttdworkflows.Pointer(true),
				AudiencePredictorEnabled:             ttdworkflows.Pointer(false),
				CrossDeviceVendorListForAudience: []int{
					107263,
				},
				RecencyExclusionWindowInMinutes: ttdworkflows.Pointer[int](90062),
				TargetTrackableUsersEnabled:     ttdworkflows.Pointer(true),
				UseMcIDAsPrimary:                ttdworkflows.Pointer(true),
			},
			RoiGoal: &components.AdGroupWorkflowROIGoalInput{
				MaximizeReach:               ttdworkflows.Pointer(true),
				MaximizeLtvIncrementalReach: ttdworkflows.Pointer(false),
				CpcInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2280.31),
				CtrInPercent:                nil,
				NielsenOTPInPercent:         ttdworkflows.Pointer[float64](5175.21),
				CpaInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2544.37),
				ReturnOnAdSpendPercent:      ttdworkflows.Pointer[float64](8201.47),
				VcrInPercent:                ttdworkflows.Pointer[float64](4846.08),
				ViewabilityInPercent:        nil,
				VcpmInAdvertiserCurrency:    ttdworkflows.Pointer[float64](4649.53),
				CpcvInAdvertiserCurrency:    ttdworkflows.Pointer[float64](313.95),
				MiaozhenOTPInPercent:        ttdworkflows.Pointer[float64](4704.1),
			},
			CreativeIds: nil,
			AssociatedBidLists: []components.AdGroupWorkflowAssociateBidListInput{
				components.AdGroupWorkflowAssociateBidListInput{
					BidListID:             "<id>",
					IsEnabled:             ttdworkflows.Pointer(false),
					IsDefaultForDimension: ttdworkflows.Pointer(true),
				},
			},
			Name:                                    ttdworkflows.Pointer("<value>"),
			Channel:                                 components.AdGroupChannelDisplay,
			FunnelLocation:                          components.AdGroupFunnelLocationConsideration,
			MarketType:                              components.MarketTypePrivateMarketOnly.ToPointer(),
			ProgrammaticGuaranteedPrivateContractID: ttdworkflows.Pointer("<id>"),
			IncludeDefaultsFromCampaign:             ttdworkflows.Pointer(false),
		},
		CampaignID: ttdworkflows.Pointer("<id>"),
		AdvancedInput: &components.AdGroupWorkflowAdvancedInput{
			KoaOptimizationSettings: &components.AdGroupWorkflowKoaOptimizationSettingsInput{
				AreFutureKoaFeaturesEnabled: ttdworkflows.Pointer(false),
				PredictiveClearingEnabled:   ttdworkflows.Pointer(false),
			},
			ComscoreSettings: &components.AdGroupWorkflowComscoreSettingsInput{
				IsEnabled:    false,
				PopulationID: nil,
				DemographicMemberIds: []int{
					959580,
					236376,
				},
				MobileDemographicMemberIds: []int{
					664689,
					827980,
					21321,
				},
			},
			ContractTargeting: &components.AdGroupWorkflowContractTargetingInput{
				AllowOpenMarketBiddingWhenTargetingContracts: ttdworkflows.Pointer(true),
			},
			DimensionalBiddingAutoOptimizationSettings: [][]components.DimensionalBiddingDimensions{
				[]components.DimensionalBiddingDimensions{},
				[]components.DimensionalBiddingDimensions{},
			},
			IsUseClicksAsConversionsEnabled:  ttdworkflows.Pointer(false),
			IsUseSecondaryConversionsEnabled: ttdworkflows.Pointer(false),
			NielsenTrackingAttributes: &components.AdGroupWorkflowNielsenTrackingAttributesInput{
				EnhancedReportingOption: components.EnhancedNielsenReportingOptionsInputSite.ToPointer(),
				Gender:                  components.TargetingGenderInputMale,
				StartAge:                components.TargetingStartAgeInputTwentyFive,
				EndAge:                  components.TargetingEndAgeInputSeventeen,
				Countries: []string{
					"<value 1>",
					"<value 2>",
					"<value 3>",
				},
			},
			NewFrequencyConfigs: []components.AdGroupWorkflowNewFrequencyConfigInput{
				components.AdGroupWorkflowNewFrequencyConfigInput{
					CounterName:            nil,
					FrequencyCap:           ttdworkflows.Pointer[int](375286),
					FrequencyGoal:          ttdworkflows.Pointer[int](534735),
					ResetIntervalInMinutes: ttdworkflows.Pointer[int](788122),
				},
			},
			Flights: []components.AdGroupWorkflowFlightInput{
				components.AdGroupWorkflowFlightInput{
					AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
					BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](4070.96),
					BudgetInImpressions:             ttdworkflows.Pointer[int64](901477),
					DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](5847.35),
					DailyTargetInImpressions:        ttdworkflows.Pointer[int64](257517),
					CampaignFlightID:                874887,
				},
			},
			CallerSource: ttdworkflows.Pointer("<value>"),
		},
		ValidateInputOnly: ttdworkflows.Pointer(true),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.AdGroupPayload != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return apierrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the Create function may return the following errors:

Error Type	Status Code	Content Type
apierrors.ProblemDetailsError	400, 403	application/json
apierrors.APIError	4XX, 5XX	/

Example

package main

import (
	"context"
	"errors"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/apierrors"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.AdGroups.Create(ctx, &components.AdGroupCreateWorkflowInputWithValidation{
		PrimaryInput: components.AdGroupCreateWorkflowPrimaryInput{
			IsEnabled:   ttdworkflows.Pointer(false),
			Description: ttdworkflows.Pointer("twine from gosh poor safely editor astride vice lost and"),
			Budget: &components.AdGroupWorkflowBudgetInput{
				AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
				BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](3786.02),
				BudgetInImpressions:             ttdworkflows.Pointer[int64](783190),
				DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](9747.02),
				DailyTargetInImpressions:        ttdworkflows.Pointer[int64](985999),
			},
			BaseBidCPMInAdvertiserCurrency: ttdworkflows.Pointer[float64](3785.04),
			MaxBidCPMInAdvertiserCurrency:  ttdworkflows.Pointer[float64](7447.3),
			AudienceTargeting: &components.AdGroupWorkflowAudienceTargetingInput{
				AudienceID:                           ttdworkflows.Pointer("<id>"),
				AudienceAcceleratorExclusionsEnabled: ttdworkflows.Pointer(true),
				AudienceBoosterEnabled:               ttdworkflows.Pointer(true),
				AudienceExcluderEnabled:              ttdworkflows.Pointer(true),
				AudiencePredictorEnabled:             ttdworkflows.Pointer(false),
				CrossDeviceVendorListForAudience: []int{
					107263,
				},
				RecencyExclusionWindowInMinutes: ttdworkflows.Pointer[int](90062),
				TargetTrackableUsersEnabled:     ttdworkflows.Pointer(true),
				UseMcIDAsPrimary:                ttdworkflows.Pointer(true),
			},
			RoiGoal: &components.AdGroupWorkflowROIGoalInput{
				MaximizeReach:               ttdworkflows.Pointer(true),
				MaximizeLtvIncrementalReach: ttdworkflows.Pointer(false),
				CpcInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2280.31),
				CtrInPercent:                nil,
				NielsenOTPInPercent:         ttdworkflows.Pointer[float64](5175.21),
				CpaInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2544.37),
				ReturnOnAdSpendPercent:      ttdworkflows.Pointer[float64](8201.47),
				VcrInPercent:                ttdworkflows.Pointer[float64](4846.08),
				ViewabilityInPercent:        nil,
				VcpmInAdvertiserCurrency:    ttdworkflows.Pointer[float64](4649.53),
				CpcvInAdvertiserCurrency:    ttdworkflows.Pointer[float64](313.95),
				MiaozhenOTPInPercent:        ttdworkflows.Pointer[float64](4704.1),
			},
			CreativeIds: nil,
			AssociatedBidLists: []components.AdGroupWorkflowAssociateBidListInput{
				components.AdGroupWorkflowAssociateBidListInput{
					BidListID:             "<id>",
					IsEnabled:             ttdworkflows.Pointer(false),
					IsDefaultForDimension: ttdworkflows.Pointer(true),
				},
			},
			Name:                                    ttdworkflows.Pointer("<value>"),
			Channel:                                 components.AdGroupChannelDisplay,
			FunnelLocation:                          components.AdGroupFunnelLocationConsideration,
			MarketType:                              components.MarketTypePrivateMarketOnly.ToPointer(),
			ProgrammaticGuaranteedPrivateContractID: ttdworkflows.Pointer("<id>"),
			IncludeDefaultsFromCampaign:             ttdworkflows.Pointer(false),
		},
		CampaignID: ttdworkflows.Pointer("<id>"),
		AdvancedInput: &components.AdGroupWorkflowAdvancedInput{
			KoaOptimizationSettings: &components.AdGroupWorkflowKoaOptimizationSettingsInput{
				AreFutureKoaFeaturesEnabled: ttdworkflows.Pointer(false),
				PredictiveClearingEnabled:   ttdworkflows.Pointer(false),
			},
			ComscoreSettings: &components.AdGroupWorkflowComscoreSettingsInput{
				IsEnabled:    false,
				PopulationID: nil,
				DemographicMemberIds: []int{
					959580,
					236376,
				},
				MobileDemographicMemberIds: []int{
					664689,
					827980,
					21321,
				},
			},
			ContractTargeting: &components.AdGroupWorkflowContractTargetingInput{
				AllowOpenMarketBiddingWhenTargetingContracts: ttdworkflows.Pointer(true),
			},
			DimensionalBiddingAutoOptimizationSettings: [][]components.DimensionalBiddingDimensions{
				[]components.DimensionalBiddingDimensions{},
				[]components.DimensionalBiddingDimensions{},
			},
			IsUseClicksAsConversionsEnabled:  ttdworkflows.Pointer(false),
			IsUseSecondaryConversionsEnabled: ttdworkflows.Pointer(false),
			NielsenTrackingAttributes: &components.AdGroupWorkflowNielsenTrackingAttributesInput{
				EnhancedReportingOption: components.EnhancedNielsenReportingOptionsInputSite.ToPointer(),
				Gender:                  components.TargetingGenderInputMale,
				StartAge:                components.TargetingStartAgeInputTwentyFive,
				EndAge:                  components.TargetingEndAgeInputSeventeen,
				Countries: []string{
					"<value 1>",
					"<value 2>",
					"<value 3>",
				},
			},
			NewFrequencyConfigs: []components.AdGroupWorkflowNewFrequencyConfigInput{
				components.AdGroupWorkflowNewFrequencyConfigInput{
					CounterName:            nil,
					FrequencyCap:           ttdworkflows.Pointer[int](375286),
					FrequencyGoal:          ttdworkflows.Pointer[int](534735),
					ResetIntervalInMinutes: ttdworkflows.Pointer[int](788122),
				},
			},
			Flights: []components.AdGroupWorkflowFlightInput{
				components.AdGroupWorkflowFlightInput{
					AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
					BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](4070.96),
					BudgetInImpressions:             ttdworkflows.Pointer[int64](901477),
					DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](5847.35),
					DailyTargetInImpressions:        ttdworkflows.Pointer[int64](257517),
					CampaignFlightID:                874887,
				},
			},
			CallerSource: ttdworkflows.Pointer("<value>"),
		},
		ValidateInputOnly: ttdworkflows.Pointer(true),
	})
	if err != nil {

		var e *apierrors.ProblemDetailsError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *apierrors.APIError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Name

You can override the default server globally using the WithServer(server string) option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
`prod`	`https://api.thetradedesk.com/workflows`	The production environment.
`sandbox`	`https://ext-api.sb.thetradedesk.com/workflows`	The sandbox environment for testing.

Example

package main

import (
	"context"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServer("prod"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.AdGroups.Create(ctx, &components.AdGroupCreateWorkflowInputWithValidation{
		PrimaryInput: components.AdGroupCreateWorkflowPrimaryInput{
			IsEnabled:   ttdworkflows.Pointer(false),
			Description: ttdworkflows.Pointer("twine from gosh poor safely editor astride vice lost and"),
			Budget: &components.AdGroupWorkflowBudgetInput{
				AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
				BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](3786.02),
				BudgetInImpressions:             ttdworkflows.Pointer[int64](783190),
				DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](9747.02),
				DailyTargetInImpressions:        ttdworkflows.Pointer[int64](985999),
			},
			BaseBidCPMInAdvertiserCurrency: ttdworkflows.Pointer[float64](3785.04),
			MaxBidCPMInAdvertiserCurrency:  ttdworkflows.Pointer[float64](7447.3),
			AudienceTargeting: &components.AdGroupWorkflowAudienceTargetingInput{
				AudienceID:                           ttdworkflows.Pointer("<id>"),
				AudienceAcceleratorExclusionsEnabled: ttdworkflows.Pointer(true),
				AudienceBoosterEnabled:               ttdworkflows.Pointer(true),
				AudienceExcluderEnabled:              ttdworkflows.Pointer(true),
				AudiencePredictorEnabled:             ttdworkflows.Pointer(false),
				CrossDeviceVendorListForAudience: []int{
					107263,
				},
				RecencyExclusionWindowInMinutes: ttdworkflows.Pointer[int](90062),
				TargetTrackableUsersEnabled:     ttdworkflows.Pointer(true),
				UseMcIDAsPrimary:                ttdworkflows.Pointer(true),
			},
			RoiGoal: &components.AdGroupWorkflowROIGoalInput{
				MaximizeReach:               ttdworkflows.Pointer(true),
				MaximizeLtvIncrementalReach: ttdworkflows.Pointer(false),
				CpcInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2280.31),
				CtrInPercent:                nil,
				NielsenOTPInPercent:         ttdworkflows.Pointer[float64](5175.21),
				CpaInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2544.37),
				ReturnOnAdSpendPercent:      ttdworkflows.Pointer[float64](8201.47),
				VcrInPercent:                ttdworkflows.Pointer[float64](4846.08),
				ViewabilityInPercent:        nil,
				VcpmInAdvertiserCurrency:    ttdworkflows.Pointer[float64](4649.53),
				CpcvInAdvertiserCurrency:    ttdworkflows.Pointer[float64](313.95),
				MiaozhenOTPInPercent:        ttdworkflows.Pointer[float64](4704.1),
			},
			CreativeIds: nil,
			AssociatedBidLists: []components.AdGroupWorkflowAssociateBidListInput{
				components.AdGroupWorkflowAssociateBidListInput{
					BidListID:             "<id>",
					IsEnabled:             ttdworkflows.Pointer(false),
					IsDefaultForDimension: ttdworkflows.Pointer(true),
				},
			},
			Name:                                    ttdworkflows.Pointer("<value>"),
			Channel:                                 components.AdGroupChannelDisplay,
			FunnelLocation:                          components.AdGroupFunnelLocationConsideration,
			MarketType:                              components.MarketTypePrivateMarketOnly.ToPointer(),
			ProgrammaticGuaranteedPrivateContractID: ttdworkflows.Pointer("<id>"),
			IncludeDefaultsFromCampaign:             ttdworkflows.Pointer(false),
		},
		CampaignID: ttdworkflows.Pointer("<id>"),
		AdvancedInput: &components.AdGroupWorkflowAdvancedInput{
			KoaOptimizationSettings: &components.AdGroupWorkflowKoaOptimizationSettingsInput{
				AreFutureKoaFeaturesEnabled: ttdworkflows.Pointer(false),
				PredictiveClearingEnabled:   ttdworkflows.Pointer(false),
			},
			ComscoreSettings: &components.AdGroupWorkflowComscoreSettingsInput{
				IsEnabled:    false,
				PopulationID: nil,
				DemographicMemberIds: []int{
					959580,
					236376,
				},
				MobileDemographicMemberIds: []int{
					664689,
					827980,
					21321,
				},
			},
			ContractTargeting: &components.AdGroupWorkflowContractTargetingInput{
				AllowOpenMarketBiddingWhenTargetingContracts: ttdworkflows.Pointer(true),
			},
			DimensionalBiddingAutoOptimizationSettings: [][]components.DimensionalBiddingDimensions{
				[]components.DimensionalBiddingDimensions{},
				[]components.DimensionalBiddingDimensions{},
			},
			IsUseClicksAsConversionsEnabled:  ttdworkflows.Pointer(false),
			IsUseSecondaryConversionsEnabled: ttdworkflows.Pointer(false),
			NielsenTrackingAttributes: &components.AdGroupWorkflowNielsenTrackingAttributesInput{
				EnhancedReportingOption: components.EnhancedNielsenReportingOptionsInputSite.ToPointer(),
				Gender:                  components.TargetingGenderInputMale,
				StartAge:                components.TargetingStartAgeInputTwentyFive,
				EndAge:                  components.TargetingEndAgeInputSeventeen,
				Countries: []string{
					"<value 1>",
					"<value 2>",
					"<value 3>",
				},
			},
			NewFrequencyConfigs: []components.AdGroupWorkflowNewFrequencyConfigInput{
				components.AdGroupWorkflowNewFrequencyConfigInput{
					CounterName:            nil,
					FrequencyCap:           ttdworkflows.Pointer[int](375286),
					FrequencyGoal:          ttdworkflows.Pointer[int](534735),
					ResetIntervalInMinutes: ttdworkflows.Pointer[int](788122),
				},
			},
			Flights: []components.AdGroupWorkflowFlightInput{
				components.AdGroupWorkflowFlightInput{
					AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
					BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](4070.96),
					BudgetInImpressions:             ttdworkflows.Pointer[int64](901477),
					DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](5847.35),
					DailyTargetInImpressions:        ttdworkflows.Pointer[int64](257517),
					CampaignFlightID:                874887,
				},
			},
			CallerSource: ttdworkflows.Pointer("<value>"),
		},
		ValidateInputOnly: ttdworkflows.Pointer(true),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.AdGroupPayload != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	ttdworkflows "github.com/thetradedesk/ttd-workflows-go"
	"github.com/thetradedesk/ttd-workflows-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := ttdworkflows.New(
		ttdworkflows.WithServerURL("https://api.thetradedesk.com/workflows"),
		ttdworkflows.WithSecurity(os.Getenv("WORKFLOWS_TTD_AUTH")),
	)

	res, err := s.AdGroups.Create(ctx, &components.AdGroupCreateWorkflowInputWithValidation{
		PrimaryInput: components.AdGroupCreateWorkflowPrimaryInput{
			IsEnabled:   ttdworkflows.Pointer(false),
			Description: ttdworkflows.Pointer("twine from gosh poor safely editor astride vice lost and"),
			Budget: &components.AdGroupWorkflowBudgetInput{
				AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
				BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](3786.02),
				BudgetInImpressions:             ttdworkflows.Pointer[int64](783190),
				DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](9747.02),
				DailyTargetInImpressions:        ttdworkflows.Pointer[int64](985999),
			},
			BaseBidCPMInAdvertiserCurrency: ttdworkflows.Pointer[float64](3785.04),
			MaxBidCPMInAdvertiserCurrency:  ttdworkflows.Pointer[float64](7447.3),
			AudienceTargeting: &components.AdGroupWorkflowAudienceTargetingInput{
				AudienceID:                           ttdworkflows.Pointer("<id>"),
				AudienceAcceleratorExclusionsEnabled: ttdworkflows.Pointer(true),
				AudienceBoosterEnabled:               ttdworkflows.Pointer(true),
				AudienceExcluderEnabled:              ttdworkflows.Pointer(true),
				AudiencePredictorEnabled:             ttdworkflows.Pointer(false),
				CrossDeviceVendorListForAudience: []int{
					107263,
				},
				RecencyExclusionWindowInMinutes: ttdworkflows.Pointer[int](90062),
				TargetTrackableUsersEnabled:     ttdworkflows.Pointer(true),
				UseMcIDAsPrimary:                ttdworkflows.Pointer(true),
			},
			RoiGoal: &components.AdGroupWorkflowROIGoalInput{
				MaximizeReach:               ttdworkflows.Pointer(true),
				MaximizeLtvIncrementalReach: ttdworkflows.Pointer(false),
				CpcInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2280.31),
				CtrInPercent:                nil,
				NielsenOTPInPercent:         ttdworkflows.Pointer[float64](5175.21),
				CpaInAdvertiserCurrency:     ttdworkflows.Pointer[float64](2544.37),
				ReturnOnAdSpendPercent:      ttdworkflows.Pointer[float64](8201.47),
				VcrInPercent:                ttdworkflows.Pointer[float64](4846.08),
				ViewabilityInPercent:        nil,
				VcpmInAdvertiserCurrency:    ttdworkflows.Pointer[float64](4649.53),
				CpcvInAdvertiserCurrency:    ttdworkflows.Pointer[float64](313.95),
				MiaozhenOTPInPercent:        ttdworkflows.Pointer[float64](4704.1),
			},
			CreativeIds: nil,
			AssociatedBidLists: []components.AdGroupWorkflowAssociateBidListInput{
				components.AdGroupWorkflowAssociateBidListInput{
					BidListID:             "<id>",
					IsEnabled:             ttdworkflows.Pointer(false),
					IsDefaultForDimension: ttdworkflows.Pointer(true),
				},
			},
			Name:                                    ttdworkflows.Pointer("<value>"),
			Channel:                                 components.AdGroupChannelDisplay,
			FunnelLocation:                          components.AdGroupFunnelLocationConsideration,
			MarketType:                              components.MarketTypePrivateMarketOnly.ToPointer(),
			ProgrammaticGuaranteedPrivateContractID: ttdworkflows.Pointer("<id>"),
			IncludeDefaultsFromCampaign:             ttdworkflows.Pointer(false),
		},
		CampaignID: ttdworkflows.Pointer("<id>"),
		AdvancedInput: &components.AdGroupWorkflowAdvancedInput{
			KoaOptimizationSettings: &components.AdGroupWorkflowKoaOptimizationSettingsInput{
				AreFutureKoaFeaturesEnabled: ttdworkflows.Pointer(false),
				PredictiveClearingEnabled:   ttdworkflows.Pointer(false),
			},
			ComscoreSettings: &components.AdGroupWorkflowComscoreSettingsInput{
				IsEnabled:    false,
				PopulationID: nil,
				DemographicMemberIds: []int{
					959580,
					236376,
				},
				MobileDemographicMemberIds: []int{
					664689,
					827980,
					21321,
				},
			},
			ContractTargeting: &components.AdGroupWorkflowContractTargetingInput{
				AllowOpenMarketBiddingWhenTargetingContracts: ttdworkflows.Pointer(true),
			},
			DimensionalBiddingAutoOptimizationSettings: [][]components.DimensionalBiddingDimensions{
				[]components.DimensionalBiddingDimensions{},
				[]components.DimensionalBiddingDimensions{},
			},
			IsUseClicksAsConversionsEnabled:  ttdworkflows.Pointer(false),
			IsUseSecondaryConversionsEnabled: ttdworkflows.Pointer(false),
			NielsenTrackingAttributes: &components.AdGroupWorkflowNielsenTrackingAttributesInput{
				EnhancedReportingOption: components.EnhancedNielsenReportingOptionsInputSite.ToPointer(),
				Gender:                  components.TargetingGenderInputMale,
				StartAge:                components.TargetingStartAgeInputTwentyFive,
				EndAge:                  components.TargetingEndAgeInputSeventeen,
				Countries: []string{
					"<value 1>",
					"<value 2>",
					"<value 3>",
				},
			},
			NewFrequencyConfigs: []components.AdGroupWorkflowNewFrequencyConfigInput{
				components.AdGroupWorkflowNewFrequencyConfigInput{
					CounterName:            nil,
					FrequencyCap:           ttdworkflows.Pointer[int](375286),
					FrequencyGoal:          ttdworkflows.Pointer[int](534735),
					ResetIntervalInMinutes: ttdworkflows.Pointer[int](788122),
				},
			},
			Flights: []components.AdGroupWorkflowFlightInput{
				components.AdGroupWorkflowFlightInput{
					AllocationType:                  components.AllocationTypeMaximum.ToPointer(),
					BudgetInAdvertiserCurrency:      ttdworkflows.Pointer[float64](4070.96),
					BudgetInImpressions:             ttdworkflows.Pointer[int64](901477),
					DailyTargetInAdvertiserCurrency: ttdworkflows.Pointer[float64](5847.35),
					DailyTargetInImpressions:        ttdworkflows.Pointer[int64](257517),
					CampaignFlightID:                874887,
				},
			},
			CallerSource: ttdworkflows.Pointer("<value>"),
		},
		ValidateInputOnly: ttdworkflows.Pointer(true),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.AdGroupPayload != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"

	"github.com/thetradedesk/ttd-workflows-go"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = ttdworkflows.New(ttdworkflows.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 26 Commits
.github/workflows		.github/workflows
.idea		.idea
.speakeasy		.speakeasy
docs		docs
internal		internal
models		models
optionalnullable		optionalnullable
retry		retry
types		types
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
adgroups.go		adgroups.go
campaigns.go		campaigns.go
dmps.go		dmps.go
go.mod		go.mod
go.sum		go.sum
graphqlrequest.go		graphqlrequest.go
graphqlrequests.go		graphqlrequests.go
jobstatus.go		jobstatus.go
restrequests.go		restrequests.go
workflows.go		workflows.go

thetradedesk/ttd-workflows-go

Folders and files

Latest commit

History

Repository files navigation

github.com/thetradedesk/ttd-workflows-go

Summary

Table of Contents

SDK Installation

SDK Example Usage

Example: Submit job to retrieve third-party data

Example: Check status for third-party data retrieval job using job ID returned from submit job

Example: Create campaign with minimal configuration

Example: Submit GraphQL request

Example: Submit bulk GraphQL query job

Example: Check status for bulk GraphQL query job

Authentication

Per-Client Security Schemes

Available Resources and Operations

Retries

Error Handling

Example

Server Selection

Select Server by Name

Example

Override Server URL Per-Client

Custom HTTP Client

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages