Documentation ¶
Index ¶
- Constants
- type ApiError
- type ApiException
- type ApplicationException
- type AuthenticationError
- type AuthenticationErrorReason
- type AuthorizationError
- type AuthorizationErrorReason
- type BasicAuth
- type ClientTermsError
- type ClientTermsErrorReason
- type ContentLabel
- type ContentLabelType
- type Criterion
- type CriterionError
- type CriterionErrorReason
- type CriterionType
- type CustomerNegativeCriterion
- type CustomerNegativeCriterionError
- type CustomerNegativeCriterionErrorReason
- type CustomerNegativeCriterionOperation
- type CustomerNegativeCriterionPage
- type CustomerNegativeCriterionReturnValue
- type CustomerNegativeCriterionServiceInterface
- func (service *CustomerNegativeCriterionServiceInterface) AddHeader(header interface{})
- func (service *CustomerNegativeCriterionServiceInterface) Get(request *Get) (*GetResponse, error)
- func (service *CustomerNegativeCriterionServiceInterface) Mutate(request *Mutate) (*MutateResponse, error)
- func (service *CustomerNegativeCriterionServiceInterface) Query(request *Query) (*QueryResponse, error)
- func (service *CustomerNegativeCriterionServiceInterface) SetHeader(header interface{})
- type DatabaseError
- type DatabaseErrorReason
- type DateError
- type DateErrorReason
- type DateRange
- type DistinctError
- type DistinctErrorReason
- type EntityCountLimitExceeded
- type EntityCountLimitExceededReason
- type EntityNotFound
- type EntityNotFoundReason
- type FieldPathElement
- type Get
- type GetResponse
- type IdError
- type IdErrorReason
- type InternalApiError
- type InternalApiErrorReason
- type ListReturnValue
- type MobileAppCategory
- type MobileApplication
- type Mutate
- type MutateResponse
- type NotEmptyError
- type NotEmptyErrorReason
- type NullError
- type NullErrorReason
- type Operation
- type OperationAccessDenied
- type OperationAccessDeniedReason
- type Operator
- type OperatorError
- type OperatorErrorReason
- type OrderBy
- type Page
- type Paging
- type Placement
- type Predicate
- type PredicateOperator
- type Query
- type QueryResponse
- type QuotaCheckError
- type QuotaCheckErrorReason
- type RangeError
- type RangeErrorReason
- type RateExceededError
- type RateExceededErrorReason
- type ReadOnlyError
- type ReadOnlyErrorReason
- type RejectedError
- type RejectedErrorReason
- type RequestError
- type RequestErrorReason
- type RequiredError
- type RequiredErrorReason
- type SOAPBody
- type SOAPClient
- type SOAPEnvelope
- type SOAPFault
- type SOAPHeader
- type Selector
- type SelectorError
- type SelectorErrorReason
- type SizeLimitError
- type SizeLimitErrorReason
- type SoapHeader
- type SoapResponseHeader
- type SortOrder
- type StringFormatError
- type StringFormatErrorReason
- type StringLengthError
- type StringLengthErrorReason
- type WSSPassword
- type WSSSecurityHeader
- type WSSUsername
- type WSSUsernameToken
- type YouTubeChannel
- type YouTubeVideo
Constants ¶
const ( // Predefined WSS namespaces to be used in WssNsWSSE string = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" WssNsWSU string = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" WssNsType string = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiError ¶
type ApiError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ApiError"` // // The OGNL field path to identify cause of error. // FieldPath string `xml:"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"` // // The data that caused the error. // Trigger string `xml:"trigger,omitempty"` // // A simple string representation of the error and reason. // ErrorString string `xml:"errorString,omitempty"` // // Indicates that this instance is a subtype of ApiError. // Although this field is returned in the response, it is ignored on input // and cannot be selected. Specify xsi:type instead. // ApiErrorType string `xml:"ApiError.Type,omitempty"` }
type ApiException ¶
type ApiException struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ApiException"` *ApplicationException // // List of errors. // Errors []*ApiError `xml:"errors,omitempty"` }
type ApplicationException ¶
type ApplicationException struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ApplicationException"` // // Error message. // Message string `xml:"message,omitempty"` // // Indicates that this instance is a subtype of ApplicationException. // Although this field is returned in the response, it is ignored on input // and cannot be selected. Specify xsi:type instead. // ApplicationExceptionType string `xml:"ApplicationException.Type,omitempty"` }
type AuthenticationError ¶
type AuthenticationError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 AuthenticationError"` *ApiError // // The error reason represented by an enum. // Reason *AuthenticationErrorReason `xml:"reason,omitempty"` }
type AuthenticationErrorReason ¶
type AuthenticationErrorReason string
The single reason for the authentication failure.
const ( // // Authentication of the request failed. // AuthenticationErrorReasonAUTHENTICATION_FAILED AuthenticationErrorReason = "AUTHENTICATION_FAILED" // // Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. // Starting version V201409 ClientCustomerId will be required for all requests except // for {@link CustomerService#get} // AuthenticationErrorReasonCLIENT_CUSTOMER_ID_IS_REQUIRED AuthenticationErrorReason = "CLIENT_CUSTOMER_ID_IS_REQUIRED" // // Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD. // AuthenticationErrorReasonCLIENT_EMAIL_REQUIRED AuthenticationErrorReason = "CLIENT_EMAIL_REQUIRED" // // Client customer Id is not a number. // AuthenticationErrorReasonCLIENT_CUSTOMER_ID_INVALID AuthenticationErrorReason = "CLIENT_CUSTOMER_ID_INVALID" // // Client customer Id is not a number. // AuthenticationErrorReasonCLIENT_EMAIL_INVALID AuthenticationErrorReason = "CLIENT_EMAIL_INVALID" // // Client email is not a valid customer email. // AuthenticationErrorReasonCLIENT_EMAIL_FAILED_TO_AUTHENTICATE AuthenticationErrorReason = "CLIENT_EMAIL_FAILED_TO_AUTHENTICATE" // // No customer found for the customer id provided in the header. // AuthenticationErrorReasonCUSTOMER_NOT_FOUND AuthenticationErrorReason = "CUSTOMER_NOT_FOUND" // // Client's Google Account is deleted. // AuthenticationErrorReasonGOOGLE_ACCOUNT_DELETED AuthenticationErrorReason = "GOOGLE_ACCOUNT_DELETED" // // Google account login token in the cookie is invalid. // AuthenticationErrorReasonGOOGLE_ACCOUNT_COOKIE_INVALID AuthenticationErrorReason = "GOOGLE_ACCOUNT_COOKIE_INVALID" // // problem occurred during Google account authentication. // AuthenticationErrorReasonFAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT AuthenticationErrorReason = "FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT" // // The user in the google account login token does not match the UserId in the cookie. // AuthenticationErrorReasonGOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH AuthenticationErrorReason = "GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH" // // Login cookie is required for authentication. // AuthenticationErrorReasonLOGIN_COOKIE_REQUIRED AuthenticationErrorReason = "LOGIN_COOKIE_REQUIRED" // // User in the cookie is not a valid Ads user. // AuthenticationErrorReasonNOT_ADS_USER AuthenticationErrorReason = "NOT_ADS_USER" // // Oauth token in the header is not valid. // AuthenticationErrorReasonOAUTH_TOKEN_INVALID AuthenticationErrorReason = "OAUTH_TOKEN_INVALID" // // Oauth token in the header has expired. // AuthenticationErrorReasonOAUTH_TOKEN_EXPIRED AuthenticationErrorReason = "OAUTH_TOKEN_EXPIRED" // // Oauth token in the header has been disabled. // AuthenticationErrorReasonOAUTH_TOKEN_DISABLED AuthenticationErrorReason = "OAUTH_TOKEN_DISABLED" // // Oauth token in the header has been revoked. // AuthenticationErrorReasonOAUTH_TOKEN_REVOKED AuthenticationErrorReason = "OAUTH_TOKEN_REVOKED" // // Oauth token HTTP header is malformed. // AuthenticationErrorReasonOAUTH_TOKEN_HEADER_INVALID AuthenticationErrorReason = "OAUTH_TOKEN_HEADER_INVALID" // // Login cookie is not valid. // AuthenticationErrorReasonLOGIN_COOKIE_INVALID AuthenticationErrorReason = "LOGIN_COOKIE_INVALID" // // Failed to decrypt the login cookie. // AuthenticationErrorReasonFAILED_TO_RETRIEVE_LOGIN_COOKIE AuthenticationErrorReason = "FAILED_TO_RETRIEVE_LOGIN_COOKIE" // // User Id in the header is not a valid id. // AuthenticationErrorReasonUSER_ID_INVALID AuthenticationErrorReason = "USER_ID_INVALID" )
type AuthorizationError ¶
type AuthorizationError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 AuthorizationError"` *ApiError // // The error reason represented by an enum. // Reason *AuthorizationErrorReason `xml:"reason,omitempty"` }
type AuthorizationErrorReason ¶
type AuthorizationErrorReason string
The reasons for the authorization error.
const ( // // Could not complete authorization due to an internal problem. // AuthorizationErrorReasonUNABLE_TO_AUTHORIZE AuthorizationErrorReason = "UNABLE_TO_AUTHORIZE" // // Customer has no AdWords account. // AuthorizationErrorReasonNO_ADWORDS_ACCOUNT_FOR_CUSTOMER AuthorizationErrorReason = "NO_ADWORDS_ACCOUNT_FOR_CUSTOMER" // // User doesn't have permission to access customer. // AuthorizationErrorReasonUSER_PERMISSION_DENIED AuthorizationErrorReason = "USER_PERMISSION_DENIED" // // Effective user doesn't have permission to access this customer. // AuthorizationErrorReasonEFFECTIVE_USER_PERMISSION_DENIED AuthorizationErrorReason = "EFFECTIVE_USER_PERMISSION_DENIED" // // Access denied since the customer is not active. // AuthorizationErrorReasonCUSTOMER_NOT_ACTIVE AuthorizationErrorReason = "CUSTOMER_NOT_ACTIVE" // // User has read-only permission cannot mutate. // AuthorizationErrorReasonUSER_HAS_READONLY_PERMISSION AuthorizationErrorReason = "USER_HAS_READONLY_PERMISSION" // // No customer found. // AuthorizationErrorReasonNO_CUSTOMER_FOUND AuthorizationErrorReason = "NO_CUSTOMER_FOUND" // // Developer doesn't have permission to access service. // AuthorizationErrorReasonSERVICE_ACCESS_DENIED AuthorizationErrorReason = "SERVICE_ACCESS_DENIED" )
type ClientTermsError ¶
type ClientTermsError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ClientTermsError"` *ApiError Reason *ClientTermsErrorReason `xml:"reason,omitempty"` }
type ClientTermsErrorReason ¶
type ClientTermsErrorReason string
Enums for the various reasons an error can be thrown as a result of ClientTerms violation.
const ( // // Customer has not agreed to the latest AdWords Terms & Conditions // ClientTermsErrorReasonINCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED ClientTermsErrorReason = "INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED" )
type ContentLabel ¶
type ContentLabel struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ContentLabel"` *Criterion // // Content label type // <span class="constraint Selectable">This field can be selected using the value "ContentLabelType".</span><span class="constraint Filterable">This field can be filtered on.</span> // <span class="constraint Required">This field is required and should not be {@code null} when it is contained within {@link Operator}s : ADD.</span> // ContentLabelType *ContentLabelType `xml:"contentLabelType,omitempty"` }
type ContentLabelType ¶
type ContentLabelType string
Content label type.
const ( // // Sexually suggestive content // ContentLabelTypeADULTISH ContentLabelType = "ADULTISH" // // Error pages // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. // ContentLabelTypeAFE ContentLabelType = "AFE" // // Below the fold placements // ContentLabelTypeBELOW_THE_FOLD ContentLabelType = "BELOW_THE_FOLD" // // Military & international conflict // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. Please use the {@code TRAGEDY} label instead of this one going forward. // ContentLabelTypeCONFLICT ContentLabelType = "CONFLICT" // // Parked domains // ContentLabelTypeDP ContentLabelType = "DP" // // Embedded video // ContentLabelTypeEMBEDDED_VIDEO ContentLabelType = "EMBEDDED_VIDEO" // // Games // ContentLabelTypeGAMES ContentLabelType = "GAMES" // // Sensational & shocking // ContentLabelTypeJUVENILE ContentLabelType = "JUVENILE" // // Profanity & rough language // ContentLabelTypePROFANITY ContentLabelType = "PROFANITY" // // Forums // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. // ContentLabelTypeUGC_FORUMS ContentLabelType = "UGC_FORUMS" // // Image-sharing pages // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. // ContentLabelTypeUGC_IMAGES ContentLabelType = "UGC_IMAGES" // // Social networks // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. // ContentLabelTypeUGC_SOCIAL ContentLabelType = "UGC_SOCIAL" // // Video-sharing pages // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. // ContentLabelTypeUGC_VIDEOS ContentLabelType = "UGC_VIDEOS" // // Crime, police & emergency // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. Please use the {@code TRAGEDY} label instead of this one going forward. // ContentLabelTypeSIRENS ContentLabelType = "SIRENS" // // Tragedy & conflict // ContentLabelTypeTRAGEDY ContentLabelType = "TRAGEDY" // // Video // ContentLabelTypeVIDEO ContentLabelType = "VIDEO" // // Content rating: G // ContentLabelTypeVIDEO_RATING_DV_G ContentLabelType = "VIDEO_RATING_DV_G" // // Content rating: PG // ContentLabelTypeVIDEO_RATING_DV_PG ContentLabelType = "VIDEO_RATING_DV_PG" // // Content rating: T // ContentLabelTypeVIDEO_RATING_DV_T ContentLabelType = "VIDEO_RATING_DV_T" // // Content rating: MA // ContentLabelTypeVIDEO_RATING_DV_MA ContentLabelType = "VIDEO_RATING_DV_MA" // // Content rating: not yet rated // ContentLabelTypeVIDEO_NOT_YET_RATED ContentLabelType = "VIDEO_NOT_YET_RATED" // // Live streaming video // ContentLabelTypeLIVE_STREAMING_VIDEO ContentLabelType = "LIVE_STREAMING_VIDEO" // // Allowed gambling content. // // <p class="note"><b>Note:</b> Starting with v201710, this label is deprecated and can only be // removed from campaigns - it can no longer be added. A future release will remove this label // entirely. // ContentLabelTypeALLOWED_GAMBLING_CONTENT ContentLabelType = "ALLOWED_GAMBLING_CONTENT" // // <span class="constraint Rejected">Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.</span> // ContentLabelTypeUNKNOWN ContentLabelType = "UNKNOWN" )
type Criterion ¶
type Criterion struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Criterion"` // // ID of this criterion. // <span class="constraint Selectable">This field can be selected using the value "Id".</span><span class="constraint Filterable">This field can be filtered on.</span> // <span class="constraint Required">This field is required and should not be {@code null} when it is contained within {@link Operator}s : SET, REMOVE.</span> // Id int64 `xml:"id,omitempty"` // // <span class="constraint Selectable">This field can be selected using the value "CriteriaType".</span><span class="constraint Filterable">This field can be filtered on.</span> // <span class="constraint ReadOnly">This field is read only and will be ignored when sent to the API.</span> // Type_ *CriterionType `xml:"type,omitempty"` // // Indicates that this instance is a subtype of Criterion. // Although this field is returned in the response, it is ignored on input // and cannot be selected. Specify xsi:type instead. // CriterionType string `xml:"Criterion.Type,omitempty"` }
type CriterionError ¶
type CriterionError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 CriterionError"` *ApiError Reason *CriterionErrorReason `xml:"reason,omitempty"` }
type CriterionErrorReason ¶
type CriterionErrorReason string
const ( // // Concrete type of criterion is required for ADD and SET operations. // CriterionErrorReasonCONCRETE_TYPE_REQUIRED CriterionErrorReason = "CONCRETE_TYPE_REQUIRED" // // The category requested for exclusion is invalid. // CriterionErrorReasonINVALID_EXCLUDED_CATEGORY CriterionErrorReason = "INVALID_EXCLUDED_CATEGORY" // // Invalid keyword criteria text. // CriterionErrorReasonINVALID_KEYWORD_TEXT CriterionErrorReason = "INVALID_KEYWORD_TEXT" // // Keyword text should be less than 80 chars. // CriterionErrorReasonKEYWORD_TEXT_TOO_LONG CriterionErrorReason = "KEYWORD_TEXT_TOO_LONG" // // Keyword text has too many words. // CriterionErrorReasonKEYWORD_HAS_TOO_MANY_WORDS CriterionErrorReason = "KEYWORD_HAS_TOO_MANY_WORDS" // // Keyword text has invalid characters or symbols. // CriterionErrorReasonKEYWORD_HAS_INVALID_CHARS CriterionErrorReason = "KEYWORD_HAS_INVALID_CHARS" // // Invalid placement URL. // CriterionErrorReasonINVALID_PLACEMENT_URL CriterionErrorReason = "INVALID_PLACEMENT_URL" // // Invalid user list criterion. // CriterionErrorReasonINVALID_USER_LIST CriterionErrorReason = "INVALID_USER_LIST" // // Invalid user interest criterion. // CriterionErrorReasonINVALID_USER_INTEREST CriterionErrorReason = "INVALID_USER_INTEREST" // // Placement URL has wrong format. // CriterionErrorReasonINVALID_FORMAT_FOR_PLACEMENT_URL CriterionErrorReason = "INVALID_FORMAT_FOR_PLACEMENT_URL" // // Placement URL is too long. // CriterionErrorReasonPLACEMENT_URL_IS_TOO_LONG CriterionErrorReason = "PLACEMENT_URL_IS_TOO_LONG" // // Indicates the URL contains an illegal character. // CriterionErrorReasonPLACEMENT_URL_HAS_ILLEGAL_CHAR CriterionErrorReason = "PLACEMENT_URL_HAS_ILLEGAL_CHAR" // // Indicates the URL contains multiple comma separated URLs. // CriterionErrorReasonPLACEMENT_URL_HAS_MULTIPLE_SITES_IN_LINE CriterionErrorReason = "PLACEMENT_URL_HAS_MULTIPLE_SITES_IN_LINE" // // Indicates the domain is blacklisted. // CriterionErrorReasonPLACEMENT_IS_NOT_AVAILABLE_FOR_TARGETING_OR_EXCLUSION CriterionErrorReason = "PLACEMENT_IS_NOT_AVAILABLE_FOR_TARGETING_OR_EXCLUSION" // // Invalid vertical path. // CriterionErrorReasonINVALID_VERTICAL_PATH CriterionErrorReason = "INVALID_VERTICAL_PATH" // // Indicates the placement is a YouTube vertical channel, which is no longer supported. // CriterionErrorReasonYOUTUBE_VERTICAL_CHANNEL_DEPRECATED CriterionErrorReason = "YOUTUBE_VERTICAL_CHANNEL_DEPRECATED" // // Indicates the placement is a YouTube demographic channel, which is no longer supported. // CriterionErrorReasonYOUTUBE_DEMOGRAPHIC_CHANNEL_DEPRECATED CriterionErrorReason = "YOUTUBE_DEMOGRAPHIC_CHANNEL_DEPRECATED" // // YouTube urls are not supported in Placement criterion. Use YouTubeChannel and // YouTubeVideo criterion instead. // CriterionErrorReasonYOUTUBE_URL_UNSUPPORTED CriterionErrorReason = "YOUTUBE_URL_UNSUPPORTED" // // Criteria type can not be excluded by the customer, // like AOL account type cannot target site type criteria. // CriterionErrorReasonCANNOT_EXCLUDE_CRITERIA_TYPE CriterionErrorReason = "CANNOT_EXCLUDE_CRITERIA_TYPE" // // Criteria type can not be targeted. // CriterionErrorReasonCANNOT_ADD_CRITERIA_TYPE CriterionErrorReason = "CANNOT_ADD_CRITERIA_TYPE" // // Product filter in the product criteria has invalid characters. // Operand and the argument in the filter can not have "==" or "&+". // CriterionErrorReasonINVALID_PRODUCT_FILTER CriterionErrorReason = "INVALID_PRODUCT_FILTER" // // Product filter in the product criteria is translated to a string as // operand1==argument1&+operand2==argument2, maximum allowed length for // the string is 255 chars. // CriterionErrorReasonPRODUCT_FILTER_TOO_LONG CriterionErrorReason = "PRODUCT_FILTER_TOO_LONG" // // Not allowed to exclude similar user list. // CriterionErrorReasonCANNOT_EXCLUDE_SIMILAR_USER_LIST CriterionErrorReason = "CANNOT_EXCLUDE_SIMILAR_USER_LIST" // // Not allowed to target a closed user list. // CriterionErrorReasonCANNOT_ADD_CLOSED_USER_LIST CriterionErrorReason = "CANNOT_ADD_CLOSED_USER_LIST" // // Not allowed to add display only UserLists to search only campaigns. // CriterionErrorReasonCANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_ONLY_CAMPAIGNS CriterionErrorReason = "CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_ONLY_CAMPAIGNS" // // Not allowed to add display only UserLists to search plus campaigns. // CriterionErrorReasonCANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_CAMPAIGNS CriterionErrorReason = "CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_CAMPAIGNS" // // Not allowed to add display only UserLists to shopping campaigns. // CriterionErrorReasonCANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SHOPPING_CAMPAIGNS CriterionErrorReason = "CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SHOPPING_CAMPAIGNS" // // Not allowed to add User interests to search only campaigns. // CriterionErrorReasonCANNOT_ADD_USER_INTERESTS_TO_SEARCH_CAMPAIGNS CriterionErrorReason = "CANNOT_ADD_USER_INTERESTS_TO_SEARCH_CAMPAIGNS" // // Not allowed to set bids for this criterion type in search campaigns // CriterionErrorReasonCANNOT_SET_BIDS_ON_CRITERION_TYPE_IN_SEARCH_CAMPAIGNS CriterionErrorReason = "CANNOT_SET_BIDS_ON_CRITERION_TYPE_IN_SEARCH_CAMPAIGNS" // // Final URLs, URL Templates and CustomParameters cannot be set for the criterion // types of Gender, AgeRange, UserList, Placement, MobileApp, and MobileAppCategory // in search campaigns and shopping campaigns. // CriterionErrorReasonCANNOT_ADD_URLS_TO_CRITERION_TYPE_FOR_CAMPAIGN_TYPE CriterionErrorReason = "CANNOT_ADD_URLS_TO_CRITERION_TYPE_FOR_CAMPAIGN_TYPE" // // IP address is not valid. // CriterionErrorReasonINVALID_IP_ADDRESS CriterionErrorReason = "INVALID_IP_ADDRESS" // // IP format is not valid. // CriterionErrorReasonINVALID_IP_FORMAT CriterionErrorReason = "INVALID_IP_FORMAT" // // Mobile application is not valid. // CriterionErrorReasonINVALID_MOBILE_APP CriterionErrorReason = "INVALID_MOBILE_APP" // // Mobile application category is not valid. // CriterionErrorReasonINVALID_MOBILE_APP_CATEGORY CriterionErrorReason = "INVALID_MOBILE_APP_CATEGORY" // // The CriterionId does not exist or is of the incorrect type. // CriterionErrorReasonINVALID_CRITERION_ID CriterionErrorReason = "INVALID_CRITERION_ID" // // The Criterion is not allowed to be targeted. // CriterionErrorReasonCANNOT_TARGET_CRITERION CriterionErrorReason = "CANNOT_TARGET_CRITERION" // // The criterion is not allowed to be targeted as it is deprecated. // CriterionErrorReasonCANNOT_TARGET_OBSOLETE_CRITERION CriterionErrorReason = "CANNOT_TARGET_OBSOLETE_CRITERION" // // The CriterionId is not valid for the type. // CriterionErrorReasonCRITERION_ID_AND_TYPE_MISMATCH CriterionErrorReason = "CRITERION_ID_AND_TYPE_MISMATCH" // // Distance for the radius for the proximity criterion is invalid. // CriterionErrorReasonINVALID_PROXIMITY_RADIUS CriterionErrorReason = "INVALID_PROXIMITY_RADIUS" // // Units for the distance for the radius for the proximity criterion is invalid. // CriterionErrorReasonINVALID_PROXIMITY_RADIUS_UNITS CriterionErrorReason = "INVALID_PROXIMITY_RADIUS_UNITS" // // Street address is too short. // CriterionErrorReasonINVALID_STREETADDRESS_LENGTH CriterionErrorReason = "INVALID_STREETADDRESS_LENGTH" // // City name in the address is too short. // CriterionErrorReasonINVALID_CITYNAME_LENGTH CriterionErrorReason = "INVALID_CITYNAME_LENGTH" // // Region code in the address is too short. // CriterionErrorReasonINVALID_REGIONCODE_LENGTH CriterionErrorReason = "INVALID_REGIONCODE_LENGTH" // // Region name in the address is not valid. // CriterionErrorReasonINVALID_REGIONNAME_LENGTH CriterionErrorReason = "INVALID_REGIONNAME_LENGTH" // // Postal code in the address is not valid. // CriterionErrorReasonINVALID_POSTALCODE_LENGTH CriterionErrorReason = "INVALID_POSTALCODE_LENGTH" // // Country code in the address is not valid. // CriterionErrorReasonINVALID_COUNTRY_CODE CriterionErrorReason = "INVALID_COUNTRY_CODE" // // Latitude for the GeoPoint is not valid. // CriterionErrorReasonINVALID_LATITUDE CriterionErrorReason = "INVALID_LATITUDE" // // Longitude for the GeoPoint is not valid. // CriterionErrorReasonINVALID_LONGITUDE CriterionErrorReason = "INVALID_LONGITUDE" // // The Proximity input is not valid. Both address and geoPoint cannot be null. // CriterionErrorReasonPROXIMITY_GEOPOINT_AND_ADDRESS_BOTH_CANNOT_BE_NULL CriterionErrorReason = "PROXIMITY_GEOPOINT_AND_ADDRESS_BOTH_CANNOT_BE_NULL" // // The Proximity address cannot be geocoded to a valid lat/long. // CriterionErrorReasonINVALID_PROXIMITY_ADDRESS CriterionErrorReason = "INVALID_PROXIMITY_ADDRESS" // // User domain name is not valid. // CriterionErrorReasonINVALID_USER_DOMAIN_NAME CriterionErrorReason = "INVALID_USER_DOMAIN_NAME" // // Length of serialized criterion parameter exceeded size limit. // CriterionErrorReasonCRITERION_PARAMETER_TOO_LONG CriterionErrorReason = "CRITERION_PARAMETER_TOO_LONG" // // Time interval in the AdSchedule overlaps with another AdSchedule. // CriterionErrorReasonAD_SCHEDULE_TIME_INTERVALS_OVERLAP CriterionErrorReason = "AD_SCHEDULE_TIME_INTERVALS_OVERLAP" // // AdSchedule time interval cannot span multiple days. // CriterionErrorReasonAD_SCHEDULE_INTERVAL_CANNOT_SPAN_MULTIPLE_DAYS CriterionErrorReason = "AD_SCHEDULE_INTERVAL_CANNOT_SPAN_MULTIPLE_DAYS" // // AdSchedule time interval specified is invalid, // endTime cannot be earlier than startTime. // CriterionErrorReasonAD_SCHEDULE_INVALID_TIME_INTERVAL CriterionErrorReason = "AD_SCHEDULE_INVALID_TIME_INTERVAL" // // The number of AdSchedule entries in a day exceeds the limit. // CriterionErrorReasonAD_SCHEDULE_EXCEEDED_INTERVALS_PER_DAY_LIMIT CriterionErrorReason = "AD_SCHEDULE_EXCEEDED_INTERVALS_PER_DAY_LIMIT" // // CriteriaId does not match the interval of the AdSchedule specified. // CriterionErrorReasonAD_SCHEDULE_CRITERION_ID_MISMATCHING_FIELDS CriterionErrorReason = "AD_SCHEDULE_CRITERION_ID_MISMATCHING_FIELDS" // // Cannot set bid modifier for this criterion type. // CriterionErrorReasonCANNOT_BID_MODIFY_CRITERION_TYPE CriterionErrorReason = "CANNOT_BID_MODIFY_CRITERION_TYPE" // // Cannot bid modify criterion, since it is opted out of the campaign. // CriterionErrorReasonCANNOT_BID_MODIFY_CRITERION_CAMPAIGN_OPTED_OUT CriterionErrorReason = "CANNOT_BID_MODIFY_CRITERION_CAMPAIGN_OPTED_OUT" // // Cannot set bid modifier for a negative criterion. // CriterionErrorReasonCANNOT_BID_MODIFY_NEGATIVE_CRITERION CriterionErrorReason = "CANNOT_BID_MODIFY_NEGATIVE_CRITERION" // // Bid Modifier already exists. Use SET operation to update. // CriterionErrorReasonBID_MODIFIER_ALREADY_EXISTS CriterionErrorReason = "BID_MODIFIER_ALREADY_EXISTS" // // Feed Id is not allowed in these Location Groups. // CriterionErrorReasonFEED_ID_NOT_ALLOWED CriterionErrorReason = "FEED_ID_NOT_ALLOWED" // // The account may not use the requested criteria type. For example, some // accounts are restricted to keywords only. // CriterionErrorReasonACCOUNT_INELIGIBLE_FOR_CRITERIA_TYPE CriterionErrorReason = "ACCOUNT_INELIGIBLE_FOR_CRITERIA_TYPE" // // The requested criteria type cannot be used with campaign or ad group bidding strategy. // CriterionErrorReasonCRITERIA_TYPE_INVALID_FOR_BIDDING_STRATEGY CriterionErrorReason = "CRITERIA_TYPE_INVALID_FOR_BIDDING_STRATEGY" // // The Criterion is not allowed to be excluded. // CriterionErrorReasonCANNOT_EXCLUDE_CRITERION CriterionErrorReason = "CANNOT_EXCLUDE_CRITERION" // // The criterion is not allowed to be removed. For example, we cannot remove any // of the platform criterion. // CriterionErrorReasonCANNOT_REMOVE_CRITERION CriterionErrorReason = "CANNOT_REMOVE_CRITERION" // // The combined length of product dimension values of the product scope criterion is too long. // CriterionErrorReasonPRODUCT_SCOPE_TOO_LONG CriterionErrorReason = "PRODUCT_SCOPE_TOO_LONG" // // Product scope contains too many dimensions. // CriterionErrorReasonPRODUCT_SCOPE_TOO_MANY_DIMENSIONS CriterionErrorReason = "PRODUCT_SCOPE_TOO_MANY_DIMENSIONS" // // The combined length of product dimension values of the product partition criterion is too // long. // CriterionErrorReasonPRODUCT_PARTITION_TOO_LONG CriterionErrorReason = "PRODUCT_PARTITION_TOO_LONG" // // Product partition contains too many dimensions. // CriterionErrorReasonPRODUCT_PARTITION_TOO_MANY_DIMENSIONS CriterionErrorReason = "PRODUCT_PARTITION_TOO_MANY_DIMENSIONS" // // The product dimension is invalid (e.g. dimension contains illegal value, dimension type is // represented with wrong class, etc). Product dimension value can not contain "==" or "&+". // CriterionErrorReasonINVALID_PRODUCT_DIMENSION CriterionErrorReason = "INVALID_PRODUCT_DIMENSION" // // Product dimension type is either invalid for campaigns of this type or cannot be used in the // current context. BIDDING_CATEGORY_Lx and PRODUCT_TYPE_Lx product dimensions must be used in // ascending order of their levels: L1, L2, L3, L4, L5... The levels must be specified // sequentially and start from L1. Furthermore, an "others" product partition cannot be // subdivided with a dimension of the same type but of a higher level ("others" // BIDDING_CATEGORY_L3 can be subdivided with BRAND but not with BIDDING_CATEGORY_L4). // CriterionErrorReasonINVALID_PRODUCT_DIMENSION_TYPE CriterionErrorReason = "INVALID_PRODUCT_DIMENSION_TYPE" // // Bidding categories do not form a valid path in the Shopping bidding category taxonomy. // CriterionErrorReasonINVALID_PRODUCT_BIDDING_CATEGORY CriterionErrorReason = "INVALID_PRODUCT_BIDDING_CATEGORY" // // ShoppingSetting must be added to the campaign before ProductScope criteria can be added. // CriterionErrorReasonMISSING_SHOPPING_SETTING CriterionErrorReason = "MISSING_SHOPPING_SETTING" // // Matching function is invalid. // CriterionErrorReasonINVALID_MATCHING_FUNCTION CriterionErrorReason = "INVALID_MATCHING_FUNCTION" // // Filter parameters not allowed for location groups targeting. // CriterionErrorReasonLOCATION_FILTER_NOT_ALLOWED CriterionErrorReason = "LOCATION_FILTER_NOT_ALLOWED" // // Given location filter parameter is invalid for location groups targeting. // CriterionErrorReasonLOCATION_FILTER_INVALID CriterionErrorReason = "LOCATION_FILTER_INVALID" // // Criteria type cannot be associated with a campaign and its ad group(s) simultaneously. // CriterionErrorReasonCANNOT_ATTACH_CRITERIA_AT_CAMPAIGN_AND_ADGROUP CriterionErrorReason = "CANNOT_ATTACH_CRITERIA_AT_CAMPAIGN_AND_ADGROUP" CriterionErrorReasonUNKNOWN CriterionErrorReason = "UNKNOWN" )
type CriterionType ¶
type CriterionType string
The types of criteria.
const ( // // Content label for exclusion. // CriterionTypeCONTENT_LABEL CriterionType = "CONTENT_LABEL" // // Keyword. e.g. 'mars cruise' // CriterionTypeKEYWORD CriterionType = "KEYWORD" // // Placement. aka Website. e.g. 'www.flowers4sale.com' // CriterionTypePLACEMENT CriterionType = "PLACEMENT" // // Vertical, e.g. 'category::Animals>Pets' This is for vertical targeting on the content // network. // CriterionTypeVERTICAL CriterionType = "VERTICAL" // // User lists, are links to sets of users defined by the advertiser. // CriterionTypeUSER_LIST CriterionType = "USER_LIST" // // User interests, categories of interests the user is interested in. // CriterionTypeUSER_INTEREST CriterionType = "USER_INTEREST" // // Mobile applications to target. // CriterionTypeMOBILE_APPLICATION CriterionType = "MOBILE_APPLICATION" // // Mobile application categories to target. // CriterionTypeMOBILE_APP_CATEGORY CriterionType = "MOBILE_APP_CATEGORY" // // Product partition (product group) in a shopping campaign. // CriterionTypePRODUCT_PARTITION CriterionType = "PRODUCT_PARTITION" // // IP addresses to exclude. // CriterionTypeIP_BLOCK CriterionType = "IP_BLOCK" // // Webpages of an advertiser's website to target. // CriterionTypeWEBPAGE CriterionType = "WEBPAGE" // // Languages to target. // CriterionTypeLANGUAGE CriterionType = "LANGUAGE" // // Geographic regions to target. // CriterionTypeLOCATION CriterionType = "LOCATION" // // Age Range to exclude. // CriterionTypeAGE_RANGE CriterionType = "AGE_RANGE" // // Mobile carriers to target. // CriterionTypeCARRIER CriterionType = "CARRIER" // // Mobile operating system versions to target. // CriterionTypeOPERATING_SYSTEM_VERSION CriterionType = "OPERATING_SYSTEM_VERSION" // // Mobile devices to target. // CriterionTypeMOBILE_DEVICE CriterionType = "MOBILE_DEVICE" // // Gender to exclude. // CriterionTypeGENDER CriterionType = "GENDER" // // Parent to target and exclude. // CriterionTypePARENT CriterionType = "PARENT" // // Proximity (area within a radius) to target. // CriterionTypePROXIMITY CriterionType = "PROXIMITY" // // Platforms to target. // CriterionTypePLATFORM CriterionType = "PLATFORM" // // Representing preferred content bid modifier. // CriterionTypePREFERRED_CONTENT CriterionType = "PREFERRED_CONTENT" // // AdSchedule or specific days and time intervals to target. // CriterionTypeAD_SCHEDULE CriterionType = "AD_SCHEDULE" // // Targeting based on location groups. // CriterionTypeLOCATION_GROUPS CriterionType = "LOCATION_GROUPS" // // Scope of products. Contains a list of product dimensions, all of which a product has to match // to be included in the campaign. // CriterionTypePRODUCT_SCOPE CriterionType = "PRODUCT_SCOPE" // // YouTube video to target. // CriterionTypeYOUTUBE_VIDEO CriterionType = "YOUTUBE_VIDEO" // // YouTube channel to target. // CriterionTypeYOUTUBE_CHANNEL CriterionType = "YOUTUBE_CHANNEL" // // Enables advertisers to target paid apps. // CriterionTypeAPP_PAYMENT_MODEL CriterionType = "APP_PAYMENT_MODEL" // // Income range to target and exclude. // CriterionTypeINCOME_RANGE CriterionType = "INCOME_RANGE" // // Interaction type to bid modify. // CriterionTypeINTERACTION_TYPE CriterionType = "INTERACTION_TYPE" // // <span class="constraint Rejected">Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.</span> // CriterionTypeUNKNOWN CriterionType = "UNKNOWN" )
type CustomerNegativeCriterionError ¶
type CustomerNegativeCriterionError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 CustomerNegativeCriterionError"` *ApiError Reason *CustomerNegativeCriterionErrorReason `xml:"reason,omitempty"` }
type CustomerNegativeCriterionErrorReason ¶
type CustomerNegativeCriterionErrorReason string
Error reasons
const ( CustomerNegativeCriterionErrorReasonINVALID_CRITERION_TYPE CustomerNegativeCriterionErrorReason = "INVALID_CRITERION_TYPE" // // Cannot create a criterion with a deleted SharedSet. // CustomerNegativeCriterionErrorReasonSHARED_SET_IS_DELETED CustomerNegativeCriterionErrorReason = "SHARED_SET_IS_DELETED" // // Cannot create a criterion with an invalid SharedSetType. // CustomerNegativeCriterionErrorReasonINVALID_SHARED_SET_TYPE CustomerNegativeCriterionErrorReason = "INVALID_SHARED_SET_TYPE" // // Only Xbid customers can exclude criteria of placement list type. // CustomerNegativeCriterionErrorReasonPLACEMENT_LIST_TYPE_ONLY_ALLOWED_FOR_XBID CustomerNegativeCriterionErrorReason = "PLACEMENT_LIST_TYPE_ONLY_ALLOWED_FOR_XBID" // // Manager customer is not allowed to add customer exclusion criteria. // CustomerNegativeCriterionErrorReasonMANAGER_CUSTOMER_CANNOT_ADD CustomerNegativeCriterionErrorReason = "MANAGER_CUSTOMER_CANNOT_ADD" CustomerNegativeCriterionErrorReasonCUSTOMER_EXCLUSION_CRITERION_ERROR CustomerNegativeCriterionErrorReason = "CUSTOMER_EXCLUSION_CRITERION_ERROR" )
type CustomerNegativeCriterionOperation ¶
type CustomerNegativeCriterionOperation struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 CustomerNegativeCriterionOperation"` *Operation // // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Operand *CustomerNegativeCriterion `xml:"operand,omitempty"` }
type CustomerNegativeCriterionPage ¶
type CustomerNegativeCriterionPage struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 CustomerNegativeCriterionPage"` *Page // // The result entries in this page // Entries []*CustomerNegativeCriterion `xml:"entries,omitempty"` }
type CustomerNegativeCriterionReturnValue ¶
type CustomerNegativeCriterionReturnValue struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 CustomerNegativeCriterionReturnValue"` *ListReturnValue Value []*CustomerNegativeCriterion `xml:"value,omitempty"` }
type CustomerNegativeCriterionServiceInterface ¶
type CustomerNegativeCriterionServiceInterface struct {
// contains filtered or unexported fields
}
func NewCustomerNegativeCriterionServiceInterface ¶
func NewCustomerNegativeCriterionServiceInterface(url string, tls bool, auth *BasicAuth) *CustomerNegativeCriterionServiceInterface
func NewCustomerNegativeCriterionServiceInterfaceWithTLSConfig ¶
func NewCustomerNegativeCriterionServiceInterfaceWithTLSConfig(url string, tlsCfg *tls.Config, auth *BasicAuth) *CustomerNegativeCriterionServiceInterface
func (*CustomerNegativeCriterionServiceInterface) AddHeader ¶
func (service *CustomerNegativeCriterionServiceInterface) AddHeader(header interface{})
func (*CustomerNegativeCriterionServiceInterface) Get ¶
func (service *CustomerNegativeCriterionServiceInterface) Get(request *Get) (*GetResponse, error)
Error can be either of the following types:
ApiException
Returns a list of CustomerNegativeCriterion that meets the selector criteria
@param selector filters the criteria returned @return The list of CustomerNegativeCriterion @throws ApiException
func (*CustomerNegativeCriterionServiceInterface) Mutate ¶
func (service *CustomerNegativeCriterionServiceInterface) Mutate(request *Mutate) (*MutateResponse, error)
Error can be either of the following types:
ApiException
Adds, removes negative criteria for a customer. These negative criteria apply to all campaigns of the customer.
@param operations A list of operations to apply @throws ApiException
func (*CustomerNegativeCriterionServiceInterface) Query ¶
func (service *CustomerNegativeCriterionServiceInterface) Query(request *Query) (*QueryResponse, error)
Error can be either of the following types:
ApiException
Returns the list of CustomerNegativeCriterion that match the query.
@param query The SQL-like AWQL query string. @return A list of CustomerNegativeCriterion. @throws ApiException
func (*CustomerNegativeCriterionServiceInterface) SetHeader ¶
func (service *CustomerNegativeCriterionServiceInterface) SetHeader(header interface{})
Backwards-compatible function: use AddHeader instead
type DatabaseError ¶
type DatabaseError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 DatabaseError"` *ApiError // // The error reason represented by an enum. // Reason *DatabaseErrorReason `xml:"reason,omitempty"` }
type DatabaseErrorReason ¶
type DatabaseErrorReason string
The reasons for the database error.
const ( // // A concurrency problem occurred as two threads were attempting to modify same object. // DatabaseErrorReasonCONCURRENT_MODIFICATION DatabaseErrorReason = "CONCURRENT_MODIFICATION" // // The permission was denied to access an object. // DatabaseErrorReasonPERMISSION_DENIED DatabaseErrorReason = "PERMISSION_DENIED" // // The user's access to an object has been prohibited. // DatabaseErrorReasonACCESS_PROHIBITED DatabaseErrorReason = "ACCESS_PROHIBITED" // // Requested campaign belongs to a product that is not supported by the api. // DatabaseErrorReasonCAMPAIGN_PRODUCT_NOT_SUPPORTED DatabaseErrorReason = "CAMPAIGN_PRODUCT_NOT_SUPPORTED" // // a duplicate key was detected upon insertion // DatabaseErrorReasonDUPLICATE_KEY DatabaseErrorReason = "DUPLICATE_KEY" // // a database error has occurred // DatabaseErrorReasonDATABASE_ERROR DatabaseErrorReason = "DATABASE_ERROR" // // an unknown error has occurred // DatabaseErrorReasonUNKNOWN DatabaseErrorReason = "UNKNOWN" )
type DateError ¶
type DateError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 DateError"` *ApiError // // The error reason represented by an enum. // Reason *DateErrorReason `xml:"reason,omitempty"` }
type DateErrorReason ¶
type DateErrorReason string
The reasons for the target error.
const ( // // Given field values do not correspond to a valid date. // DateErrorReasonINVALID_FIELD_VALUES_IN_DATE DateErrorReason = "INVALID_FIELD_VALUES_IN_DATE" // // Given field values do not correspond to a valid date time. // DateErrorReasonINVALID_FIELD_VALUES_IN_DATE_TIME DateErrorReason = "INVALID_FIELD_VALUES_IN_DATE_TIME" // // The string date's format should be yyyymmdd. // DateErrorReasonINVALID_STRING_DATE DateErrorReason = "INVALID_STRING_DATE" // // The string date range's format should be yyyymmdd yyyymmdd. // DateErrorReasonINVALID_STRING_DATE_RANGE DateErrorReason = "INVALID_STRING_DATE_RANGE" // // The string date time's format should be yyyymmdd hhmmss [tz]. // DateErrorReasonINVALID_STRING_DATE_TIME DateErrorReason = "INVALID_STRING_DATE_TIME" // // Date is before allowed minimum. // DateErrorReasonEARLIER_THAN_MINIMUM_DATE DateErrorReason = "EARLIER_THAN_MINIMUM_DATE" // // Date is after allowed maximum. // DateErrorReasonLATER_THAN_MAXIMUM_DATE DateErrorReason = "LATER_THAN_MAXIMUM_DATE" // // Date range bounds are not in order. // DateErrorReasonDATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE DateErrorReason = "DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE" // // Both dates in range are null. // DateErrorReasonDATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL DateErrorReason = "DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL" )
type DistinctError ¶
type DistinctError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 DistinctError"` *ApiError // // The error reason represented by an enum. // Reason *DistinctErrorReason `xml:"reason,omitempty"` }
type DistinctErrorReason ¶
type DistinctErrorReason string
The reasons for the validation error.
const ( DistinctErrorReasonDUPLICATE_ELEMENT DistinctErrorReason = "DUPLICATE_ELEMENT" DistinctErrorReasonDUPLICATE_TYPE DistinctErrorReason = "DUPLICATE_TYPE" )
type EntityCountLimitExceeded ¶
type EntityCountLimitExceeded struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 EntityCountLimitExceeded"` *ApiError // // Specifies which level's limit was exceeded. // Reason *EntityCountLimitExceededReason `xml:"reason,omitempty"` // // Id of the entity whose limit was exceeded. // EnclosingId string `xml:"enclosingId,omitempty"` // // The limit which was exceeded. // Limit int32 `xml:"limit,omitempty"` // // The account limit type which was exceeded. // AccountLimitType string `xml:"accountLimitType,omitempty"` // // The count of existing entities. // ExistingCount int32 `xml:"existingCount,omitempty"` }
type EntityCountLimitExceededReason ¶
type EntityCountLimitExceededReason string
Limits at various levels of the account.
const ( // // Indicates that this request would exceed the number of allowed entities for the AdWords // account. The exact entity type and limit being checked can be inferred from // {@link #accountLimitType}. // EntityCountLimitExceededReasonACCOUNT_LIMIT EntityCountLimitExceededReason = "ACCOUNT_LIMIT" // // Indicates that this request would exceed the number of allowed entities in a Campaign. // The exact entity type and limit being checked can be inferred from // {@link #accountLimitType}, and the numeric id of the Campaign involved is given by // {@link #enclosingId}. // EntityCountLimitExceededReasonCAMPAIGN_LIMIT EntityCountLimitExceededReason = "CAMPAIGN_LIMIT" // // Indicates that this request would exceed the number of allowed entities in // an ad group. The exact entity type and limit being checked can be // inferred from {@link #accountLimitType}, and the numeric id of the ad group // involved is given by {@link #enclosingId}. // EntityCountLimitExceededReasonADGROUP_LIMIT EntityCountLimitExceededReason = "ADGROUP_LIMIT" // // Indicates that this request would exceed the number of allowed entities in an ad group ad. // The exact entity type and limit being checked can be inferred from {@link #accountLimitType}, // and the {@link #enclosingId} contains the ad group id followed by the ad id, separated by a // single comma (,). // EntityCountLimitExceededReasonAD_GROUP_AD_LIMIT EntityCountLimitExceededReason = "AD_GROUP_AD_LIMIT" // // Indicates that this request would exceed the number of allowed entities in an ad group // criterion. The exact entity type and limit being checked can be inferred from // {@link #accountLimitType}, and the {@link #enclosingId} contains the ad group id followed by // the criterion id, separated by a single comma (,). // EntityCountLimitExceededReasonAD_GROUP_CRITERION_LIMIT EntityCountLimitExceededReason = "AD_GROUP_CRITERION_LIMIT" // // Indicates that this request would exceed the number of allowed entities in // this shared set. The exact entity type and limit being checked can be // inferred from {@link #accountLimitType}, and the numeric id of the shared // set involved is given by {@link #enclosingId}. // EntityCountLimitExceededReasonSHARED_SET_LIMIT EntityCountLimitExceededReason = "SHARED_SET_LIMIT" // // Exceeds a limit related to a matching function. // EntityCountLimitExceededReasonMATCHING_FUNCTION_LIMIT EntityCountLimitExceededReason = "MATCHING_FUNCTION_LIMIT" // // Specific limit that has been exceeded is unknown (the client may be of an // older version than the server). // EntityCountLimitExceededReasonUNKNOWN EntityCountLimitExceededReason = "UNKNOWN" )
type EntityNotFound ¶
type EntityNotFound struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 EntityNotFound"` *ApiError // // Reason for this error. // Reason *EntityNotFoundReason `xml:"reason,omitempty"` }
type EntityNotFoundReason ¶
type EntityNotFoundReason string
const ( // // The specified id refered to an entity which either doesn't exist or is not accessible to the // customer. e.g. campaign belongs to another customer. // EntityNotFoundReasonINVALID_ID EntityNotFoundReason = "INVALID_ID" )
type FieldPathElement ¶
type FieldPathElement struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 FieldPathElement"` // // The name of a field in lower camelcase. (e.g. "biddingStrategy") // Field string `xml:"field,omitempty"` // // For list fields, this is a 0-indexed position in the list. Null for non-list fields. // Index int32 `xml:"index,omitempty"` }
type GetResponse ¶
type GetResponse struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 getResponse"` Rval *CustomerNegativeCriterionPage `xml:"rval,omitempty"` }
type IdError ¶
type IdError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 IdError"` *ApiError // // The error reason represented by an enum. // Reason *IdErrorReason `xml:"reason,omitempty"` }
type IdErrorReason ¶
type IdErrorReason string
The reasons for the target error.
const ( // // Id not found // IdErrorReasonNOT_FOUND IdErrorReason = "NOT_FOUND" )
type InternalApiError ¶
type InternalApiError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 InternalApiError"` *ApiError // // The error reason represented by an enum. // Reason *InternalApiErrorReason `xml:"reason,omitempty"` }
type InternalApiErrorReason ¶
type InternalApiErrorReason string
The single reason for the internal API error.
const ( // // API encountered an unexpected internal error. // InternalApiErrorReasonUNEXPECTED_INTERNAL_API_ERROR InternalApiErrorReason = "UNEXPECTED_INTERNAL_API_ERROR" // // A temporary error occurred during the request. Please retry. // InternalApiErrorReasonTRANSIENT_ERROR InternalApiErrorReason = "TRANSIENT_ERROR" // // The cause of the error is not known or only defined in newer versions. // InternalApiErrorReasonUNKNOWN InternalApiErrorReason = "UNKNOWN" // // The API is currently unavailable for a planned downtime. // InternalApiErrorReasonDOWNTIME InternalApiErrorReason = "DOWNTIME" // // Mutate succeeded but server was unable to build response. Client should not retry mutate. // InternalApiErrorReasonERROR_GENERATING_RESPONSE InternalApiErrorReason = "ERROR_GENERATING_RESPONSE" )
type ListReturnValue ¶
type ListReturnValue struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ListReturnValue"` // // Indicates that this instance is a subtype of ListReturnValue. // Although this field is returned in the response, it is ignored on input // and cannot be selected. Specify xsi:type instead. // ListReturnValueType string `xml:"ListReturnValue.Type,omitempty"` }
type MobileAppCategory ¶
type MobileAppCategory struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 MobileAppCategory"` *Criterion // // ID of this mobile app category. A complete list of the available mobile app categories is // available <a href="/adwords/api/docs/appendix/mobileappcategories">here</a>. // <span class="constraint Selectable">This field can be selected using the value "MobileAppCategoryId".</span> // <span class="constraint Required">This field is required and should not be {@code null} when it is contained within {@link Operator}s : ADD.</span> // MobileAppCategoryId int32 `xml:"mobileAppCategoryId,omitempty"` // // Name of this mobile app category. // <span class="constraint ReadOnly">This field is read only and will be ignored when sent to the API.</span> // DisplayName string `xml:"displayName,omitempty"` }
type MobileApplication ¶
type MobileApplication struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 MobileApplication"` *Criterion // // A string that uniquely identifies a mobile application to AdWords API. The format of this // string is "<code>{platform}-{platform_native_id}</code>", where <code>platform</code> is "1" // for iOS apps and "2" for Android apps, and where <code>platform_native_id</code> is the mobile // application identifier native to the corresponding platform. // For iOS, this native identifier is the 9 digit string that appears at the end of an App Store // URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is // http://itunes.apple.com/us/app/flood-it!-2/id476943146). // For Android, this native identifier is the application's package name (e.g., // "com.labpixies.colordrips" for "Color Drips" given Google Play link // https://play.google.com/store/apps/details?id=com.labpixies.colordrips). // A well formed app id for AdWords API would thus be "1-476943146" for iOS and // "2-com.labpixies.colordrips" for Android. // <span class="constraint Selectable">This field can be selected using the value "AppId".</span><span class="constraint Filterable">This field can be filtered on.</span> // <span class="constraint Required">This field is required and should not be {@code null} when it is contained within {@link Operator}s : ADD.</span> // AppId string `xml:"appId,omitempty"` // // Title of this mobile application. // <span class="constraint Selectable">This field can be selected using the value "DisplayName".</span><span class="constraint Filterable">This field can be filtered on.</span> // <span class="constraint ReadOnly">This field is read only and will be ignored when sent to the API.</span> // DisplayName string `xml:"displayName,omitempty"` }
type Mutate ¶
type Mutate struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 mutate"` // // <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span> // <span class="constraint DistinctIds">Elements in this field must have distinct IDs for following {@link Operator}s : SET, REMOVE.</span> // <span class="constraint NotEmpty">This field must contain at least one element.</span> // <span class="constraint Required">This field is required and should not be {@code null}.</span> // <span class="constraint SupportedOperators">The following {@link Operator}s are supported: ADD, REMOVE.</span> // Operations []*CustomerNegativeCriterionOperation `xml:"operations,omitempty"` }
type MutateResponse ¶
type MutateResponse struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 mutateResponse"` Rval *CustomerNegativeCriterionReturnValue `xml:"rval,omitempty"` }
type NotEmptyError ¶
type NotEmptyError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 NotEmptyError"` *ApiError // // The error reason represented by an enum. // Reason *NotEmptyErrorReason `xml:"reason,omitempty"` }
type NotEmptyErrorReason ¶
type NotEmptyErrorReason string
The reasons for the validation error.
const (
NotEmptyErrorReasonEMPTY_LIST NotEmptyErrorReason = "EMPTY_LIST"
)
type NullError ¶
type NullError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 NullError"` *ApiError // // The error reason represented by an enum. // Reason *NullErrorReason `xml:"reason,omitempty"` }
type NullErrorReason ¶
type NullErrorReason string
The reasons for the validation error.
const ( // // Specified list/container must not contain any null elements // NullErrorReasonNULL_CONTENT NullErrorReason = "NULL_CONTENT" )
type Operation ¶
type Operation struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Operation"` // // Operator. // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Operator *Operator `xml:"operator,omitempty"` // // Indicates that this instance is a subtype of Operation. // Although this field is returned in the response, it is ignored on input // and cannot be selected. Specify xsi:type instead. // OperationType string `xml:"Operation.Type,omitempty"` }
type OperationAccessDenied ¶
type OperationAccessDenied struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 OperationAccessDenied"` *ApiError Reason *OperationAccessDeniedReason `xml:"reason,omitempty"` }
type OperationAccessDeniedReason ¶
type OperationAccessDeniedReason string
The reasons for the operation access error.
const ( // // Unauthorized invocation of a service's method (get, mutate, etc.) // OperationAccessDeniedReasonACTION_NOT_PERMITTED OperationAccessDeniedReason = "ACTION_NOT_PERMITTED" // // Unauthorized ADD operation in invoking a service's mutate method. // OperationAccessDeniedReasonADD_OPERATION_NOT_PERMITTED OperationAccessDeniedReason = "ADD_OPERATION_NOT_PERMITTED" // // Unauthorized REMOVE operation in invoking a service's mutate method. // OperationAccessDeniedReasonREMOVE_OPERATION_NOT_PERMITTED OperationAccessDeniedReason = "REMOVE_OPERATION_NOT_PERMITTED" // // Unauthorized SET operation in invoking a service's mutate method. // OperationAccessDeniedReasonSET_OPERATION_NOT_PERMITTED OperationAccessDeniedReason = "SET_OPERATION_NOT_PERMITTED" // // A mutate action is not allowed on this campaign, from this client. // OperationAccessDeniedReasonMUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT OperationAccessDeniedReason = "MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT" // // This operation is not permitted on this campaign type // OperationAccessDeniedReasonOPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE OperationAccessDeniedReason = "OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE" // // An ADD operation may not set status to REMOVED. // OperationAccessDeniedReasonADD_AS_REMOVED_NOT_PERMITTED OperationAccessDeniedReason = "ADD_AS_REMOVED_NOT_PERMITTED" // // This operation is not allowed because the campaign or adgroup is removed. // OperationAccessDeniedReasonOPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY OperationAccessDeniedReason = "OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY" // // This operation is not permitted on this ad group type. // OperationAccessDeniedReasonOPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE OperationAccessDeniedReason = "OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE" // // The reason the invoked method or operation is prohibited is not known // (the client may be of an older version than the server). // OperationAccessDeniedReasonUNKNOWN OperationAccessDeniedReason = "UNKNOWN" )
type Operator ¶
type Operator string
This represents an operator that may be presented to an adsapi service.
type OperatorError ¶
type OperatorError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 OperatorError"` *ApiError // // The error reason represented by an enum. // Reason *OperatorErrorReason `xml:"reason,omitempty"` }
type OperatorErrorReason ¶
type OperatorErrorReason string
The reasons for the validation error.
const (
OperatorErrorReasonOPERATOR_NOT_SUPPORTED OperatorErrorReason = "OPERATOR_NOT_SUPPORTED"
)
type OrderBy ¶
type OrderBy struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 OrderBy"` // // The field to sort the results on. // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Field string `xml:"field,omitempty"` // // The order to sort the results on. The default sort order is {@link SortOrder#ASCENDING}. // SortOrder *SortOrder `xml:"sortOrder,omitempty"` }
type Page ¶
type Page struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Page"` // // Total number of entries in the result that this page is a part of. // TotalNumEntries int32 `xml:"totalNumEntries,omitempty"` // // Indicates that this instance is a subtype of Page. // Although this field is returned in the response, it is ignored on input // and cannot be selected. Specify xsi:type instead. // PageType string `xml:"Page.Type,omitempty"` }
type Paging ¶
type Paging struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Paging"` // // Index of the first result to return in this page. // <span class="constraint InRange">This field must be greater than or equal to 0.</span> // StartIndex int32 `xml:"startIndex,omitempty"` // // Maximum number of results to return in this page. Set this to a reasonable value to limit // the number of results returned per page. // <span class="constraint InRange">This field must be greater than or equal to 0.</span> // NumberResults int32 `xml:"numberResults,omitempty"` }
type Placement ¶
type Placement struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Placement"` *Criterion // // Url of the placement. // // <p>For example, "http://www.domain.com". // <span class="constraint Selectable">This field can be selected using the value "PlacementUrl".</span><span class="constraint Filterable">This field can be filtered on.</span> // <span class="constraint Required">This field is required and should not be {@code null} when it is contained within {@link Operator}s : ADD.</span> // Url string `xml:"url,omitempty"` }
type Predicate ¶
type Predicate struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Predicate"` // // The field by which to filter the returned data. Possible values are marked Filterable on // the entity's reference page. For example, for predicates for the // CampaignService {@link Selector selector}, refer to the filterable fields from the // {@link Campaign} reference page. // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Field string `xml:"field,omitempty"` // // The operator to use for filtering the data returned. // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Operator *PredicateOperator `xml:"operator,omitempty"` // // The values by which to filter the field. The {@link Operator#CONTAINS_ALL}, // {@link Operator#CONTAINS_ANY}, {@link Operator#CONTAINS_NONE}, {@link Operator#IN} // and {@link Operator#NOT_IN} take multiple values. All others take a single value. // <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span> // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Values []string `xml:"values,omitempty"` }
type PredicateOperator ¶
type PredicateOperator string
Defines the valid set of operators.
const ( // // Checks if the field is equal to the given value. // // <p>This operator is used with integers, dates, booleans, strings, // enums, and sets. // PredicateOperatorEQUALS PredicateOperator = "EQUALS" // // Checks if the field does not equal the given value. // // <p>This operator is used with integers, booleans, strings, enums, // and sets. // PredicateOperatorNOT_EQUALS PredicateOperator = "NOT_EQUALS" // // Checks if the field is equal to one of the given values. // // <p>This operator accepts multiple operands and is used with // integers, booleans, strings, and enums. // PredicateOperatorIN PredicateOperator = "IN" // // Checks if the field does not equal any of the given values. // // <p>This operator accepts multiple operands and is used with // integers, booleans, strings, and enums. // PredicateOperatorNOT_IN PredicateOperator = "NOT_IN" // // Checks if the field is greater than the given value. // // <p>This operator is used with numbers and dates. // PredicateOperatorGREATER_THAN PredicateOperator = "GREATER_THAN" // // Checks if the field is greater or equal to the given value. // // <p>This operator is used with numbers and dates. // PredicateOperatorGREATER_THAN_EQUALS PredicateOperator = "GREATER_THAN_EQUALS" // // Checks if the field is less than the given value. // // <p>This operator is used with numbers and dates. // PredicateOperatorLESS_THAN PredicateOperator = "LESS_THAN" // // Checks if the field is less or equal to than the given value. // // <p>This operator is used with numbers and dates. // PredicateOperatorLESS_THAN_EQUALS PredicateOperator = "LESS_THAN_EQUALS" // // Checks if the field starts with the given value. // // <p>This operator is used with strings. // PredicateOperatorSTARTS_WITH PredicateOperator = "STARTS_WITH" // // Checks if the field starts with the given value, ignoring case. // // <p>This operator is used with strings. // PredicateOperatorSTARTS_WITH_IGNORE_CASE PredicateOperator = "STARTS_WITH_IGNORE_CASE" // // Checks if the field contains the given value as a substring. // // <p>This operator is used with strings. // PredicateOperatorCONTAINS PredicateOperator = "CONTAINS" // // Checks if the field contains the given value as a substring, ignoring // case. // // <p>This operator is used with strings. // PredicateOperatorCONTAINS_IGNORE_CASE PredicateOperator = "CONTAINS_IGNORE_CASE" // // Checks if the field does not contain the given value as a substring. // // <p>This operator is used with strings. // PredicateOperatorDOES_NOT_CONTAIN PredicateOperator = "DOES_NOT_CONTAIN" // // Checks if the field does not contain the given value as a substring, // ignoring case. // // <p>This operator is used with strings. // PredicateOperatorDOES_NOT_CONTAIN_IGNORE_CASE PredicateOperator = "DOES_NOT_CONTAIN_IGNORE_CASE" // // Checks if the field contains <em>any</em> of the given values. // // <p>This operator accepts multiple values and is used on sets of numbers // or strings. // PredicateOperatorCONTAINS_ANY PredicateOperator = "CONTAINS_ANY" // // Checks if the field contains <em>all</em> of the given values. // // <p>This operator accepts multiple values and is used on sets of numbers // or strings. // PredicateOperatorCONTAINS_ALL PredicateOperator = "CONTAINS_ALL" // // Checks if the field contains <em>none</em> of the given values. // // <p>This operator accepts multiple values and is used on sets of numbers // or strings. // PredicateOperatorCONTAINS_NONE PredicateOperator = "CONTAINS_NONE" // // <span class="constraint Rejected">Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.</span> // PredicateOperatorUNKNOWN PredicateOperator = "UNKNOWN" )
type QueryResponse ¶
type QueryResponse struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 queryResponse"` Rval *CustomerNegativeCriterionPage `xml:"rval,omitempty"` }
type QuotaCheckError ¶
type QuotaCheckError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 QuotaCheckError"` *ApiError Reason *QuotaCheckErrorReason `xml:"reason,omitempty"` }
type QuotaCheckErrorReason ¶
type QuotaCheckErrorReason string
Enums for all the reasons an error can be thrown to the user during billing quota checks.
const ( // // Customer passed in an invalid token in the header. // QuotaCheckErrorReasonINVALID_TOKEN_HEADER QuotaCheckErrorReason = "INVALID_TOKEN_HEADER" // // Customer is marked delinquent. // QuotaCheckErrorReasonACCOUNT_DELINQUENT QuotaCheckErrorReason = "ACCOUNT_DELINQUENT" // // Customer is a fraudulent. // QuotaCheckErrorReasonACCOUNT_INACCESSIBLE QuotaCheckErrorReason = "ACCOUNT_INACCESSIBLE" // // Inactive Account. // QuotaCheckErrorReasonACCOUNT_INACTIVE QuotaCheckErrorReason = "ACCOUNT_INACTIVE" // // Signup not complete // QuotaCheckErrorReasonINCOMPLETE_SIGNUP QuotaCheckErrorReason = "INCOMPLETE_SIGNUP" // // Developer token is not approved for production access, and the customer // is attempting to access a production account. // QuotaCheckErrorReasonDEVELOPER_TOKEN_NOT_APPROVED QuotaCheckErrorReason = "DEVELOPER_TOKEN_NOT_APPROVED" // // Terms and conditions are not signed. // QuotaCheckErrorReasonTERMS_AND_CONDITIONS_NOT_SIGNED QuotaCheckErrorReason = "TERMS_AND_CONDITIONS_NOT_SIGNED" // // Monthly budget quota reached. // QuotaCheckErrorReasonMONTHLY_BUDGET_REACHED QuotaCheckErrorReason = "MONTHLY_BUDGET_REACHED" // // Monthly budget quota exceeded. // QuotaCheckErrorReasonQUOTA_EXCEEDED QuotaCheckErrorReason = "QUOTA_EXCEEDED" )
type RangeError ¶
type RangeError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 RangeError"` *ApiError // // The error reason represented by an enum. // Reason *RangeErrorReason `xml:"reason,omitempty"` }
type RangeErrorReason ¶
type RangeErrorReason string
The reasons for the target error.
const ( RangeErrorReasonTOO_LOW RangeErrorReason = "TOO_LOW" RangeErrorReasonTOO_HIGH RangeErrorReason = "TOO_HIGH" )
type RateExceededError ¶
type RateExceededError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 RateExceededError"` *ApiError // // The error reason represented by an enum. // Reason *RateExceededErrorReason `xml:"reason,omitempty"` // // Cause of the rate exceeded error. // RateName string `xml:"rateName,omitempty"` // // The scope of the rate (ACCOUNT/DEVELOPER). // RateScope string `xml:"rateScope,omitempty"` // // The amount of time (in seconds) the client should wait before retrying the request. // RetryAfterSeconds int32 `xml:"retryAfterSeconds,omitempty"` }
type RateExceededErrorReason ¶
type RateExceededErrorReason string
The reason for the rate exceeded error.
const ( // // Rate exceeded. // RateExceededErrorReasonRATE_EXCEEDED RateExceededErrorReason = "RATE_EXCEEDED" )
type ReadOnlyError ¶
type ReadOnlyError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 ReadOnlyError"` *ApiError // // The error reason represented by an enum. // Reason *ReadOnlyErrorReason `xml:"reason,omitempty"` }
type ReadOnlyErrorReason ¶
type ReadOnlyErrorReason string
The reasons for the target error.
const (
ReadOnlyErrorReasonREAD_ONLY ReadOnlyErrorReason = "READ_ONLY"
)
type RejectedError ¶
type RejectedError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 RejectedError"` *ApiError // // The error reason represented by an enum. // Reason *RejectedErrorReason `xml:"reason,omitempty"` }
type RejectedErrorReason ¶
type RejectedErrorReason string
The reasons for the target error.
const ( // // Unknown value encountered // RejectedErrorReasonUNKNOWN_VALUE RejectedErrorReason = "UNKNOWN_VALUE" )
type RequestError ¶
type RequestError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 RequestError"` *ApiError Reason *RequestErrorReason `xml:"reason,omitempty"` }
type RequestErrorReason ¶
type RequestErrorReason string
const ( // // Error reason is unknown. // RequestErrorReasonUNKNOWN RequestErrorReason = "UNKNOWN" // // Invalid input. // RequestErrorReasonINVALID_INPUT RequestErrorReason = "INVALID_INPUT" // // The api version in the request has been discontinued. Please update // to the new AdWords API version. // RequestErrorReasonUNSUPPORTED_VERSION RequestErrorReason = "UNSUPPORTED_VERSION" )
type RequiredError ¶
type RequiredError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 RequiredError"` *ApiError // // The error reason represented by an enum. // Reason *RequiredErrorReason `xml:"reason,omitempty"` }
type RequiredErrorReason ¶
type RequiredErrorReason string
The reasons for the target error.
const ( // // Missing required field. // RequiredErrorReasonREQUIRED RequiredErrorReason = "REQUIRED" )
type SOAPBody ¶
type SOAPBody struct { XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Body"` Fault *SOAPFault `xml:",omitempty"` Content interface{} `xml:",omitempty"` }
func (*SOAPBody) UnmarshalXML ¶
type SOAPClient ¶
type SOAPClient struct {
// contains filtered or unexported fields
}
func NewSOAPClient ¶
func NewSOAPClient(url string, insecureSkipVerify bool, auth *BasicAuth) *SOAPClient
func NewSOAPClientWithTLSConfig ¶
func NewSOAPClientWithTLSConfig(url string, tlsCfg *tls.Config, auth *BasicAuth) *SOAPClient
func (*SOAPClient) AddHeader ¶
func (s *SOAPClient) AddHeader(header interface{})
func (*SOAPClient) Call ¶
func (s *SOAPClient) Call(soapAction string, request, response interface{}) error
type SOAPEnvelope ¶
type SOAPEnvelope struct { XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Envelope"` Header *SOAPHeader Body SOAPBody }
type SOAPFault ¶
type SOAPHeader ¶
type Selector ¶
type Selector struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 Selector"` // // List of fields to select. // <a href="/adwords/api/docs/appendix/selectorfields">Possible values</a> // are marked {@code Selectable} on the entity's reference page. // For example, for the {@code CampaignService} selector, refer to the // selectable fields from the {@link Campaign} reference page. // <span class="constraint ContentsDistinct">This field must contain distinct elements.</span> // <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span> // <span class="constraint Required">This field is required and should not be {@code null}.</span> // Fields []string `xml:"fields,omitempty"` // // Specifies how an entity (eg. adgroup, campaign, criterion, ad) should be filtered. // <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span> // Predicates []*Predicate `xml:"predicates,omitempty"` // // Range of dates for which you want to include data. If this value is omitted, // results for all dates are returned. // <p class="note"><b>Note:</b> This field is only used by the report download // service. For all other services, it is ignored.</p> // <span class="constraint DateRangeWithinRange">This range must be contained within the range [19700101, 20380101].</span> // DateRange *DateRange `xml:"dateRange,omitempty"` // // The fields on which you want to sort, and the sort order. The order in the list is // significant: The first element in the list indicates the primary sort order, the next // specifies the secondary sort order and so on. // Ordering []*OrderBy `xml:"ordering,omitempty"` // // Pagination information. // Paging *Paging `xml:"paging,omitempty"` }
type SelectorError ¶
type SelectorError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 SelectorError"` *ApiError // // The error reason represented by enum. // Reason *SelectorErrorReason `xml:"reason,omitempty"` }
type SelectorErrorReason ¶
type SelectorErrorReason string
The reasons for the target error.
const ( // // The field name is not valid. // SelectorErrorReasonINVALID_FIELD_NAME SelectorErrorReason = "INVALID_FIELD_NAME" // // The list of fields is null or empty. // SelectorErrorReasonMISSING_FIELDS SelectorErrorReason = "MISSING_FIELDS" // // The list of predicates is null or empty. // SelectorErrorReasonMISSING_PREDICATES SelectorErrorReason = "MISSING_PREDICATES" // // Predicate operator does not support multiple values. Multiple values are // supported only for {@link Predicate.Operator#IN} and {@link Predicate.Operator#NOT_IN}. // SelectorErrorReasonOPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES SelectorErrorReason = "OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES" // // The predicate enum value is not valid. // SelectorErrorReasonINVALID_PREDICATE_ENUM_VALUE SelectorErrorReason = "INVALID_PREDICATE_ENUM_VALUE" // // The predicate operator is empty. // SelectorErrorReasonMISSING_PREDICATE_OPERATOR SelectorErrorReason = "MISSING_PREDICATE_OPERATOR" // // The predicate values are empty. // SelectorErrorReasonMISSING_PREDICATE_VALUES SelectorErrorReason = "MISSING_PREDICATE_VALUES" // // The predicate field name is not valid. // SelectorErrorReasonINVALID_PREDICATE_FIELD_NAME SelectorErrorReason = "INVALID_PREDICATE_FIELD_NAME" // // The predicate operator is not valid. // SelectorErrorReasonINVALID_PREDICATE_OPERATOR SelectorErrorReason = "INVALID_PREDICATE_OPERATOR" // // Invalid selection of fields. // SelectorErrorReasonINVALID_FIELD_SELECTION SelectorErrorReason = "INVALID_FIELD_SELECTION" // // The predicate value is not valid. // SelectorErrorReasonINVALID_PREDICATE_VALUE SelectorErrorReason = "INVALID_PREDICATE_VALUE" // // The sort field name is not valid or the field is not sortable. // SelectorErrorReasonINVALID_SORT_FIELD_NAME SelectorErrorReason = "INVALID_SORT_FIELD_NAME" // // Standard error. // SelectorErrorReasonSELECTOR_ERROR SelectorErrorReason = "SELECTOR_ERROR" // // Filtering by date range is not supported. // SelectorErrorReasonFILTER_BY_DATE_RANGE_NOT_SUPPORTED SelectorErrorReason = "FILTER_BY_DATE_RANGE_NOT_SUPPORTED" // // Selector paging start index is too high. // SelectorErrorReasonSTART_INDEX_IS_TOO_HIGH SelectorErrorReason = "START_INDEX_IS_TOO_HIGH" // // The values list in a predicate was too long. // SelectorErrorReasonTOO_MANY_PREDICATE_VALUES SelectorErrorReason = "TOO_MANY_PREDICATE_VALUES" // // <span class="constraint Rejected">Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.</span> // SelectorErrorReasonUNKNOWN_ERROR SelectorErrorReason = "UNKNOWN_ERROR" )
type SizeLimitError ¶
type SizeLimitError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 SizeLimitError"` *ApiError // // The error reason represented by an enum. // Reason *SizeLimitErrorReason `xml:"reason,omitempty"` }
type SizeLimitErrorReason ¶
type SizeLimitErrorReason string
The reasons for Ad Scheduling errors.
const ( // // The number of entries in the request exceeds the system limit. // SizeLimitErrorReasonREQUEST_SIZE_LIMIT_EXCEEDED SizeLimitErrorReason = "REQUEST_SIZE_LIMIT_EXCEEDED" // // The number of entries in the response exceeds the system limit. // SizeLimitErrorReasonRESPONSE_SIZE_LIMIT_EXCEEDED SizeLimitErrorReason = "RESPONSE_SIZE_LIMIT_EXCEEDED" // // The account is too large to load. // SizeLimitErrorReasonINTERNAL_STORAGE_ERROR SizeLimitErrorReason = "INTERNAL_STORAGE_ERROR" // // <span class="constraint Rejected">Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.</span> // SizeLimitErrorReasonUNKNOWN SizeLimitErrorReason = "UNKNOWN" )
type SoapHeader ¶
type SoapHeader struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 SoapHeader"` // // The header identifies the customer id of the client of the AdWords manager, if an AdWords // manager is acting on behalf of their client or the customer id of the advertiser managing their // own account. // ClientCustomerId string `xml:"clientCustomerId,omitempty"` // // Developer token to identify that the person making the call has enough // quota. // DeveloperToken string `xml:"developerToken,omitempty"` // // UserAgent is used to track distribution of API client programs and // application usage. The client is responsible for putting in a meaningful // value for tracking purposes. To be clear this is not the same as an HTTP // user agent. // UserAgent string `xml:"userAgent,omitempty"` // // Used to validate the request without executing it. // ValidateOnly bool `xml:"validateOnly,omitempty"` // // If true, API will try to commit as many error free operations as possible and // report the other operations' errors. // // <p>Ignored for non-mutate calls. // PartialFailure bool `xml:"partialFailure,omitempty"` }
type SoapResponseHeader ¶
type SoapResponseHeader struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 SoapResponseHeader"` // // Unique id that identifies this request. If developers have any support issues, sending us // this id will enable us to find their request more easily. // RequestId string `xml:"requestId,omitempty"` // // The name of the service being invoked. // ServiceName string `xml:"serviceName,omitempty"` // // The name of the method being invoked. // MethodName string `xml:"methodName,omitempty"` // // Number of operations performed for this SOAP request. // Operations int64 `xml:"operations,omitempty"` // // Elapsed time in milliseconds between the AdWords API receiving the request and sending the // response. // ResponseTime int64 `xml:"responseTime,omitempty"` }
type StringFormatError ¶
type StringFormatError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 StringFormatError"` *ApiError Reason *StringFormatErrorReason `xml:"reason,omitempty"` }
type StringFormatErrorReason ¶
type StringFormatErrorReason string
The reasons for the target error.
const ( StringFormatErrorReasonUNKNOWN StringFormatErrorReason = "UNKNOWN" // // The input string value contains disallowed characters. // StringFormatErrorReasonILLEGAL_CHARS StringFormatErrorReason = "ILLEGAL_CHARS" // // The input string value is invalid for the associated field. // StringFormatErrorReasonINVALID_FORMAT StringFormatErrorReason = "INVALID_FORMAT" )
type StringLengthError ¶
type StringLengthError struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 StringLengthError"` *ApiError // // The error reason represented by an enum. // Reason *StringLengthErrorReason `xml:"reason,omitempty"` }
type StringLengthErrorReason ¶
type StringLengthErrorReason string
The reasons for the target error.
const ( StringLengthErrorReasonTOO_SHORT StringLengthErrorReason = "TOO_SHORT" StringLengthErrorReasonTOO_LONG StringLengthErrorReason = "TOO_LONG" )
type WSSPassword ¶
type WSSSecurityHeader ¶
type WSSSecurityHeader struct { XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ wsse:Security"` XmlNSWsse string `xml:"xmlns:wsse,attr"` MustUnderstand string `xml:"mustUnderstand,attr,omitempty"` Token *WSSUsernameToken `xml:",omitempty"` }
func NewWSSSecurityHeader ¶
func NewWSSSecurityHeader(user, pass, mustUnderstand string) *WSSSecurityHeader
type WSSUsername ¶
type WSSUsernameToken ¶
type WSSUsernameToken struct { XMLName xml.Name `xml:"wsse:UsernameToken"` XmlNSWsu string `xml:"xmlns:wsu,attr"` XmlNSWsse string `xml:"xmlns:wsse,attr"` Id string `xml:"wsu:Id,attr,omitempty"` Username *WSSUsername `xml:",omitempty"` Password *WSSPassword `xml:",omitempty"` }
type YouTubeChannel ¶
type YouTubeChannel struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 YouTubeChannel"` *Criterion // // The YouTube uploader channel id or the channel code of a YouTube content channel. // <p>The uploader channel id can be obtained from the YouTube id-based URL. For example, in // <code>https://www.youtube.com/channel/UCEN58iXQg82TXgsDCjWqIkg</code> the channel id is // <code>UCEN58iXQg82TXgsDCjWqIkg</code> // <p>For more information see: https://support.google.com/youtube/answer/6180214 // <span class="constraint Selectable">This field can be selected using the value "ChannelId".</span> // ChannelId string `xml:"channelId,omitempty"` // // The public name for a YouTube user channel. // <span class="constraint Selectable">This field can be selected using the value "ChannelName".</span> // <span class="constraint ReadOnly">This field is read only and will be ignored when sent to the API.</span> // ChannelName string `xml:"channelName,omitempty"` }
type YouTubeVideo ¶
type YouTubeVideo struct { XMLName xml.Name `xml:"https://adwords.google.com/api/adwords/cm/v201802 YouTubeVideo"` *Criterion // // YouTube video id as it appears on the YouTube watch page. // <span class="constraint Selectable">This field can be selected using the value "VideoId".</span> // VideoId string `xml:"videoId,omitempty"` // // Name of the video. // <span class="constraint Selectable">This field can be selected using the value "VideoName".</span> // <span class="constraint ReadOnly">This field is read only and will be ignored when sent to the API.</span> // VideoName string `xml:"videoName,omitempty"` }