creativewrapper

package
v0.0.1-alpha Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2023 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateCreativeWrappers

type ActivateCreativeWrappers struct {
	*CreativeWrapperAction
}

type AnyType

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

type AnyURI

type AnyURI string

type ApiError

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

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

type ApiExceptionFault ApiException

type ApiVersionError

type ApiVersionError struct {
	*ApiError

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

type ApiVersionError_Reason

type ApiVersionError_Reason string
const (

	//
	// Indicates that the operation is not allowed in the version the request
	// was made in.
	//
	ApiVersionError_ReasonUPDATE_TO_NEWER_VERSION ApiVersionError_Reason = "UPDATE_TO_NEWER_VERSION"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	ApiVersionError_ReasonUNKNOWN ApiVersionError_Reason = "UNKNOWN"
)

type ApplicationException

type ApplicationException struct {

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

type AuthenticationError

type AuthenticationError struct {
	*ApiError

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

type AuthenticationError_Reason

type AuthenticationError_Reason string
const (

	//
	// The SOAP message contains a request header with an ambiguous definition of the authentication
	// header fields. This means either the {@code authToken} and {@code oAuthToken} fields were
	// both null or both were specified. Exactly one value should be specified with each request.
	//
	AuthenticationError_ReasonAMBIGUOUS_SOAP_REQUEST_HEADER AuthenticationError_Reason = "AMBIGUOUS_SOAP_REQUEST_HEADER"

	//
	// The login provided is invalid.
	//
	AuthenticationError_ReasonINVALID_EMAIL AuthenticationError_Reason = "INVALID_EMAIL"

	//
	// Tried to authenticate with provided information, but failed.
	//
	AuthenticationError_ReasonAUTHENTICATION_FAILED AuthenticationError_Reason = "AUTHENTICATION_FAILED"

	//
	// The OAuth provided is invalid.
	//
	AuthenticationError_ReasonINVALID_OAUTH_SIGNATURE AuthenticationError_Reason = "INVALID_OAUTH_SIGNATURE"

	//
	// The specified service to use was not recognized.
	//
	AuthenticationError_ReasonINVALID_SERVICE AuthenticationError_Reason = "INVALID_SERVICE"

	//
	// The SOAP message is missing a request header with an {@code authToken} and optional {@code
	// networkCode}.
	//
	AuthenticationError_ReasonMISSING_SOAP_REQUEST_HEADER AuthenticationError_Reason = "MISSING_SOAP_REQUEST_HEADER"

	//
	// The HTTP request is missing a request header with an {@code authToken}
	//
	AuthenticationError_ReasonMISSING_AUTHENTICATION_HTTP_HEADER AuthenticationError_Reason = "MISSING_AUTHENTICATION_HTTP_HEADER"

	//
	// The request is missing an {@code authToken}
	//
	AuthenticationError_ReasonMISSING_AUTHENTICATION AuthenticationError_Reason = "MISSING_AUTHENTICATION"

	//
	// The network does not have API access enabled.
	//
	AuthenticationError_ReasonNETWORK_API_ACCESS_DISABLED AuthenticationError_Reason = "NETWORK_API_ACCESS_DISABLED"

	//
	// The user is not associated with any network.
	//
	AuthenticationError_ReasonNO_NETWORKS_TO_ACCESS AuthenticationError_Reason = "NO_NETWORKS_TO_ACCESS"

	//
	// No network for the given {@code networkCode} was found.
	//
	AuthenticationError_ReasonNETWORK_NOT_FOUND AuthenticationError_Reason = "NETWORK_NOT_FOUND"

	//
	// The user has access to more than one network, but did not provide a {@code networkCode}.
	//
	AuthenticationError_ReasonNETWORK_CODE_REQUIRED AuthenticationError_Reason = "NETWORK_CODE_REQUIRED"

	//
	// An error happened on the server side during connection to authentication service.
	//
	AuthenticationError_ReasonCONNECTION_ERROR AuthenticationError_Reason = "CONNECTION_ERROR"

	//
	// The user tried to create a test network using an account that already is associated with a
	// network.
	//
	AuthenticationError_ReasonGOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK AuthenticationError_Reason = "GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK"

	//
	// The account is blocked and under investigation by the collections team. Please contact Google
	// for more information.
	//
	AuthenticationError_ReasonUNDER_INVESTIGATION AuthenticationError_Reason = "UNDER_INVESTIGATION"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	AuthenticationError_ReasonUNKNOWN AuthenticationError_Reason = "UNKNOWN"
)

type BooleanValue

type BooleanValue struct {

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

type CollectionSizeError

type CollectionSizeError struct {
	*ApiError

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

type CollectionSizeError_Reason

type CollectionSizeError_Reason string
const (
	CollectionSizeError_ReasonTOO_LARGE CollectionSizeError_Reason = "TOO_LARGE"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	CollectionSizeError_ReasonUNKNOWN CollectionSizeError_Reason = "UNKNOWN"
)

type CommonError

type CommonError struct {
	*ApiError

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

type CommonError_Reason

type CommonError_Reason string
const (

	//
	// Indicates that an attempt was made to retrieve an entity that does not
	// exist.
	//
	CommonError_ReasonNOT_FOUND CommonError_Reason = "NOT_FOUND"

	//
	// Indicates that an attempt was made to create an entity that already
	// exists.
	//
	CommonError_ReasonALREADY_EXISTS CommonError_Reason = "ALREADY_EXISTS"

	//
	// Indicates that a value is not applicable for given use case.
	//
	CommonError_ReasonNOT_APPLICABLE CommonError_Reason = "NOT_APPLICABLE"

	//
	// Indicates that two elements in the collection were identical.
	//
	CommonError_ReasonDUPLICATE_OBJECT CommonError_Reason = "DUPLICATE_OBJECT"

	//
	// Indicates that an attempt was made to change an immutable field.
	//
	CommonError_ReasonCANNOT_UPDATE CommonError_Reason = "CANNOT_UPDATE"

	//
	// Indicates that the requested operation is not supported.
	//
	CommonError_ReasonUNSUPPORTED_OPERATION CommonError_Reason = "UNSUPPORTED_OPERATION"

	//
	// Indicates that another request attempted to update the same data in the same network
	// at about the same time. Please wait and try the request again.
	//
	CommonError_ReasonCONCURRENT_MODIFICATION CommonError_Reason = "CONCURRENT_MODIFICATION"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	CommonError_ReasonUNKNOWN CommonError_Reason = "UNKNOWN"
)

type ConversionEvent

type ConversionEvent string
const (

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	ConversionEventUNKNOWN ConversionEvent = "UNKNOWN"

	//
	// Corresponds to the {@code creativeView} tracking event.
	//
	ConversionEventCREATIVE_VIEW ConversionEvent = "CREATIVE_VIEW"

	//
	// Corresponds to the {@code start} tracking event.
	//
	ConversionEventSTART ConversionEvent = "START"

	//
	// An event that is fired when a video skip button is shown,
	// usually after 5 seconds of viewing the video.
	// This event does not correspond to any VAST element and is implemented using an extension.
	//
	ConversionEventSKIP_SHOWN ConversionEvent = "SKIP_SHOWN"

	//
	// Corresponds to the {@code firstQuartile} tracking event.
	//
	ConversionEventFIRST_QUARTILE ConversionEvent = "FIRST_QUARTILE"

	//
	// Corresponds to the {@code midpoint} tracking event.
	//
	ConversionEventMIDPOINT ConversionEvent = "MIDPOINT"

	//
	// Corresponds to the {@code thirdQuartile} tracking event.
	//
	ConversionEventTHIRD_QUARTILE ConversionEvent = "THIRD_QUARTILE"

	//
	// An event that is fired after 30 seconds of viewing the video
	// or when the video finished (if the video duration is less than 30 seconds).
	// This event does not correspond to any VAST element and is implemented using an extension.
	//
	ConversionEventENGAGED_VIEW ConversionEvent = "ENGAGED_VIEW"

	//
	// Corresponds to the {@code complete} tracking event.
	//
	ConversionEventCOMPLETE ConversionEvent = "COMPLETE"

	//
	// Corresponds to the {@code mute} tracking event.
	//
	ConversionEventMUTE ConversionEvent = "MUTE"

	//
	// Corresponds to the {@code unmute} tracking event.
	//
	ConversionEventUNMUTE ConversionEvent = "UNMUTE"

	//
	// Corresponds to the {@code pause} tracking event.
	//
	ConversionEventPAUSE ConversionEvent = "PAUSE"

	//
	// Corresponds to the {@code rewind} tracking event.
	//
	ConversionEventREWIND ConversionEvent = "REWIND"

	//
	// Corresponds to the {@code resume} tracking event.
	//
	ConversionEventRESUME ConversionEvent = "RESUME"

	//
	// An event that is fired when a video was skipped.
	// This event does not correspond to any VAST element and is implemented using an extension.
	//
	ConversionEventSKIPPED ConversionEvent = "SKIPPED"

	//
	// Corresponds to the {@code fullscreen} tracking event.
	//
	ConversionEventFULLSCREEN ConversionEvent = "FULLSCREEN"

	//
	// Corresponds to the {@code expand} tracking event.
	//
	ConversionEventEXPAND ConversionEvent = "EXPAND"

	//
	// Corresponds to the {@code collapse} tracking event.
	//
	ConversionEventCOLLAPSE ConversionEvent = "COLLAPSE"

	//
	// Corresponds to the {@code acceptInvitation} tracking event.
	//
	ConversionEventACCEPT_INVITATION ConversionEvent = "ACCEPT_INVITATION"

	//
	// Corresponds to the {@code close} tracking event.
	//
	ConversionEventCLOSE ConversionEvent = "CLOSE"

	//
	// Corresponds to the {@code Linear.VideoClicks.ClickTracking} node.
	//
	ConversionEventCLICK_TRACKING ConversionEvent = "CLICK_TRACKING"

	//
	// Corresponds to the {@code InLine.Survey} node.
	//
	ConversionEventSURVEY ConversionEvent = "SURVEY"

	//
	// Corresponds to the {@code Linear.VideoClicks.CustomClick} node.
	//
	ConversionEventCUSTOM_CLICK ConversionEvent = "CUSTOM_CLICK"

	//
	// Corresponds to the {@code measurableImpression} tracking event.
	//
	ConversionEventMEASURABLE_IMPRESSION ConversionEvent = "MEASURABLE_IMPRESSION"

	//
	// Corresponds to the {@code viewableImpression} tracking event.
	//
	ConversionEventVIEWABLE_IMPRESSION ConversionEvent = "VIEWABLE_IMPRESSION"

	//
	// Corresponds to the {@code abandon} tracking event.
	//
	ConversionEventVIDEO_ABANDON ConversionEvent = "VIDEO_ABANDON"

	//
	// Corresponds to the {@code fullyViewableAudibleHalfDurationImpression} tracking event.
	//
	ConversionEventFULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION ConversionEvent = "FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION"
)

type ConversionEvent_TrackingUrlsMapEntry

type ConversionEvent_TrackingUrlsMapEntry struct {
	Key *ConversionEvent `xml:"key,omitempty" json:"key,omitempty"`

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

type CreateCreativeWrappers

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

	CreativeWrappers []*CreativeWrapper `xml:"creativeWrappers,omitempty" json:"creativeWrappers,omitempty"`
}

type CreateCreativeWrappersResponse

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

	Rval []*CreativeWrapper `xml:"rval,omitempty" json:"rval,omitempty"`
}

type CreativeWrapper

type CreativeWrapper struct {

	//
	// The unique ID of the {@code CreativeWrapper}. This value is readonly and is assigned by Google.
	//
	Id int64 `xml:"id,omitempty" json:"id,omitempty"`

	//
	// The ID of the {@link Label} which will be used to label ad units. The {@code labelId} on a
	// creative wrapper cannot be changed once it is created.
	//
	LabelId int64 `xml:"labelId,omitempty" json:"labelId,omitempty"`

	//
	// The creative wrapper type. If the creative wrapper type is {@link
	// CreativeWrapperType#VIDEO_TRACKING_URL}, the {@code videoTrackingUrls} field must be set. If
	// the creative wrapper type is {@link CreativeWrapperType#HTML}, either the {@code header} or
	// {@code footer} field must be set. This field is required.
	//
	CreativeWrapperType *CreativeWrapperType `xml:"creativeWrapperType,omitempty" json:"creativeWrapperType,omitempty"`

	//
	// The header HTML snippet that this creative wrapper delivers.
	//
	HtmlHeader string `xml:"htmlHeader,omitempty" json:"htmlHeader,omitempty"`

	//
	// The footer HTML snippet that this creative wrapper delivers.
	//
	HtmlFooter string `xml:"htmlFooter,omitempty" json:"htmlFooter,omitempty"`

	//
	// The header AMP snippet that this creative wrapper delivers.
	//
	AmpHead string `xml:"ampHead,omitempty" json:"ampHead,omitempty"`

	//
	// The footer AMP snippet that this creative wrapper delivers.
	//
	AmpBody string `xml:"ampBody,omitempty" json:"ampBody,omitempty"`

	//
	// The video tracking URLs that this creative wrapper delivers. This field is required if the
	// {@code creativeWrapperType} is {@link CreativeWrapperType#VIDEO_TRACKING_URL} and ignored
	// otherwise.
	//
	VideoTrackingUrls []*ConversionEvent_TrackingUrlsMapEntry `xml:"videoTrackingUrls,omitempty" json:"videoTrackingUrls,omitempty"`

	//
	// The {@code ThirdPartyDataDeclaration} for this creative wrapper.
	//
	// <p>It is copied to one of the underlying creatives. If the header creative is active then it is
	// persisted there. Otherwise it is stored on the footer creative.
	//
	ThirdPartyDataDeclaration *ThirdPartyDataDeclaration `xml:"thirdPartyDataDeclaration,omitempty" json:"thirdPartyDataDeclaration,omitempty"`

	//
	// If there are multiple wrappers for a creative, then {@code ordering} defines the order in which
	// the HTML snippets are rendered.
	//
	Ordering *CreativeWrapperOrdering `xml:"ordering,omitempty" json:"ordering,omitempty"`

	//
	// The status of the {@code CreativeWrapper}. This attribute is readonly.
	//
	Status *CreativeWrapperStatus `xml:"status,omitempty" json:"status,omitempty"`
}

type CreativeWrapperAction

type CreativeWrapperAction struct {
}

type CreativeWrapperError

type CreativeWrapperError struct {
	*ApiError

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

type CreativeWrapperError_Reason

type CreativeWrapperError_Reason string
const (

	//
	// The label is already associated with a {@link CreativeWrapper}.
	//
	CreativeWrapperError_ReasonLABEL_ALREADY_ASSOCIATED_WITH_CREATIVE_WRAPPER CreativeWrapperError_Reason = "LABEL_ALREADY_ASSOCIATED_WITH_CREATIVE_WRAPPER"

	//
	// The label type of a creative wrapper must be {@link LabelType#CREATIVE_WRAPPER}.
	//
	CreativeWrapperError_ReasonINVALID_LABEL_TYPE CreativeWrapperError_Reason = "INVALID_LABEL_TYPE"

	//
	// A macro used inside the snippet is not recognized.
	//
	CreativeWrapperError_ReasonUNRECOGNIZED_MACRO CreativeWrapperError_Reason = "UNRECOGNIZED_MACRO"

	//
	// When creating a new creative wrapper, either header or footer should exist.
	//
	CreativeWrapperError_ReasonNEITHER_HEADER_NOR_FOOTER_SPECIFIED CreativeWrapperError_Reason = "NEITHER_HEADER_NOR_FOOTER_SPECIFIED"

	//
	// Creative wrapper must have either header and/or footer, or video tracking URLs.
	//
	CreativeWrapperError_ReasonNEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED CreativeWrapperError_Reason = "NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED"

	//
	// The network has not been enabled for creating labels of type
	// {@link LabelType#CREATIVE_WRAPPER}.
	//
	CreativeWrapperError_ReasonCANNOT_USE_CREATIVE_WRAPPER_TYPE CreativeWrapperError_Reason = "CANNOT_USE_CREATIVE_WRAPPER_TYPE"

	//
	// Cannot update {@link CreativeWrapper#labelId}.
	//
	CreativeWrapperError_ReasonCANNOT_UPDATE_LABEL_ID CreativeWrapperError_Reason = "CANNOT_UPDATE_LABEL_ID"

	//
	// Cannot apply {@link LabelType#CREATIVE_WRAPPER} labels to an ad unit
	// if it has no descendants with {@link AdUnit#adUnitSizes} of
	// {@code AdUnitSize#environmentType}  as
	// {@link EnvironmentType#BROWSER}.
	//
	CreativeWrapperError_ReasonCANNOT_APPLY_TO_AD_UNIT_WITH_VIDEO_SIZES CreativeWrapperError_Reason = "CANNOT_APPLY_TO_AD_UNIT_WITH_VIDEO_SIZES"

	//
	// Cannot apply {@link LabelType#CREATIVE_WRAPPER} labels with a {@link
	// CreativeWrapper#VIDEO_TRACKING_URL} type to an ad unit if it has no descendants with {@link
	// AdUnit#adUnitSizes} of {@code AdUnitSize#environmentType} as {@link
	// EnvironmentType#VIDEO_PLAYER}.
	//
	CreativeWrapperError_ReasonCANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES CreativeWrapperError_Reason = "CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES"

	//
	// Cannot apply {@link LabelType#CREATIVE_WRAPPER} labels to an ad unit if the label is not
	// associated with a creative wrapper.
	//
	CreativeWrapperError_ReasonCANNOT_APPLY_TO_AD_UNIT_WITHOUT_LABEL_ASSOCIATION CreativeWrapperError_Reason = "CANNOT_APPLY_TO_AD_UNIT_WITHOUT_LABEL_ASSOCIATION"

	//
	// Cannot apply {@link LabelType#CREATIVE_WRAPPER} labels to an ad unit
	// if {@link AdUnit#targetPlatform} is of type {@code TargetPlatform#MOBILE}
	//
	CreativeWrapperError_ReasonCANNOT_APPLY_TO_MOBILE_AD_UNIT CreativeWrapperError_Reason = "CANNOT_APPLY_TO_MOBILE_AD_UNIT"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	CreativeWrapperError_ReasonUNKNOWN CreativeWrapperError_Reason = "UNKNOWN"
)

type CreativeWrapperOrdering

type CreativeWrapperOrdering string
const (

	//
	// Wrapping occurs after {@link #INNER} but before {@link #OUTER}
	//
	CreativeWrapperOrderingNO_PREFERENCE CreativeWrapperOrdering = "NO_PREFERENCE"

	//
	// Wrapping occurs as early as possible.
	//
	CreativeWrapperOrderingINNER CreativeWrapperOrdering = "INNER"

	//
	// Wrapping occurs after both {@link #NO_PREFERENCE} and {@link #INNER}
	//
	CreativeWrapperOrderingOUTER CreativeWrapperOrdering = "OUTER"
)

type CreativeWrapperPage

type CreativeWrapperPage 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 wrappers contained within this page.
	//
	Results []*CreativeWrapper `xml:"results,omitempty" json:"results,omitempty"`
}

type CreativeWrapperServiceInterface

type CreativeWrapperServiceInterface interface {

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Creates a new {@code CreativeWrapper} objects.

	   <p>The following fields are required:

	   <ul>
	   <li>{@link CreativeWrapper#labelId}
	   <li>{@link CreativeWrapper#ordering}
	   <li>{@link CreativeWrapper#header} or {@link CreativeWrapper#footer}
	   </ul>
	*/
	CreateCreativeWrappers(request *CreateCreativeWrappers) (*CreateCreativeWrappersResponse, error)

	CreateCreativeWrappersContext(ctx context.Context, request *CreateCreativeWrappers) (*CreateCreativeWrappersResponse, error)

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Gets a {@link CreativeWrapperPage} of {@link CreativeWrapper} 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 CreativeWrapper#id}</td>
	   </tr>
	   <tr>
	   <td>{@code labelId}</td>
	   <td>{@link CreativeWrapper#labelId}</td>
	   </tr>
	   <tr>
	   <td>{@code status}</td>
	   <td>{@link CreativeWrapper#status}</td>
	   </tr>
	   <tr>
	   <td>{@code ordering}</td>
	   <td>{@link CreativeWrapper#ordering}</td>
	   </tr>
	   </table>
	*/
	GetCreativeWrappersByStatement(request *GetCreativeWrappersByStatement) (*GetCreativeWrappersByStatementResponse, error)

	GetCreativeWrappersByStatementContext(ctx context.Context, request *GetCreativeWrappersByStatement) (*GetCreativeWrappersByStatementResponse, error)

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Performs actions on {@link CreativeWrapper} objects that match the given {@link
	   Statement#query}.
	*/
	PerformCreativeWrapperAction(request *PerformCreativeWrapperAction) (*PerformCreativeWrapperActionResponse, error)

	PerformCreativeWrapperActionContext(ctx context.Context, request *PerformCreativeWrapperAction) (*PerformCreativeWrapperActionResponse, error)

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Updates the specified {@code CreativeWrapper} objects.
	*/
	UpdateCreativeWrappers(request *UpdateCreativeWrappers) (*UpdateCreativeWrappersResponse, error)

	UpdateCreativeWrappersContext(ctx context.Context, request *UpdateCreativeWrappers) (*UpdateCreativeWrappersResponse, error)
}

func NewCreativeWrapperServiceInterface

func NewCreativeWrapperServiceInterface(client *soap.Client) CreativeWrapperServiceInterface

type CreativeWrapperStatus

type CreativeWrapperStatus string
const (
	CreativeWrapperStatusACTIVE CreativeWrapperStatus = "ACTIVE"

	CreativeWrapperStatusINACTIVE CreativeWrapperStatus = "INACTIVE"
)

type CreativeWrapperType

type CreativeWrapperType string
const (

	//
	// HTML creative wrappers that include header/footer HTML snippets.
	//
	CreativeWrapperTypeHTML CreativeWrapperType = "HTML"

	//
	// Video Tracking URL creative wrappers that include tracking URIs.
	//
	CreativeWrapperTypeVIDEO_TRACKING_URL CreativeWrapperType = "VIDEO_TRACKING_URL"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	CreativeWrapperTypeUNKNOWN CreativeWrapperType = "UNKNOWN"
)

type Date

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

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

type DateTimeValue struct {

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

type DateValue

type DateValue struct {

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

type DeactivateCreativeWrappers

type DeactivateCreativeWrappers struct {
	*CreativeWrapperAction
}

type DeclarationType

type DeclarationType string
const (

	//
	// There are no companies associated.  Functionally the same as DECLARED, combined with
	// an empty company list.
	//
	DeclarationTypeNONE DeclarationType = "NONE"

	//
	// There is a set of {@link RichMediaAdsCompany}s associated with this entity.
	//
	DeclarationTypeDECLARED DeclarationType = "DECLARED"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	DeclarationTypeUNKNOWN DeclarationType = "UNKNOWN"
)

type FeatureError

type FeatureError struct {
	*ApiError

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

type FeatureError_Reason

type FeatureError_Reason string
const (

	//
	// A feature is being used that is not enabled on the current network.
	//
	FeatureError_ReasonMISSING_FEATURE FeatureError_Reason = "MISSING_FEATURE"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	FeatureError_ReasonUNKNOWN FeatureError_Reason = "UNKNOWN"
)

type FieldPathElement

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 GetCreativeWrappersByStatement

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

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

type GetCreativeWrappersByStatementResponse

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

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

type InternalApiError

type InternalApiError struct {
	*ApiError

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

type InternalApiError_Reason

type InternalApiError_Reason string
const (

	//
	// API encountered an unexpected internal error.
	//
	InternalApiError_ReasonUNEXPECTED_INTERNAL_API_ERROR InternalApiError_Reason = "UNEXPECTED_INTERNAL_API_ERROR"

	//
	// A temporary error occurred during the request. Please retry.
	//
	InternalApiError_ReasonTRANSIENT_ERROR InternalApiError_Reason = "TRANSIENT_ERROR"

	//
	// The cause of the error is not known or only defined in newer versions.
	//
	InternalApiError_ReasonUNKNOWN InternalApiError_Reason = "UNKNOWN"

	//
	// The API is currently unavailable for a planned downtime.
	//
	InternalApiError_ReasonDOWNTIME InternalApiError_Reason = "DOWNTIME"

	//
	// Mutate succeeded but server was unable to build response. Client should not retry mutate.
	//
	InternalApiError_ReasonERROR_GENERATING_RESPONSE InternalApiError_Reason = "ERROR_GENERATING_RESPONSE"
)

type LabelError

type LabelError struct {
	*ApiError

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

type LabelError_Reason

type LabelError_Reason string
const (

	//
	// A user created label cannot begin with the Google internal system label prefix.
	//
	LabelError_ReasonINVALID_PREFIX LabelError_Reason = "INVALID_PREFIX"

	//
	// {@link Label#name} contains unsupported or reserved
	// characters.
	//
	LabelError_ReasonNAME_INVALID_CHARS LabelError_Reason = "NAME_INVALID_CHARS"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	LabelError_ReasonUNKNOWN LabelError_Reason = "UNKNOWN"
)

type NCName

type NCName string

type NotNullError

type NotNullError struct {
	*ApiError

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

type NotNullError_Reason

type NotNullError_Reason string
const (

	//
	// Assuming that a method will not have more than 3 arguments, if it does,
	// return NULL
	//
	NotNullError_ReasonARG1_NULL NotNullError_Reason = "ARG1_NULL"

	NotNullError_ReasonARG2_NULL NotNullError_Reason = "ARG2_NULL"

	NotNullError_ReasonARG3_NULL NotNullError_Reason = "ARG3_NULL"

	NotNullError_ReasonNULL NotNullError_Reason = "NULL"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	NotNullError_ReasonUNKNOWN NotNullError_Reason = "UNKNOWN"
)

type NullError

type NullError struct {
	*ApiError

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

type NullError_Reason

type NullError_Reason string
const (

	//
	// Specified list/container must not contain any null elements
	//
	NullError_ReasonNULL_CONTENT NullError_Reason = "NULL_CONTENT"
)

type NumberValue

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

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

type ParseError

type ParseError struct {
	*ApiError

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

type ParseError_Reason

type ParseError_Reason string
const (

	//
	// Indicates an error in parsing an attribute.
	//
	ParseError_ReasonUNPARSABLE ParseError_Reason = "UNPARSABLE"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	ParseError_ReasonUNKNOWN ParseError_Reason = "UNKNOWN"
)

type PerformCreativeWrapperAction

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

	CreativeWrapperAction *CreativeWrapperAction `xml:"creativeWrapperAction,omitempty" json:"creativeWrapperAction,omitempty"`

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

type PerformCreativeWrapperActionResponse

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

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

type PermissionError

type PermissionError struct {
	*ApiError

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

type PermissionError_Reason

type PermissionError_Reason string
const (

	//
	// User does not have the required permission for the request.
	//
	PermissionError_ReasonPERMISSION_DENIED PermissionError_Reason = "PERMISSION_DENIED"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	PermissionError_ReasonUNKNOWN PermissionError_Reason = "UNKNOWN"
)

type PublisherQueryLanguageContextError

type PublisherQueryLanguageContextError struct {
	*ApiError

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

type PublisherQueryLanguageContextError_Reason

type PublisherQueryLanguageContextError_Reason string
const (

	//
	// Indicates that there was an error executing the PQL.
	//
	PublisherQueryLanguageContextError_ReasonUNEXECUTABLE PublisherQueryLanguageContextError_Reason = "UNEXECUTABLE"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	PublisherQueryLanguageContextError_ReasonUNKNOWN PublisherQueryLanguageContextError_Reason = "UNKNOWN"
)

type PublisherQueryLanguageSyntaxError

type PublisherQueryLanguageSyntaxError struct {
	*ApiError

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

type PublisherQueryLanguageSyntaxError_Reason

type PublisherQueryLanguageSyntaxError_Reason string
const (

	//
	// Indicates that there was a PQL syntax error.
	//
	PublisherQueryLanguageSyntaxError_ReasonUNPARSABLE PublisherQueryLanguageSyntaxError_Reason = "UNPARSABLE"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	PublisherQueryLanguageSyntaxError_ReasonUNKNOWN PublisherQueryLanguageSyntaxError_Reason = "UNKNOWN"
)

type QuotaError

type QuotaError struct {
	*ApiError

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

type QuotaError_Reason

type QuotaError_Reason string
const (

	//
	// The number of requests made per second is too high and has exceeded the
	// allowable limit. The recommended approach to handle this error is to wait
	// about 5 seconds and then retry the request. Note that this does not
	// guarantee the request will succeed. If it fails again, try increasing the
	// wait time.
	// <p>Another way to mitigate this error is to limit requests to 8 per second for Ad Manager
	// 360 accounts, or 2 per second for Ad Manager accounts. Once again
	// this does not guarantee that every request will succeed, but may help
	// reduce the number of times you receive this error.
	//
	QuotaError_ReasonEXCEEDED_QUOTA QuotaError_Reason = "EXCEEDED_QUOTA"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	QuotaError_ReasonUNKNOWN QuotaError_Reason = "UNKNOWN"

	//
	// This user has exceeded the allowed number of new report requests per hour
	// (this includes both reports run via the UI and reports
	// run via {@link ReportService#runReportJob}).
	// The recommended approach to handle this error is to wait about 10 minutes
	// and then retry the request. Note that this does not guarantee the request
	// will succeed. If it fails again, try increasing the wait time.
	// <p>Another way to mitigate this error is to limit the number of new report
	// requests to 250 per hour per user. Once again, this does not guarantee that
	// every request will succeed, but may help reduce the number of times you
	// receive this error.
	//
	QuotaError_ReasonREPORT_JOB_LIMIT QuotaError_Reason = "REPORT_JOB_LIMIT"

	//
	// This network has exceeded the allowed number of identifiers uploaded within a 24 hour period.
	// The recommended approach to handle this error is to wait 30 minutes and then retry the
	// request. Note that this does not guarantee the request will succeed. If it fails again, try
	// increasing the wait time.
	//
	QuotaError_ReasonSEGMENT_POPULATION_LIMIT QuotaError_Reason = "SEGMENT_POPULATION_LIMIT"
)

type RequestHeader

type RequestHeader SoapRequestHeader

type RequiredCollectionError

type RequiredCollectionError struct {
	*ApiError

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

type RequiredCollectionError_Reason

type RequiredCollectionError_Reason string
const (

	//
	// A required collection is missing.
	//
	RequiredCollectionError_ReasonREQUIRED RequiredCollectionError_Reason = "REQUIRED"

	//
	// Collection size is too large.
	//
	RequiredCollectionError_ReasonTOO_LARGE RequiredCollectionError_Reason = "TOO_LARGE"

	//
	// Collection size is too small.
	//
	RequiredCollectionError_ReasonTOO_SMALL RequiredCollectionError_Reason = "TOO_SMALL"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	RequiredCollectionError_ReasonUNKNOWN RequiredCollectionError_Reason = "UNKNOWN"
)

type RequiredError

type RequiredError struct {
	*ApiError

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

type RequiredError_Reason

type RequiredError_Reason string
const (

	//
	// Missing required field.
	//
	RequiredError_ReasonREQUIRED RequiredError_Reason = "REQUIRED"
)

type ResponseHeader

type ResponseHeader SoapResponseHeader

type ServerError

type ServerError struct {
	*ApiError

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

type ServerError_Reason

type ServerError_Reason string
const (

	//
	// Indicates that an unexpected error occured.
	//
	ServerError_ReasonSERVER_ERROR ServerError_Reason = "SERVER_ERROR"

	//
	// Indicates that the server is currently experiencing a high load. Please
	// wait and try your request again.
	//
	ServerError_ReasonSERVER_BUSY ServerError_Reason = "SERVER_BUSY"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	ServerError_ReasonUNKNOWN ServerError_Reason = "UNKNOWN"
)

type SetValue

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

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

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

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

type StatementError struct {
	*ApiError

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

type StatementError_Reason

type StatementError_Reason string
const (

	//
	// A bind variable has not been bound to a value.
	//
	StatementError_ReasonVARIABLE_NOT_BOUND_TO_VALUE StatementError_Reason = "VARIABLE_NOT_BOUND_TO_VALUE"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	StatementError_ReasonUNKNOWN StatementError_Reason = "UNKNOWN"
)

type StringFormatError

type StringFormatError struct {
	*ApiError

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

type StringFormatError_Reason

type StringFormatError_Reason string
const (
	StringFormatError_ReasonUNKNOWN StringFormatError_Reason = "UNKNOWN"

	//
	// The input string value contains disallowed characters.
	//
	StringFormatError_ReasonILLEGAL_CHARS StringFormatError_Reason = "ILLEGAL_CHARS"

	//
	// The input string value is invalid for the associated field.
	//
	StringFormatError_ReasonINVALID_FORMAT StringFormatError_Reason = "INVALID_FORMAT"
)

type StringLengthError

type StringLengthError struct {
	*ApiError

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

type StringLengthError_Reason

type StringLengthError_Reason string
const (
	StringLengthError_ReasonTOO_LONG StringLengthError_Reason = "TOO_LONG"

	StringLengthError_ReasonTOO_SHORT StringLengthError_Reason = "TOO_SHORT"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	StringLengthError_ReasonUNKNOWN StringLengthError_Reason = "UNKNOWN"
)

type String_ValueMapEntry

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

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

type TextValue

type TextValue struct {

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

type ThirdPartyDataDeclaration

type ThirdPartyDataDeclaration struct {
	DeclarationType *DeclarationType `xml:"declarationType,omitempty" json:"declarationType,omitempty"`

	ThirdPartyCompanyIds []int64 `xml:"thirdPartyCompanyIds,omitempty" json:"thirdPartyCompanyIds,omitempty"`
}

type TrackingUrls

type TrackingUrls struct {

	//
	// A list of all URLs that should be pinged.
	//
	Urls []string `xml:"urls,omitempty" json:"urls,omitempty"`
}

type TypeError

type TypeError struct {
	*ApiError
}

type UniqueError

type UniqueError struct {
	*ApiError
}

type UpdateCreativeWrappers

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

	CreativeWrappers []*CreativeWrapper `xml:"creativeWrappers,omitempty" json:"creativeWrappers,omitempty"`
}

type UpdateCreativeWrappersResponse

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

	Rval []*CreativeWrapper `xml:"rval,omitempty" json:"rval,omitempty"`
}

type UpdateResult

type UpdateResult struct {

	//
	// The number of objects that were changed as a result of performing the
	// action.
	//
	NumChanges int32 `xml:"numChanges,omitempty" json:"numChanges,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL