creativetemplate

type AnyType struct {
	InnerXML string `xml:",innerxml"`
}

type AnyURI string

type ApiError struct {

	//
	// The OGNL field path to identify cause of error.
	//
	FieldPath string `xml:"fieldPath,omitempty" json:"fieldPath,omitempty"`

	//
	// A parsed copy of the field path. For example, the field path "operations[1].operand"
	// corresponds to this list: {FieldPathElement(field = "operations", index = 1),
	// FieldPathElement(field = "operand", index = null)}.
	//
	FieldPathElements []*FieldPathElement `xml:"fieldPathElements,omitempty" json:"fieldPathElements,omitempty"`

	//
	// The data that caused the error.
	//
	Trigger string `xml:"trigger,omitempty" json:"trigger,omitempty"`

	//
	// A simple string representation of the error and reason.
	//
	ErrorString string `xml:"errorString,omitempty" json:"errorString,omitempty"`
}

type ApiException struct {
	XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 ApiExceptionFault"`

	*ApplicationException

	//
	// List of errors.
	//
	Errors []*ApiError `xml:"errors,omitempty" json:"errors,omitempty"`
}

type ApiExceptionFault ApiException

type ApiVersionError struct {
	*ApiError

	Reason *ApiVersionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type ApiVersionError_Reason string

type ApplicationException struct {

	//
	// Error message.
	//
	Message string `xml:"message,omitempty" json:"message,omitempty"`
}

type AssetCreativeTemplateVariable struct {
	*CreativeTemplateVariable

	//
	// A set of supported mime types. This set can be empty or null if there's no
	// constraint, meaning files of any mime types are allowed.
	//
	MimeTypes []*AssetCreativeTemplateVariable_MimeType `xml:"mimeTypes,omitempty" json:"mimeTypes,omitempty"`
}

type AssetCreativeTemplateVariable_MimeType string

type AuthenticationError struct {
	*ApiError

	Reason *AuthenticationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type AuthenticationError_Reason string

type BooleanValue struct {

	//
	// The boolean value.
	//
	Value bool `xml:"value,omitempty" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type CollectionSizeError struct {
	*ApiError

	Reason *CollectionSizeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type CollectionSizeError_Reason string

type CommonError struct {
	*ApiError

	Reason *CommonError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type CommonError_Reason string

type CreativeTemplate struct {

	//
	// Uniquely identifies the {@code CreativeTemplate}. This attribute is read-only and is assigned
	// by Google when a creative template is created.
	//
	Id int64 `xml:"id,omitempty" json:"id,omitempty"`

	//
	// The name of the creative template. This attribute is required and has a maximum length of 255
	// characters.
	//
	Name string `xml:"name,omitempty" json:"name,omitempty"`

	//
	// The description of the creative template. This attribute is optional.
	//
	Description string `xml:"description,omitempty" json:"description,omitempty"`

	//
	// The list of creative template variables. This attribute is required.
	//
	Variables []*CreativeTemplateVariable `xml:"variables,omitempty" json:"variables,omitempty"`

	//
	// The snippet of the creative template, with placeholders for the associated variables. This
	// attribute is required.
	//
	Snippet string `xml:"snippet,omitempty" json:"snippet,omitempty"`

	//
	// The status of the {@code CreativeTemplate}. This attribute is read-only and is assigned by
	// Google.
	//
	Status *CreativeTemplateStatus `xml:"status,omitempty" json:"status,omitempty"`

	//
	// The type of the {@code CreativeTemplate}. Publisher can only create user-defined template
	//
	Type_ *CreativeTemplateType `xml:"type,omitempty" json:"type,omitempty"`

	//
	// {@code true} if this creative template produces interstitial creatives.
	//
	IsInterstitial bool `xml:"isInterstitial,omitempty" json:"isInterstitial,omitempty"`

	//
	// {@code true} if this creative template produces native-eligible creatives.
	//
	IsNativeEligible bool `xml:"isNativeEligible,omitempty" json:"isNativeEligible,omitempty"`

	//
	// Whether the {@link Creative} produced is compatible for SafeFrame rendering.
	//
	// <p>This attribute is optional and defaults to {@code true}.
	//
	IsSafeFrameCompatible bool `xml:"isSafeFrameCompatible,omitempty" json:"isSafeFrameCompatible,omitempty"`
}

type CreativeTemplateError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *CreativeTemplateError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type CreativeTemplateError_Reason string

type CreativeTemplateOperationError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *CreativeTemplateOperationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type CreativeTemplateOperationError_Reason string

type CreativeTemplatePage struct {

	//
	// The size of the total result set to which this page belongs.
	//
	TotalResultSetSize int32 `xml:"totalResultSetSize,omitempty" json:"totalResultSetSize,omitempty"`

	//
	// The absolute index in the total result set on which this page begins.
	//
	StartIndex int32 `xml:"startIndex,omitempty" json:"startIndex,omitempty"`

	//
	// The collection of creative templates contained within this page.
	//
	Results []*CreativeTemplate `xml:"results,omitempty" json:"results,omitempty"`
}

type CreativeTemplateServiceInterface interface {

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Gets a {@link CreativeTemplatePage} of {@link CreativeTemplate} objects that satisfy the given
	   {@link Statement#query}. The following fields are supported for filtering:

	   <table>
	   <tr>
	   <th scope="col">PQL Property</th> <th scope="col">Object Property</th>
	   </tr>
	   <tr>
	   <td>{@code id}</td>
	   <td>{@link CreativeTemplate#id}</td>
	   </tr>
	   <tr>
	   <td>{@code name}</td>
	   <td>{@link CreativeTemplate#name}</td>
	   </tr>
	   <tr>
	   <td>{@code type}</td>
	   <td>{@link CreativeTemplate#type}</td>
	   </tr>
	   <tr>
	   <td>{@code status}</td>
	   <td>{@link CreativeTemplate#status}</td>
	   </tr>
	   </table>
	*/
	GetCreativeTemplatesByStatement(request *GetCreativeTemplatesByStatement) (*GetCreativeTemplatesByStatementResponse, error)

	GetCreativeTemplatesByStatementContext(ctx context.Context, request *GetCreativeTemplatesByStatement) (*GetCreativeTemplatesByStatementResponse, error)
}

type CreativeTemplateStatus string

type CreativeTemplateType string

type CreativeTemplateVariable struct {

	//
	// Label that is displayed to users when creating {@link TemplateCreative} from the
	// {@link CreativeTemplate}. This attribute is required and has a maximum
	// length of 127 characters.
	//
	Label string `xml:"label,omitempty" json:"label,omitempty"`

	//
	// Unique name used to identify the variable. This attribute is read-only and
	// is assigned by Google, by deriving from label, when a creative template
	// variable is created.
	//
	UniqueName string `xml:"uniqueName,omitempty" json:"uniqueName,omitempty"`

	//
	// A descriptive help text that is displayed to users along with the
	// label. This attribute is required and has a maximum length of 255 characters.
	//
	Description string `xml:"description,omitempty" json:"description,omitempty"`

	//
	// {@code true} if this variable is required to be filled in by users when
	// creating {@link TemplateCreative} from the {@link CreativeTemplate}.
	//
	IsRequired bool `xml:"isRequired,omitempty" json:"isRequired,omitempty"`
}

type Date struct {

	//
	// Year (e.g., 2009)
	//
	Year int32 `xml:"year,omitempty" json:"year,omitempty"`

	//
	// Month (1..12)
	//
	Month int32 `xml:"month,omitempty" json:"month,omitempty"`

	//
	// Day (1..31)
	//
	Day int32 `xml:"day,omitempty" json:"day,omitempty"`
}

type DateTime struct {
	Date soap.XSDDate `xml:"date,omitempty" json:"date,omitempty"`

	Hour int32 `xml:"hour,omitempty" json:"hour,omitempty"`

	Minute int32 `xml:"minute,omitempty" json:"minute,omitempty"`

	Second int32 `xml:"second,omitempty" json:"second,omitempty"`

	TimeZoneId string `xml:"timeZoneId,omitempty" json:"timeZoneId,omitempty"`
}

type DateTimeValue struct {

	//
	// The {@code DateTime} value.
	//
	Value soap.XSDDateTime `xml:"value,omitempty" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type DateValue struct {

	//
	// The {@code Date} value.
	//
	Value soap.XSDDate `xml:"value,omitempty" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type FeatureError struct {
	*ApiError

	Reason *FeatureError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type FeatureError_Reason string

type FieldPathElement struct {

	//
	// The name of a field in lower camelcase. (e.g. "biddingStrategy")
	//
	Field string `xml:"field,omitempty" json:"field,omitempty"`

	//
	// For list fields, this is a 0-indexed position in the list. Null for non-list fields.
	//
	Index int32 `xml:"index,omitempty" json:"index,omitempty"`
}

type GetCreativeTemplatesByStatement struct {
	XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getCreativeTemplatesByStatement"`

	FilterStatement *Statement `xml:"filterStatement,omitempty" json:"filterStatement,omitempty"`
}

type GetCreativeTemplatesByStatementResponse struct {
	XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getCreativeTemplatesByStatementResponse"`

	Rval *CreativeTemplatePage `xml:"rval,omitempty" json:"rval,omitempty"`
}

type InternalApiError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *InternalApiError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type InternalApiError_Reason string

type InvalidUrlError struct {
	*ApiError

	Reason *InvalidUrlError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type InvalidUrlError_Reason string

type ListStringCreativeTemplateVariable struct {
	*StringCreativeTemplateVariable

	//
	// The values within the list users need to select from.
	//
	Choices []*ListStringCreativeTemplateVariable_VariableChoice `xml:"choices,omitempty" json:"choices,omitempty"`

	//
	// {@code true} if a user can specifiy an 'other' value.
	// For example, if a variable called backgroundColor is defined as a list
	// with values: red, green, blue, this boolean can be set to allow a user
	// to enter a value not on the list such as purple.
	//
	AllowOtherChoice bool `xml:"allowOtherChoice,omitempty" json:"allowOtherChoice,omitempty"`
}

type ListStringCreativeTemplateVariable_VariableChoice struct {
	XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 ListStringCreativeTemplateVariable.VariableChoice"`

	//
	// Label that users can select from. This is displayed to users when creating a
	// {@link TemplateCreative}. This attribute is intended to be more descriptive than
	// {@link #value}. This attribute is required and has a maximum length of 255 characters.
	//
	Label string `xml:"label,omitempty" json:"label,omitempty"`

	//
	// Value that users can select from. When creating a {@link TemplateCreative}, the value in
	// {@link StringCreativeTemplateVariableValue} should match this value, if you intend to
	// select this value. This attribute is required and has a maximum length of 255
	// characters.
	//
	Value string `xml:"value,omitempty" json:"value,omitempty"`
}

type LongCreativeTemplateVariable struct {
	*CreativeTemplateVariable

	//
	// Default value to be filled in when creating creatives from the creative
	// template.
	//
	DefaultValue int64 `xml:"defaultValue,omitempty" json:"defaultValue,omitempty"`
}

type NCName string

type NotNullError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *NotNullError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type NotNullError_Reason string

type NullError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *NullError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type NullError_Reason string

type NumberValue struct {

	//
	// The numeric value represented as a string.
	//
	Value string `xml:"value,omitempty" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type ObjectValue struct {
	// contains filtered or unexported fields
}

type ParseError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *ParseError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type ParseError_Reason string

type PermissionError struct {
	*ApiError

	Reason *PermissionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type PermissionError_Reason string

type PublisherQueryLanguageContextError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *PublisherQueryLanguageContextError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type PublisherQueryLanguageContextError_Reason string

type PublisherQueryLanguageSyntaxError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *PublisherQueryLanguageSyntaxError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type PublisherQueryLanguageSyntaxError_Reason string

type QuotaError struct {
	*ApiError

	Reason *QuotaError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type QuotaError_Reason string

type RangeError struct {
	*ApiError

	Reason *RangeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type RangeError_Reason string

type RequestHeader SoapRequestHeader

type RequiredCollectionError struct {
	*ApiError

	Reason *RequiredCollectionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type RequiredCollectionError_Reason string

type RequiredError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *RequiredError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type RequiredError_Reason string

type RequiredNumberError struct {
	*ApiError

	Reason *RequiredNumberError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type RequiredNumberError_Reason string

type ResponseHeader SoapResponseHeader

type ServerError struct {
	*ApiError

	Reason *ServerError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type ServerError_Reason string

type SetValue struct {

	//
	// The values. They must all be the same type of {@code Value} and not contain duplicates.
	//
	Values []*_Value `xml:"values,omitempty" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type SoapRequestHeader struct {
	XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 RequestHeader"`

	//
	// The network code to use in the context of a request.
	//
	NetworkCode string `xml:"networkCode,omitempty" json:"networkCode,omitempty"`

	//
	// The name of client library application.
	//
	ApplicationName string `xml:"applicationName,omitempty" json:"applicationName,omitempty"`
}

type SoapResponseHeader struct {
	XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 ResponseHeader"`

	RequestId string `xml:"requestId,omitempty" json:"requestId,omitempty"`

	ResponseTime int64 `xml:"responseTime,omitempty" json:"responseTime,omitempty"`
}

type Statement struct {

	//
	// Holds the query in PQL syntax. The syntax is:<br>
	// <code>[WHERE <condition> {[AND | OR] <condition> ...}]</code><br>
	// <code>[ORDER BY <property> [ASC | DESC]]</code><br>
	// <code>[LIMIT {[<offset>,] <count>} | {<count> OFFSET <offset>}]</code><br>
	// <p>
	// <code><condition></code><br>
	// &nbsp;&nbsp;&nbsp;&nbsp;
	// <code>:= <property> {< | <= | > | >= | = | != } <value></code><br>
	// <code><condition></code><br>
	// &nbsp;&nbsp;&nbsp;&nbsp;
	// <code>:= <property> {< | <= | > | >= | = | != } <bind variable></code><br>
	// <code><condition> := <property> IN <list></code><br>
	// <code><condition> := <property> IS NULL</code><br>
	// <code><condition> := <property> LIKE <wildcard%match></code><br>
	// <code><bind variable> := :<name></code><br>
	// </p>
	//
	Query string `xml:"query,omitempty" json:"query,omitempty"`

	//
	// Holds keys and values for bind variables and their values. The key is the
	// name of the bind variable. The value is the literal value of the variable.
	// <p>
	// In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"},
	// the bind variable, represented by {@code :bindStatus} is named {@code
	// bindStatus}, which would also be the parameter map key. The bind variable's
	// value would be represented by a parameter map value of type
	// {@link TextValue}. The final result, for example, would be an entry of
	// {@code "bindStatus" => StringParam("ACTIVE")}.
	// </p>
	//
	Values []*String_ValueMapEntry `xml:"values,omitempty" json:"values,omitempty"`
}

type StatementError struct {
	*ApiError

	//
	// The error reason represented by an enum.
	//
	Reason *StatementError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type StatementError_Reason string

type StringCreativeTemplateVariable struct {
	*CreativeTemplateVariable

	//
	// Default value to be filled in when creating creatives from the creative
	// template.
	//
	DefaultValue string `xml:"defaultValue,omitempty" json:"defaultValue,omitempty"`
}

type StringFormatError struct {
	*ApiError

	Reason *StringFormatError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type StringFormatError_Reason string

type StringLengthError struct {
	*ApiError

	Reason *StringLengthError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}

type StringLengthError_Reason string

type String_ValueMapEntry struct {
	Key string `xml:"key,omitempty" json:"key,omitempty"`

	Value *_Value `xml:"value,omitempty" json:"value,omitempty"`
}

type TextValue struct {

	//
	// The string value.
	//
	Value string `xml:"value,omitempty" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type UniqueError struct {
	*ApiError
}

type UrlCreativeTemplateVariable struct {
	*CreativeTemplateVariable

	//
	// Default value to be filled in when creating creatives from the creative
	// template.
	//
	DefaultValue string `xml:"defaultValue,omitempty" json:"defaultValue,omitempty"`

	//
	// When true, if the URL is identified as from a known vendor, cache-busting
	// macros will automatically be inserted upon save.
	//
	IsTrackingUrl bool `xml:"isTrackingUrl,omitempty" json:"isTrackingUrl,omitempty"`
}