Documentation ¶
Index ¶
- type AnyType
- type AnyURI
- type ApiError
- type ApiException
- type ApiExceptionFault
- type ApiVersionError
- type ApiVersionError_Reason
- type ApplicationException
- type AssetCreativeTemplateVariable
- type AssetCreativeTemplateVariable_MimeType
- type AuthenticationError
- type AuthenticationError_Reason
- type BooleanValue
- type CollectionSizeError
- type CollectionSizeError_Reason
- type CommonError
- type CommonError_Reason
- type CreativeTemplate
- type CreativeTemplateError
- type CreativeTemplateError_Reason
- type CreativeTemplateOperationError
- type CreativeTemplateOperationError_Reason
- type CreativeTemplatePage
- type CreativeTemplateServiceInterface
- type CreativeTemplateStatus
- type CreativeTemplateType
- type CreativeTemplateVariable
- type Date
- type DateTime
- type DateTimeValue
- type DateValue
- type FeatureError
- type FeatureError_Reason
- type FieldPathElement
- type GetCreativeTemplatesByStatement
- type GetCreativeTemplatesByStatementResponse
- type InternalApiError
- type InternalApiError_Reason
- type InvalidUrlError
- type InvalidUrlError_Reason
- type ListStringCreativeTemplateVariable
- type ListStringCreativeTemplateVariable_VariableChoice
- type LongCreativeTemplateVariable
- type NCName
- type NotNullError
- type NotNullError_Reason
- type NullError
- type NullError_Reason
- type NumberValue
- type ObjectValue
- type ParseError
- type ParseError_Reason
- type PermissionError
- type PermissionError_Reason
- type PublisherQueryLanguageContextError
- type PublisherQueryLanguageContextError_Reason
- type PublisherQueryLanguageSyntaxError
- type PublisherQueryLanguageSyntaxError_Reason
- type QuotaError
- type QuotaError_Reason
- type RangeError
- type RangeError_Reason
- type RequestHeader
- type RequiredCollectionError
- type RequiredCollectionError_Reason
- type RequiredError
- type RequiredError_Reason
- type RequiredNumberError
- type RequiredNumberError_Reason
- type ResponseHeader
- type ServerError
- type ServerError_Reason
- type SetValue
- type SoapRequestHeader
- type SoapResponseHeader
- type Statement
- type StatementError
- type StatementError_Reason
- type StringCreativeTemplateVariable
- type StringFormatError
- type StringFormatError_Reason
- type StringLengthError
- type StringLengthError_Reason
- type String_ValueMapEntry
- type TextValue
- type UniqueError
- type UrlCreativeTemplateVariable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 AssetCreativeTemplateVariable ¶
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 ¶
type AssetCreativeTemplateVariable_MimeType string
const ( AssetCreativeTemplateVariable_MimeTypeJPG AssetCreativeTemplateVariable_MimeType = "JPG" AssetCreativeTemplateVariable_MimeTypePNG AssetCreativeTemplateVariable_MimeType = "PNG" AssetCreativeTemplateVariable_MimeTypeGIF AssetCreativeTemplateVariable_MimeType = "GIF" AssetCreativeTemplateVariable_MimeTypeSWF AssetCreativeTemplateVariable_MimeType = "SWF" )
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 CreativeTemplate ¶
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 ¶
type CreativeTemplateError struct { *ApiError // // The error reason represented by an enum. // Reason *CreativeTemplateError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CreativeTemplateError_Reason ¶
type CreativeTemplateError_Reason string
const ( // // The XML of the creative template definition is malformed and cannot be parsed. // CreativeTemplateError_ReasonCANNOT_PARSE_CREATIVE_TEMPLATE CreativeTemplateError_Reason = "CANNOT_PARSE_CREATIVE_TEMPLATE" // // A creative template has multiple variables with the same uniqueName. // CreativeTemplateError_ReasonVARIABLE_DUPLICATE_UNIQUE_NAME CreativeTemplateError_Reason = "VARIABLE_DUPLICATE_UNIQUE_NAME" // // The creative template contains a variable with invalid characters. Valid // characters are letters, numbers, spaces, forward slashes, dashes, // and underscores. // CreativeTemplateError_ReasonVARIABLE_INVALID_UNIQUE_NAME CreativeTemplateError_Reason = "VARIABLE_INVALID_UNIQUE_NAME" // // Multiple choices for a CreativeTemplateListStringVariable have the same value. // CreativeTemplateError_ReasonLIST_CHOICE_DUPLICATE_VALUE CreativeTemplateError_Reason = "LIST_CHOICE_DUPLICATE_VALUE" // // The choices for a CreativeTemplateListStringVariable do not contain the // default value. // CreativeTemplateError_ReasonLIST_CHOICE_NEEDS_DEFAULT CreativeTemplateError_Reason = "LIST_CHOICE_NEEDS_DEFAULT" // // There are no choices specified for the list variable. // CreativeTemplateError_ReasonLIST_CHOICES_EMPTY CreativeTemplateError_Reason = "LIST_CHOICES_EMPTY" // // No target platform is assigned to a creative template. // CreativeTemplateError_ReasonNO_TARGET_PLATFORMS CreativeTemplateError_Reason = "NO_TARGET_PLATFORMS" // // More than one target platform is assigned to a single creative template. // CreativeTemplateError_ReasonMULTIPLE_TARGET_PLATFORMS CreativeTemplateError_Reason = "MULTIPLE_TARGET_PLATFORMS" // // The formatter contains a placeholder which is not defined as a variable. // CreativeTemplateError_ReasonUNRECOGNIZED_PLACEHOLDER CreativeTemplateError_Reason = "UNRECOGNIZED_PLACEHOLDER" // // There are variables defined which are not being used in the formatter. // CreativeTemplateError_ReasonPLACEHOLDERS_NOT_IN_FORMATTER CreativeTemplateError_Reason = "PLACEHOLDERS_NOT_IN_FORMATTER" // // The creative template is interstitial, but the formatter doesn't contain // an interstitial macro. // CreativeTemplateError_ReasonMISSING_INTERSTITIAL_MACRO CreativeTemplateError_Reason = "MISSING_INTERSTITIAL_MACRO" // // The value returned if the actual value is not exposed by the requested API version. // CreativeTemplateError_ReasonUNKNOWN CreativeTemplateError_Reason = "UNKNOWN" )
type CreativeTemplateOperationError ¶
type CreativeTemplateOperationError struct { *ApiError // // The error reason represented by an enum. // Reason *CreativeTemplateOperationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CreativeTemplateOperationError_Reason ¶
type CreativeTemplateOperationError_Reason string
const ( // // The current user is not allowed to modify this creative template. // CreativeTemplateOperationError_ReasonNOT_ALLOWED CreativeTemplateOperationError_Reason = "NOT_ALLOWED" // // The operation is not applicable to the current state. // (e.g. Trying to activate an active creative template) // CreativeTemplateOperationError_ReasonNOT_APPLICABLE CreativeTemplateOperationError_Reason = "NOT_APPLICABLE" // // The value returned if the actual value is not exposed by the requested API version. // CreativeTemplateOperationError_ReasonUNKNOWN CreativeTemplateOperationError_Reason = "UNKNOWN" )
type CreativeTemplatePage ¶
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 ¶
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) }
func NewCreativeTemplateServiceInterface ¶
func NewCreativeTemplateServiceInterface(client *soap.Client) CreativeTemplateServiceInterface
type CreativeTemplateStatus ¶
type CreativeTemplateStatus string
const ( // // The {@link CreativeTemplate} is active // CreativeTemplateStatusACTIVE CreativeTemplateStatus = "ACTIVE" // // The {@link CreativeTemplate} is inactive. Users cannot create new creatives // from this template, but existing ones can be edited and continue to serve // CreativeTemplateStatusINACTIVE CreativeTemplateStatus = "INACTIVE" // // The {@link CreativeTemplate} is deleted. Creatives created from this {@link CreativeTemplate} // can no longer serve. // CreativeTemplateStatusDELETED CreativeTemplateStatus = "DELETED" )
type CreativeTemplateType ¶
type CreativeTemplateType string
const ( // // Creative templates that Google defines for users to use. // CreativeTemplateTypeSYSTEM_DEFINED CreativeTemplateType = "SYSTEM_DEFINED" // // Arbitrary creative templates that users can define as they see fit. // Such templates are bound to a specific network and can only be used // with creatives being created under the network. // CreativeTemplateTypeUSER_DEFINED CreativeTemplateType = "USER_DEFINED" )
type CreativeTemplateVariable ¶
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 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 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 GetCreativeTemplatesByStatementResponse ¶
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 ¶
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 InvalidUrlError ¶
type InvalidUrlError struct { *ApiError Reason *InvalidUrlError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type InvalidUrlError_Reason ¶
type InvalidUrlError_Reason string
const ( // // The URL contains invalid characters. // InvalidUrlError_ReasonILLEGAL_CHARACTERS InvalidUrlError_Reason = "ILLEGAL_CHARACTERS" // // The format of the URL is not allowed. This could occur for a number of // reasons. For example, if an invalid scheme is specified (like "ftp://") // or if a port is specified when not required, or if a query was specified // when not required. // InvalidUrlError_ReasonINVALID_FORMAT InvalidUrlError_Reason = "INVALID_FORMAT" // // URL contains insecure scheme. // InvalidUrlError_ReasonINSECURE_SCHEME InvalidUrlError_Reason = "INSECURE_SCHEME" // // The URL does not contain a scheme. // InvalidUrlError_ReasonNO_SCHEME InvalidUrlError_Reason = "NO_SCHEME" // // The value returned if the actual value is not exposed by the requested API version. // InvalidUrlError_ReasonUNKNOWN InvalidUrlError_Reason = "UNKNOWN" )
type ListStringCreativeTemplateVariable ¶
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 ¶
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 ¶
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 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 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 RangeError ¶
type RangeError struct { *ApiError Reason *RangeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RangeError_Reason ¶
type RangeError_Reason string
const ( RangeError_ReasonTOO_HIGH RangeError_Reason = "TOO_HIGH" RangeError_ReasonTOO_LOW RangeError_Reason = "TOO_LOW" // // The value returned if the actual value is not exposed by the requested API version. // RangeError_ReasonUNKNOWN RangeError_Reason = "UNKNOWN" )
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 RequiredNumberError ¶
type RequiredNumberError struct { *ApiError Reason *RequiredNumberError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RequiredNumberError_Reason ¶
type RequiredNumberError_Reason string
const ( RequiredNumberError_ReasonREQUIRED RequiredNumberError_Reason = "REQUIRED" RequiredNumberError_ReasonTOO_LARGE RequiredNumberError_Reason = "TOO_LARGE" RequiredNumberError_ReasonTOO_SMALL RequiredNumberError_Reason = "TOO_SMALL" RequiredNumberError_ReasonTOO_LARGE_WITH_DETAILS RequiredNumberError_Reason = "TOO_LARGE_WITH_DETAILS" RequiredNumberError_ReasonTOO_SMALL_WITH_DETAILS RequiredNumberError_Reason = "TOO_SMALL_WITH_DETAILS" // // The value returned if the actual value is not exposed by the requested API version. // RequiredNumberError_ReasonUNKNOWN RequiredNumberError_Reason = "UNKNOWN" )
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 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> // // <code>:= <property> {< | <= | > | >= | = | != } <value></code><br> // <code><condition></code><br> // // <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 StringCreativeTemplateVariable ¶
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 ¶
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 UniqueError ¶
type UniqueError struct {
*ApiError
}
type UrlCreativeTemplateVariable ¶
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"` }
Click to show internal directories.
Click to hide internal directories.