ads

Documentation

Index

• type AdAddItem
• type AdAddItemBase
• type AdCategoryEnum
• type AdExtensionAdGetItem
• type AdFieldEnum
• type AdGetItem
• type AdStateSelectionEnum
• type AdStatusSelectionEnum
• type AdSubtypeEnum
• type AdTypeEnum
• type AdUpdateItem
• type AddRequest
• type AddResponse
• type AdsSelectionCriteria
• type AgeLabelEnum
• type ArchiveRequest
• type ArchiveResponse
• type ArrayOfAdCategoryEnum
• type DeleteRequest
• type DeleteResponse
• type DynamicTextAdAdd
• type DynamicTextAdFieldEnum
• type DynamicTextAdGet
• type DynamicTextAdUpdate
• type GetRequest
• type GetResponse
• type ImageAdAddBase
• type ImageAdGetBase
• type ImageAdUpdateBase
• type MobAppAgeLabelEnum
• type MobileAppAdAdd
• type MobileAppAdBase
• type MobileAppAdFeatureGetItem
• type MobileAppAdFeatureItem
• type MobileAppAdFieldEnum
• type MobileAppAdGet
• type MobileAppAdUpdate
• type MobileAppFeatureEnum
• type MobileAppImageAdAdd
• type MobileAppImageAdFieldEnum
• type MobileAppImageAdGet
• type MobileAppImageAdUpdate
• type ModerateRequest
• type ModerateResponse
• type ResumeRequest
• type ResumeResponse
• type Service
  • func New(c *goyad.Client) Service
  • func (s Service) Add(p AddRequest) (AddResponse, error)
  • func (s Service) Archive(p ArchiveRequest) (ArchiveResponse, error)
  • func (s Service) Delete(p DeleteRequest) (DeleteResponse, error)
  • func (s Service) Get(p GetRequest) (GetResponse, error)
  • func (s Service) Moderate(p ModerateRequest) (ModerateResponse, error)
  • func (s Service) Resume(p ResumeRequest) (ResumeResponse, error)
  • func (s Service) Suspend(p SuspendRequest) (SuspendResponse, error)
  • func (s Service) Unarchive(p UnarchiveRequest) (UnarchiveResponse, error)
  • func (s Service) Update(p UpdateRequest) (UpdateResponse, error)
• type SuspendRequest
• type SuspendResponse
• type TextAdAdd
• type TextAdAddBase
• type TextAdFieldEnum
• type TextAdGet
• type TextAdGetBase
• type TextAdUpdate
• type TextAdUpdateBase
• type TextImageAdAdd
• type TextImageAdFieldEnum
• type TextImageAdGet
• type TextImageAdUpdate
• type UnarchiveRequest
• type UnarchiveResponse
• type UpdateRequest
• type UpdateResponse

Types

type AdAddItem

type AdAddItem struct {
	support.ApiObject
	AdAddItemBase

	TextAd           *TextAdAdd           `json:"TextAd,omitempty"`
	DynamicTextAd    *DynamicTextAdAdd    `json:"DynamicTextAd,omitempty"`
	MobileAppAd      *MobileAppAdAdd      `json:"MobileAppAd,omitempty"`
	TextImageAd      *TextImageAdAdd      `json:"TextImageAd,omitempty"`
	MobileAppImageAd *MobileAppImageAdAdd `json:"MobileAppImageAd,omitempty"`
}

type AdAddItemBase

type AdAddItemBase struct {
	support.ApiObject

	AdGroupId int64 `json:"AdGroupId"`
}

type AdCategoryEnum

type AdCategoryEnum string

type AdExtensionAdGetItem

type AdExtensionAdGetItem struct {
	support.ApiObject

	AdExtensionId int64                   `json:"AdExtensionId"`
	Type          ext.AdExtensionTypeEnum `json:"Type"`
}

type AdFieldEnum

type AdFieldEnum string

type AdGetItem

type AdGetItem struct {
	support.ApiObject

	Id                  *int64                 `json:"Id,omitempty"`
	CampaignId          *int64                 `json:"CampaignId,omitempty"`
	AdGroupId           *int64                 `json:"AdGroupId,omitempty"`
	Status              *general.StatusEnum    `json:"Status,omitempty"`
	State               *general.StateEnum     `json:"State,omitempty"`
	StatusClarification *string                `json:"StatusClarification,omitempty"`
	AdCategories        *ArrayOfAdCategoryEnum `json:"AdCategories,omitempty"`
	AgeLabel            *AgeLabelEnum          `json:"AgeLabel,omitempty"`
	Type                *AdTypeEnum            `json:"Type,omitempty"`
	Subtype             *AdSubtypeEnum         `json:"Subtype,omitempty"`
	TextAd              *TextAdGet             `json:"TextAd,omitempty"`
	DynamicTextAd       *DynamicTextAdGet      `json:"DynamicTextAd,omitempty"`
	MobileAppAd         *MobileAppAdGet        `json:"MobileAppAd,omitempty"`
	TextImageAd         *TextImageAdGet        `json:"TextImageAd,omitempty"`
	MobileAppImageAd    *MobileAppImageAdGet   `json:"MobileAppImageAd,omitempty"`
}

type AdStateSelectionEnum

type AdStateSelectionEnum string

type AdStatusSelectionEnum

type AdStatusSelectionEnum string

type AdSubtypeEnum

type AdSubtypeEnum string

type AdTypeEnum

type AdTypeEnum string

type AdUpdateItem

type AdUpdateItem struct {
	support.ApiObject

	Id               int64                   `json:"Id"`
	TextAd           *TextAdUpdate           `json:"TextAd,omitempty"`
	DynamicTextAd    *DynamicTextAdUpdate    `json:"DynamicTextAd,omitempty"`
	MobileAppAd      *MobileAppAdUpdate      `json:"MobileAppAd,omitempty"`
	TextImageAd      *TextImageAdUpdate      `json:"TextImageAd,omitempty"`
	MobileAppImageAd *MobileAppImageAdUpdate `json:"MobileAppImageAd,omitempty"`
}

type AddRequest

type AddRequest struct {
	support.ApiObject

	Ads []AdAddItem `json:"Ads"`
}

type AddResponse

type AddResponse struct {
	support.ApiObject

	AddResults *[]general.ActionResult `json:"AddResults,omitempty"`
}

type AdsSelectionCriteria

type AdsSelectionCriteria struct {
	support.ApiObject

	Ids                         *[]int64                                `json:"Ids,omitempty"`
	States                      *[]AdStateSelectionEnum                 `json:"States,omitempty"`
	Statuses                    *[]AdStatusSelectionEnum                `json:"Statuses,omitempty"`
	CampaignIds                 *[]int64                                `json:"CampaignIds,omitempty"`
	AdGroupIds                  *[]int64                                `json:"AdGroupIds,omitempty"`
	Types                       *[]AdTypeEnum                           `json:"Types,omitempty"`
	Mobile                      *general.YesNoEnum                      `json:"Mobile,omitempty"`
	VCardIds                    *[]int64                                `json:"VCardIds,omitempty"`
	SitelinkSetIds              *[]int64                                `json:"SitelinkSetIds,omitempty"`
	AdImageHashes               *[]string                               `json:"AdImageHashes,omitempty"`
	VCardModerationStatuses     *[]general.ExtensionStatusSelectionEnum `json:"VCardModerationStatuses,omitempty"`
	SitelinksModerationStatuses *[]general.ExtensionStatusSelectionEnum `json:"SitelinksModerationStatuses,omitempty"`
	AdImageModerationStatuses   *[]general.ExtensionStatusSelectionEnum `json:"AdImageModerationStatuses,omitempty"`
	AdExtensionIds              *[]int64                                `json:"AdExtensionIds,omitempty"`
}

type AgeLabelEnum

type AgeLabelEnum string

type ArchiveRequest

type ArchiveRequest struct {
	support.ApiObject

	SelectionCriteria general.IdsCriteria `json:"SelectionCriteria"`
}

type ArchiveResponse

type ArchiveResponse struct {
	support.ApiObject

	ArchiveResults *[]general.ActionResult `json:"ArchiveResults,omitempty"`
}

type ArrayOfAdCategoryEnum

type ArrayOfAdCategoryEnum struct {
	support.ApiObject

	Items []AdCategoryEnum `json:"Items"`
}

type DeleteRequest

type DeleteRequest struct {
	support.ApiObject

	SelectionCriteria general.IdsCriteria `json:"SelectionCriteria"`
}

type DeleteResponse

type DeleteResponse struct {
	support.ApiObject

	DeleteResults *[]general.ActionResult `json:"DeleteResults,omitempty"`
}

type DynamicTextAdAdd

type DynamicTextAdAdd struct {
	support.ApiObject
	TextAdAddBase

	Text string `json:"Text"`
}

type DynamicTextAdFieldEnum

type DynamicTextAdFieldEnum string

type DynamicTextAdGet

type DynamicTextAdGet struct {
	support.ApiObject
	TextAdGetBase

	Text *string `json:"Text,omitempty"`
}

type DynamicTextAdUpdate

type DynamicTextAdUpdate struct {
	support.ApiObject
	TextAdUpdateBase

	Text *string `json:"Text,omitempty"`
}

type GetRequest

type GetRequest struct {
	support.ApiObject
	general.GetRequestGeneral

	SelectionCriteria          AdsSelectionCriteria         `json:"SelectionCriteria"`
	FieldNames                 []AdFieldEnum                `json:"FieldNames"`
	TextAdFieldNames           *[]TextAdFieldEnum           `json:"TextAdFieldNames,omitempty"`
	MobileAppAdFieldNames      *[]MobileAppAdFieldEnum      `json:"MobileAppAdFieldNames,omitempty"`
	DynamicTextAdFieldNames    *[]DynamicTextAdFieldEnum    `json:"DynamicTextAdFieldNames,omitempty"`
	TextImageAdFieldNames      *[]TextImageAdFieldEnum      `json:"TextImageAdFieldNames,omitempty"`
	MobileAppImageAdFieldNames *[]MobileAppImageAdFieldEnum `json:"MobileAppImageAdFieldNames,omitempty"`
}

type GetResponse

type GetResponse struct {
	support.ApiObject
	general.GetResponseGeneral

	Ads *[]AdGetItem `json:"Ads,omitempty"`
}

type ImageAdAddBase

type ImageAdAddBase struct {
	support.ApiObject

	AdImageHash string `json:"AdImageHash"`
}

type ImageAdGetBase

type ImageAdGetBase struct {
	support.ApiObject

	AdImageHash *string `json:"AdImageHash,omitempty"`
}

type ImageAdUpdateBase

type ImageAdUpdateBase struct {
	support.ApiObject

	AdImageHash *string `json:"AdImageHash,omitempty"`
}

type MobAppAgeLabelEnum

type MobAppAgeLabelEnum string

type MobileAppAdAdd

type MobileAppAdAdd struct {
	support.ApiObject

	AdImageHash *string                       `json:"AdImageHash,omitempty"`
	Text        string                        `json:"Text"`
	Title       string                        `json:"Title"`
	TrackingUrl *string                       `json:"TrackingUrl,omitempty"`
	Action      general.MobileAppAdActionEnum `json:"Action"`
	Features    *[]MobileAppAdFeatureItem     `json:"Features,omitempty"`
	AgeLabel    *MobAppAgeLabelEnum           `json:"AgeLabel,omitempty"`
}

type MobileAppAdBase

type MobileAppAdBase struct {
	support.ApiObject

	Title       *string                        `json:"Title,omitempty"`
	Text        *string                        `json:"Text,omitempty"`
	TrackingUrl *string                        `json:"TrackingUrl,omitempty"`
	Action      *general.MobileAppAdActionEnum `json:"Action,omitempty"`
	AdImageHash *string                        `json:"AdImageHash,omitempty"`
}

type MobileAppAdFeatureGetItem

type MobileAppAdFeatureGetItem struct {
	support.ApiObject
	MobileAppAdFeatureItem

	IsAvailable general.YesNoUnknownEnum `json:"IsAvailable"`
}

type MobileAppAdFeatureItem

type MobileAppAdFeatureItem struct {
	support.ApiObject

	Feature MobileAppFeatureEnum `json:"Feature"`
	Enabled general.YesNoEnum    `json:"Enabled"`
}

type MobileAppAdFieldEnum

type MobileAppAdFieldEnum string

type MobileAppAdGet

type MobileAppAdGet struct {
	support.ApiObject
	MobileAppAdBase

	Features          *[]MobileAppAdFeatureGetItem `json:"Features,omitempty"`
	AdImageModeration *general.ExtensionModeration `json:"AdImageModeration,omitempty"`
}

type MobileAppAdUpdate

type MobileAppAdUpdate struct {
	support.ApiObject
	MobileAppAdBase

	Features *[]MobileAppAdFeatureItem `json:"Features,omitempty"`
	AgeLabel *MobAppAgeLabelEnum       `json:"AgeLabel,omitempty"`
}

type MobileAppFeatureEnum

type MobileAppFeatureEnum string

type MobileAppImageAdAdd

type MobileAppImageAdAdd struct {
	support.ApiObject
	ImageAdAddBase

	TrackingUrl *string `json:"TrackingUrl,omitempty"`
}

type MobileAppImageAdFieldEnum

type MobileAppImageAdFieldEnum string

type MobileAppImageAdGet

type MobileAppImageAdGet struct {
	support.ApiObject
	ImageAdGetBase

	TrackingUrl *string `json:"TrackingUrl,omitempty"`
}

type MobileAppImageAdUpdate

type MobileAppImageAdUpdate struct {
	support.ApiObject
	ImageAdUpdateBase

	TrackingUrl *string `json:"TrackingUrl,omitempty"`
}

type ModerateRequest

type ModerateRequest struct {
	support.ApiObject

	SelectionCriteria general.IdsCriteria `json:"SelectionCriteria"`
}

type ModerateResponse

type ModerateResponse struct {
	support.ApiObject

	ModerateResults *[]general.ActionResult `json:"ModerateResults,omitempty"`
}

type ResumeRequest

type ResumeRequest struct {
	support.ApiObject

	SelectionCriteria general.IdsCriteria `json:"SelectionCriteria"`
}

type ResumeResponse

type ResumeResponse struct {
	support.ApiObject

	ResumeResults *[]general.ActionResult `json:"ResumeResults,omitempty"`
}

type Service

type Service struct {
	Client *goyad.Client
}

func New

func New(c *goyad.Client) Service

func (Service) Add

func (s Service) Add(p AddRequest) (AddResponse, error)

func (Service) Archive

func (s Service) Archive(p ArchiveRequest) (ArchiveResponse, error)

func (Service) Delete

func (s Service) Delete(p DeleteRequest) (DeleteResponse, error)

func (Service) Get

func (s Service) Get(p GetRequest) (GetResponse, error)

func (Service) Moderate

func (s Service) Moderate(p ModerateRequest) (ModerateResponse, error)

func (Service) Resume

func (s Service) Resume(p ResumeRequest) (ResumeResponse, error)

func (Service) Suspend

func (s Service) Suspend(p SuspendRequest) (SuspendResponse, error)

func (Service) Unarchive

func (s Service) Unarchive(p UnarchiveRequest) (UnarchiveResponse, error)

func (Service) Update

func (s Service) Update(p UpdateRequest) (UpdateResponse, error)

type SuspendRequest

type SuspendRequest struct {
	support.ApiObject

	SelectionCriteria general.IdsCriteria `json:"SelectionCriteria"`
}

type SuspendResponse

type SuspendResponse struct {
	support.ApiObject

	SuspendResults *[]general.ActionResult `json:"SuspendResults,omitempty"`
}

type TextAdAdd

type TextAdAdd struct {
	support.ApiObject
	TextAdAddBase

	Text           string            `json:"Text"`
	Title          string            `json:"Title"`
	Href           *string           `json:"Href,omitempty"`
	Mobile         general.YesNoEnum `json:"Mobile"`
	DisplayUrlPath *string           `json:"DisplayUrlPath,omitempty"`
}

type TextAdAddBase

type TextAdAddBase struct {
	support.ApiObject

	VCardId        *int64   `json:"VCardId,omitempty"`
	AdImageHash    *string  `json:"AdImageHash,omitempty"`
	SitelinkSetId  *int64   `json:"SitelinkSetId,omitempty"`
	AdExtensionIds *[]int64 `json:"AdExtensionIds,omitempty"`
}

type TextAdFieldEnum

type TextAdFieldEnum string

type TextAdGet

type TextAdGet struct {
	support.ApiObject
	TextAdGetBase

	Text                     *string                      `json:"Text,omitempty"`
	Title                    *string                      `json:"Title,omitempty"`
	Href                     *string                      `json:"Href,omitempty"`
	Mobile                   *general.YesNoEnum           `json:"Mobile,omitempty"`
	DisplayDomain            *string                      `json:"DisplayDomain,omitempty"`
	DisplayUrlPath           *string                      `json:"DisplayUrlPath,omitempty"`
	DisplayUrlPathModeration *general.ExtensionModeration `json:"DisplayUrlPathModeration,omitempty"`
}

type TextAdGetBase

type TextAdGetBase struct {
	support.ApiObject

	VCardId             *int64                       `json:"VCardId,omitempty"`
	AdImageHash         *string                      `json:"AdImageHash,omitempty"`
	SitelinkSetId       *int64                       `json:"SitelinkSetId,omitempty"`
	VCardModeration     *general.ExtensionModeration `json:"VCardModeration,omitempty"`
	SitelinksModeration *general.ExtensionModeration `json:"SitelinksModeration,omitempty"`
	AdImageModeration   *general.ExtensionModeration `json:"AdImageModeration,omitempty"`
	AdExtensions        *[]AdExtensionAdGetItem      `json:"AdExtensions,omitempty"`
}

type TextAdUpdate

type TextAdUpdate struct {
	support.ApiObject
	TextAdUpdateBase

	Text           *string       `json:"Text,omitempty"`
	Title          *string       `json:"Title,omitempty"`
	Href           *string       `json:"Href,omitempty"`
	AgeLabel       *AgeLabelEnum `json:"AgeLabel,omitempty"`
	DisplayUrlPath *string       `json:"DisplayUrlPath,omitempty"`
}

type TextAdUpdateBase

type TextAdUpdateBase struct {
	support.ApiObject

	VCardId        *int64                  `json:"VCardId,omitempty"`
	AdImageHash    *string                 `json:"AdImageHash,omitempty"`
	SitelinkSetId  *int64                  `json:"SitelinkSetId,omitempty"`
	CalloutSetting *ext.AdExtensionSetting `json:"CalloutSetting,omitempty"`
}

type TextImageAdAdd

type TextImageAdAdd struct {
	support.ApiObject
	ImageAdAddBase

	Href string `json:"Href"`
}

type TextImageAdFieldEnum

type TextImageAdFieldEnum string

type TextImageAdGet

type TextImageAdGet struct {
	support.ApiObject
	ImageAdGetBase

	Href *string `json:"Href,omitempty"`
}

type TextImageAdUpdate

type TextImageAdUpdate struct {
	support.ApiObject
	ImageAdUpdateBase

	Href *string `json:"Href,omitempty"`
}

type UnarchiveRequest

type UnarchiveRequest struct {
	support.ApiObject

	SelectionCriteria general.IdsCriteria `json:"SelectionCriteria"`
}

type UnarchiveResponse

type UnarchiveResponse struct {
	support.ApiObject

	UnarchiveResults *[]general.ActionResult `json:"UnarchiveResults,omitempty"`
}

type UpdateRequest

type UpdateRequest struct {
	support.ApiObject

	Ads []AdUpdateItem `json:"Ads"`
}

type UpdateResponse

type UpdateResponse struct {
	support.ApiObject

	UpdateResults *[]general.ActionResult `json:"UpdateResults,omitempty"`
}