Documentation
¶
Index ¶
- type ActivateUsers
- type AnyType
- type AnyURI
- type ApiError
- type ApiException
- type ApiExceptionFault
- type ApiVersionError
- type ApiVersionError_Reason
- type ApplicationException
- type AuthenticationError
- type AuthenticationError_Reason
- type BooleanValue
- type CollectionSizeError
- type CollectionSizeError_Reason
- type CommonError
- type CommonError_Reason
- type CreateUsers
- type CreateUsersResponse
- type CustomFieldValueError
- type CustomFieldValueError_Reason
- type Date
- type DateTime
- type DateTimeValue
- type DateValue
- type DeactivateUsers
- type FeatureError
- type FeatureError_Reason
- type FieldPathElement
- type GetAllRoles
- type GetAllRolesResponse
- type GetCurrentUser
- type GetCurrentUserResponse
- type GetUsersByStatement
- type GetUsersByStatementResponse
- type InternalApiError
- type InternalApiError_Reason
- type InvalidEmailError
- type InvalidEmailError_Reason
- type NCName
- type NotNullError
- type NotNullError_Reason
- type NumberValue
- type ObjectValue
- type ParseError
- type ParseError_Reason
- type PerformUserAction
- type PerformUserActionResponse
- type PermissionError
- type PermissionError_Reason
- type PublisherQueryLanguageContextError
- type PublisherQueryLanguageContextError_Reason
- type PublisherQueryLanguageSyntaxError
- type PublisherQueryLanguageSyntaxError_Reason
- type QuotaError
- type QuotaError_Reason
- type RequestHeader
- type RequiredCollectionError
- type RequiredCollectionError_Reason
- type RequiredError
- type RequiredError_Reason
- type ResponseHeader
- type Role
- type RoleStatus
- type ServerError
- type ServerError_Reason
- type SetValue
- type SoapRequestHeader
- type SoapResponseHeader
- type Statement
- type StatementError
- type StatementError_Reason
- type StringFormatError
- type StringFormatError_Reason
- type StringLengthError
- type StringLengthError_Reason
- type String_ValueMapEntry
- type TeamError
- type TeamError_Reason
- type TextValue
- type TimeZoneError
- type TimeZoneError_Reason
- type TokenError
- type TokenError_Reason
- type TypeError
- type UniqueError
- type UpdateResult
- type UpdateUsers
- type UpdateUsersResponse
- type User
- type UserAction
- type UserPage
- type UserRecord
- type UserServiceInterface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivateUsers ¶
type ActivateUsers struct {
*UserAction
}
type ApiError ¶
type ApiError struct {
//
// The OGNL field path to identify cause of error.
//
FieldPath string `xml:"fieldPath,omitempty" json:"fieldPath,omitempty"`
//
// A parsed copy of the field path. For example, the field path "operations[1].operand"
// corresponds to this list: {FieldPathElement(field = "operations", index = 1),
// FieldPathElement(field = "operand", index = null)}.
//
FieldPathElements []*FieldPathElement `xml:"fieldPathElements,omitempty" json:"fieldPathElements,omitempty"`
//
// The data that caused the error.
//
Trigger string `xml:"trigger,omitempty" json:"trigger,omitempty"`
//
// A simple string representation of the error and reason.
//
ErrorString string `xml:"errorString,omitempty" json:"errorString,omitempty"`
}
type ApiException ¶
type ApiException struct {
XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 ApiExceptionFault"`
*ApplicationException
//
// List of errors.
//
Errors []*ApiError `xml:"errors,omitempty" json:"errors,omitempty"`
}
type ApiExceptionFault ¶
type ApiExceptionFault ApiException
type ApiVersionError ¶
type ApiVersionError struct {
*ApiError
Reason *ApiVersionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type ApiVersionError_Reason ¶
type ApiVersionError_Reason string
const ( // // Indicates that the operation is not allowed in the version the request // was made in. // ApiVersionError_ReasonUPDATE_TO_NEWER_VERSION ApiVersionError_Reason = "UPDATE_TO_NEWER_VERSION" // // The value returned if the actual value is not exposed by the requested API version. // ApiVersionError_ReasonUNKNOWN ApiVersionError_Reason = "UNKNOWN" )
type ApplicationException ¶
type ApplicationException struct {
//
// Error message.
//
Message string `xml:"message,omitempty" json:"message,omitempty"`
}
type AuthenticationError ¶
type AuthenticationError struct {
*ApiError
Reason *AuthenticationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type AuthenticationError_Reason ¶
type AuthenticationError_Reason string
const ( // // The SOAP message contains a request header with an ambiguous definition of the authentication // header fields. This means either the {@code authToken} and {@code oAuthToken} fields were // both null or both were specified. Exactly one value should be specified with each request. // AuthenticationError_ReasonAMBIGUOUS_SOAP_REQUEST_HEADER AuthenticationError_Reason = "AMBIGUOUS_SOAP_REQUEST_HEADER" // // The login provided is invalid. // AuthenticationError_ReasonINVALID_EMAIL AuthenticationError_Reason = "INVALID_EMAIL" // // Tried to authenticate with provided information, but failed. // AuthenticationError_ReasonAUTHENTICATION_FAILED AuthenticationError_Reason = "AUTHENTICATION_FAILED" // // The OAuth provided is invalid. // AuthenticationError_ReasonINVALID_OAUTH_SIGNATURE AuthenticationError_Reason = "INVALID_OAUTH_SIGNATURE" // // The specified service to use was not recognized. // AuthenticationError_ReasonINVALID_SERVICE AuthenticationError_Reason = "INVALID_SERVICE" // // The SOAP message is missing a request header with an {@code authToken} and optional {@code // networkCode}. // AuthenticationError_ReasonMISSING_SOAP_REQUEST_HEADER AuthenticationError_Reason = "MISSING_SOAP_REQUEST_HEADER" // // The HTTP request is missing a request header with an {@code authToken} // AuthenticationError_ReasonMISSING_AUTHENTICATION_HTTP_HEADER AuthenticationError_Reason = "MISSING_AUTHENTICATION_HTTP_HEADER" // // The request is missing an {@code authToken} // AuthenticationError_ReasonMISSING_AUTHENTICATION AuthenticationError_Reason = "MISSING_AUTHENTICATION" // // The network does not have API access enabled. // AuthenticationError_ReasonNETWORK_API_ACCESS_DISABLED AuthenticationError_Reason = "NETWORK_API_ACCESS_DISABLED" // // The user is not associated with any network. // AuthenticationError_ReasonNO_NETWORKS_TO_ACCESS AuthenticationError_Reason = "NO_NETWORKS_TO_ACCESS" // // No network for the given {@code networkCode} was found. // AuthenticationError_ReasonNETWORK_NOT_FOUND AuthenticationError_Reason = "NETWORK_NOT_FOUND" // // The user has access to more than one network, but did not provide a {@code networkCode}. // AuthenticationError_ReasonNETWORK_CODE_REQUIRED AuthenticationError_Reason = "NETWORK_CODE_REQUIRED" // // An error happened on the server side during connection to authentication service. // AuthenticationError_ReasonCONNECTION_ERROR AuthenticationError_Reason = "CONNECTION_ERROR" // // The user tried to create a test network using an account that already is associated with a // network. // AuthenticationError_ReasonGOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK AuthenticationError_Reason = "GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK" // // The account is blocked and under investigation by the collections team. Please contact Google // for more information. // AuthenticationError_ReasonUNDER_INVESTIGATION AuthenticationError_Reason = "UNDER_INVESTIGATION" // // The value returned if the actual value is not exposed by the requested API version. // AuthenticationError_ReasonUNKNOWN AuthenticationError_Reason = "UNKNOWN" )
type BooleanValue ¶
type BooleanValue struct {
//
// The boolean value.
//
Value bool `xml:"value,omitempty" json:"value,omitempty"`
// contains filtered or unexported fields
}
type CollectionSizeError ¶
type CollectionSizeError struct {
*ApiError
Reason *CollectionSizeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type CollectionSizeError_Reason ¶
type CollectionSizeError_Reason string
const ( CollectionSizeError_ReasonTOO_LARGE CollectionSizeError_Reason = "TOO_LARGE" // // The value returned if the actual value is not exposed by the requested API version. // CollectionSizeError_ReasonUNKNOWN CollectionSizeError_Reason = "UNKNOWN" )
type CommonError ¶
type CommonError struct {
*ApiError
Reason *CommonError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type CommonError_Reason ¶
type CommonError_Reason string
const ( // // Indicates that an attempt was made to retrieve an entity that does not // exist. // CommonError_ReasonNOT_FOUND CommonError_Reason = "NOT_FOUND" // // Indicates that an attempt was made to create an entity that already // exists. // CommonError_ReasonALREADY_EXISTS CommonError_Reason = "ALREADY_EXISTS" // // Indicates that a value is not applicable for given use case. // CommonError_ReasonNOT_APPLICABLE CommonError_Reason = "NOT_APPLICABLE" // // Indicates that two elements in the collection were identical. // CommonError_ReasonDUPLICATE_OBJECT CommonError_Reason = "DUPLICATE_OBJECT" // // Indicates that an attempt was made to change an immutable field. // CommonError_ReasonCANNOT_UPDATE CommonError_Reason = "CANNOT_UPDATE" // // Indicates that the requested operation is not supported. // CommonError_ReasonUNSUPPORTED_OPERATION CommonError_Reason = "UNSUPPORTED_OPERATION" // // Indicates that another request attempted to update the same data in the same network // at about the same time. Please wait and try the request again. // CommonError_ReasonCONCURRENT_MODIFICATION CommonError_Reason = "CONCURRENT_MODIFICATION" // // The value returned if the actual value is not exposed by the requested API version. // CommonError_ReasonUNKNOWN CommonError_Reason = "UNKNOWN" )
type CreateUsers ¶
type CreateUsersResponse ¶
type CustomFieldValueError ¶
type CustomFieldValueError struct {
*ApiError
//
// The error reason represented by an enum.
//
Reason *CustomFieldValueError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type CustomFieldValueError_Reason ¶
type CustomFieldValueError_Reason string
const ( // // An attempt was made to modify or create a {@link CustomFieldValue} for // a {@link CustomField} that does not exist. // CustomFieldValueError_ReasonCUSTOM_FIELD_NOT_FOUND CustomFieldValueError_Reason = "CUSTOM_FIELD_NOT_FOUND" // // An attempt was made to create a new value for a custom field // that is inactive. // CustomFieldValueError_ReasonCUSTOM_FIELD_INACTIVE CustomFieldValueError_Reason = "CUSTOM_FIELD_INACTIVE" // // An attempt was made to modify or create a {@link CustomFieldValue} corresponding // to a {@link CustomFieldOption} that could not be found. // CustomFieldValueError_ReasonCUSTOM_FIELD_OPTION_NOT_FOUND CustomFieldValueError_Reason = "CUSTOM_FIELD_OPTION_NOT_FOUND" // // An attempt was made to modify or create a {@link CustomFieldValue} with an // association to an entity of the wrong type for its field. // CustomFieldValueError_ReasonINVALID_ENTITY_TYPE CustomFieldValueError_Reason = "INVALID_ENTITY_TYPE" // // The value returned if the actual value is not exposed by the requested API version. // CustomFieldValueError_ReasonUNKNOWN CustomFieldValueError_Reason = "UNKNOWN" )
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 DeactivateUsers ¶
type DeactivateUsers struct {
*UserAction
}
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 GetAllRoles ¶
type GetAllRolesResponse ¶
type GetCurrentUser ¶
type GetCurrentUserResponse ¶
type GetUsersByStatement ¶
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 InvalidEmailError ¶
type InvalidEmailError struct {
*ApiError
Reason *InvalidEmailError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type InvalidEmailError_Reason ¶
type InvalidEmailError_Reason string
const ( // // The value is not a valid email address. // InvalidEmailError_ReasonINVALID_FORMAT InvalidEmailError_Reason = "INVALID_FORMAT" // // The value returned if the actual value is not exposed by the requested API version. // InvalidEmailError_ReasonUNKNOWN InvalidEmailError_Reason = "UNKNOWN" )
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 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 PerformUserAction ¶
type PerformUserAction struct {
XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 performUserAction"`
UserAction *UserAction `xml:"userAction,omitempty" json:"userAction,omitempty"`
FilterStatement *Statement `xml:"filterStatement,omitempty" json:"filterStatement,omitempty"`
}
type PerformUserActionResponse ¶
type PerformUserActionResponse struct {
XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 performUserActionResponse"`
Rval *UpdateResult `xml:"rval,omitempty" json:"rval,omitempty"`
}
type PermissionError ¶
type PermissionError struct {
*ApiError
Reason *PermissionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type PermissionError_Reason ¶
type PermissionError_Reason string
const ( // // User does not have the required permission for the request. // PermissionError_ReasonPERMISSION_DENIED PermissionError_Reason = "PERMISSION_DENIED" // // The value returned if the actual value is not exposed by the requested API version. // PermissionError_ReasonUNKNOWN PermissionError_Reason = "UNKNOWN" )
type PublisherQueryLanguageContextError ¶
type PublisherQueryLanguageContextError struct {
*ApiError
//
// The error reason represented by an enum.
//
Reason *PublisherQueryLanguageContextError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type PublisherQueryLanguageContextError_Reason ¶
type PublisherQueryLanguageContextError_Reason string
const ( // // Indicates that there was an error executing the PQL. // PublisherQueryLanguageContextError_ReasonUNEXECUTABLE PublisherQueryLanguageContextError_Reason = "UNEXECUTABLE" // // The value returned if the actual value is not exposed by the requested API version. // PublisherQueryLanguageContextError_ReasonUNKNOWN PublisherQueryLanguageContextError_Reason = "UNKNOWN" )
type PublisherQueryLanguageSyntaxError ¶
type PublisherQueryLanguageSyntaxError struct {
*ApiError
//
// The error reason represented by an enum.
//
Reason *PublisherQueryLanguageSyntaxError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type PublisherQueryLanguageSyntaxError_Reason ¶
type PublisherQueryLanguageSyntaxError_Reason string
const ( // // Indicates that there was a PQL syntax error. // PublisherQueryLanguageSyntaxError_ReasonUNPARSABLE PublisherQueryLanguageSyntaxError_Reason = "UNPARSABLE" // // The value returned if the actual value is not exposed by the requested API version. // PublisherQueryLanguageSyntaxError_ReasonUNKNOWN PublisherQueryLanguageSyntaxError_Reason = "UNKNOWN" )
type QuotaError ¶
type QuotaError struct {
*ApiError
Reason *QuotaError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type QuotaError_Reason ¶
type QuotaError_Reason string
const ( // // The number of requests made per second is too high and has exceeded the // allowable limit. The recommended approach to handle this error is to wait // about 5 seconds and then retry the request. Note that this does not // guarantee the request will succeed. If it fails again, try increasing the // wait time. // <p>Another way to mitigate this error is to limit requests to 8 per second for Ad Manager // 360 accounts, or 2 per second for Ad Manager accounts. Once again // this does not guarantee that every request will succeed, but may help // reduce the number of times you receive this error. // QuotaError_ReasonEXCEEDED_QUOTA QuotaError_Reason = "EXCEEDED_QUOTA" // // The value returned if the actual value is not exposed by the requested API version. // QuotaError_ReasonUNKNOWN QuotaError_Reason = "UNKNOWN" // // This user has exceeded the allowed number of new report requests per hour // (this includes both reports run via the UI and reports // run via {@link ReportService#runReportJob}). // The recommended approach to handle this error is to wait about 10 minutes // and then retry the request. Note that this does not guarantee the request // will succeed. If it fails again, try increasing the wait time. // <p>Another way to mitigate this error is to limit the number of new report // requests to 250 per hour per user. Once again, this does not guarantee that // every request will succeed, but may help reduce the number of times you // receive this error. // QuotaError_ReasonREPORT_JOB_LIMIT QuotaError_Reason = "REPORT_JOB_LIMIT" // // This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. // The recommended approach to handle this error is to wait 30 minutes and then retry the // request. Note that this does not guarantee the request will succeed. If it fails again, try // increasing the wait time. // QuotaError_ReasonSEGMENT_POPULATION_LIMIT QuotaError_Reason = "SEGMENT_POPULATION_LIMIT" )
type RequestHeader ¶
type RequestHeader SoapRequestHeader
type RequiredCollectionError ¶
type RequiredCollectionError struct {
*ApiError
Reason *RequiredCollectionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type RequiredCollectionError_Reason ¶
type RequiredCollectionError_Reason string
const ( // // A required collection is missing. // RequiredCollectionError_ReasonREQUIRED RequiredCollectionError_Reason = "REQUIRED" // // Collection size is too large. // RequiredCollectionError_ReasonTOO_LARGE RequiredCollectionError_Reason = "TOO_LARGE" // // Collection size is too small. // RequiredCollectionError_ReasonTOO_SMALL RequiredCollectionError_Reason = "TOO_SMALL" // // The value returned if the actual value is not exposed by the requested API version. // RequiredCollectionError_ReasonUNKNOWN RequiredCollectionError_Reason = "UNKNOWN" )
type RequiredError ¶
type RequiredError struct {
*ApiError
//
// The error reason represented by an enum.
//
Reason *RequiredError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type RequiredError_Reason ¶
type RequiredError_Reason string
const ( // // Missing required field. // RequiredError_ReasonREQUIRED RequiredError_Reason = "REQUIRED" )
type ResponseHeader ¶
type ResponseHeader SoapResponseHeader
type Role ¶
type Role struct {
//
// The unique ID of the role. This value is readonly and is assigned by Google. Roles that are
// created by Google will have negative IDs.
//
Id int64 `xml:"id,omitempty" json:"id,omitempty"`
//
// The name of the role. This value is readonly and is assigned by Google.
//
Name string `xml:"name,omitempty" json:"name,omitempty"`
//
// The description of the role. This value is readonly and is assigned by Google.
//
Description string `xml:"description,omitempty" json:"description,omitempty"`
//
// The status of the {@link Role}. This field is read-only and can have the values {@link
// RoleStatus#ACTIVE} (default) or {@link RoleStatus#INACTIVE}, which determines the visibility of
// the role in the UI.
//
Status *RoleStatus `xml:"status,omitempty" json:"status,omitempty"`
}
type RoleStatus ¶
type RoleStatus string
const ( // // The status of an active role. (i.e. visible in the UI) // RoleStatusACTIVE RoleStatus = "ACTIVE" // // The status of an inactive role. (i.e. hidden in the UI) // RoleStatusINACTIVE RoleStatus = "INACTIVE" // // The value returned if the actual value is not exposed by the requested API version. // RoleStatusUNKNOWN RoleStatus = "UNKNOWN" )
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 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 TeamError ¶
type TeamError struct {
*ApiError
//
// The error reason represented by an enum.
//
Reason *TeamError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type TeamError_Reason ¶
type TeamError_Reason string
const ( // // User cannot use this entity because it is not on any of the user's teams. // TeamError_ReasonENTITY_NOT_ON_USERS_TEAMS TeamError_Reason = "ENTITY_NOT_ON_USERS_TEAMS" // // The targeted or excluded ad unit must be on the order's teams. // TeamError_ReasonAD_UNITS_NOT_ON_ORDER_TEAMS TeamError_Reason = "AD_UNITS_NOT_ON_ORDER_TEAMS" // // The targeted placement must be on the order's teams. // TeamError_ReasonPLACEMENTS_NOT_ON_ORDER_TEAMS TeamError_Reason = "PLACEMENTS_NOT_ON_ORDER_TEAMS" // // Entity cannot be created because it is not on any of the user's teams. // TeamError_ReasonMISSING_USERS_TEAM TeamError_Reason = "MISSING_USERS_TEAM" // // A team that gives access to all entities of a given type cannot be // associated with an entity of that type. // TeamError_ReasonALL_TEAM_ASSOCIATION_NOT_ALLOWED TeamError_Reason = "ALL_TEAM_ASSOCIATION_NOT_ALLOWED" // // The assignment of team to entities is invalid. // TeamError_ReasonINVALID_TEAM_ASSIGNMENT TeamError_Reason = "INVALID_TEAM_ASSIGNMENT" // // Cannot modify or create a team with an inactive status. // TeamError_ReasonCANNOT_UPDATE_INACTIVE_TEAM TeamError_Reason = "CANNOT_UPDATE_INACTIVE_TEAM" // // The value returned if the actual value is not exposed by the requested API version. // TeamError_ReasonUNKNOWN TeamError_Reason = "UNKNOWN" )
type TextValue ¶
type TextValue struct {
//
// The string value.
//
Value string `xml:"value,omitempty" json:"value,omitempty"`
// contains filtered or unexported fields
}
type TimeZoneError ¶
type TimeZoneError struct {
*ApiError
Reason *TimeZoneError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type TimeZoneError_Reason ¶
type TimeZoneError_Reason string
const ( // // Indicates that the timezone ID provided is not supported. // TimeZoneError_ReasonINVALID_TIMEZONE_ID TimeZoneError_Reason = "INVALID_TIMEZONE_ID" // // Indicates that the timezone ID provided is in the wrong format. // The timezone ID must be in tz database format (e.g. "America/Los_Angeles"). // TimeZoneError_ReasonTIMEZONE_ID_IN_WRONG_FORMAT TimeZoneError_Reason = "TIMEZONE_ID_IN_WRONG_FORMAT" // // The value returned if the actual value is not exposed by the requested API version. // TimeZoneError_ReasonUNKNOWN TimeZoneError_Reason = "UNKNOWN" )
type TokenError ¶
type TokenError struct {
*ApiError
Reason *TokenError_Reason `xml:"reason,omitempty" json:"reason,omitempty"`
}
type TokenError_Reason ¶
type TokenError_Reason string
const ( TokenError_ReasonINVALID TokenError_Reason = "INVALID" TokenError_ReasonEXPIRED TokenError_Reason = "EXPIRED" // // The value returned if the actual value is not exposed by the requested API version. // TokenError_ReasonUNKNOWN TokenError_Reason = "UNKNOWN" )
type UniqueError ¶
type UniqueError struct {
*ApiError
}
type UpdateResult ¶
type UpdateResult struct {
//
// The number of objects that were changed as a result of performing the
// action.
//
NumChanges int32 `xml:"numChanges,omitempty" json:"numChanges,omitempty"`
}
type UpdateUsers ¶
type UpdateUsersResponse ¶
type User ¶
type User struct {
*UserRecord
//
// Specifies whether or not the {@code User} is active. An inactive user cannot log in to the
// system or perform any operations. This attribute is read-only.
//
IsActive bool `xml:"isActive,omitempty" json:"isActive,omitempty"`
//
// Specifies whether or not the {@code User} wants to permit the Publisher Display Ads system to
// send email notifications to their email address. This attribute is optional and defaults to
// {@code true}.
//
IsEmailNotificationAllowed bool `xml:"isEmailNotificationAllowed,omitempty" json:"isEmailNotificationAllowed,omitempty"`
//
// An identifier for the {@code User} that is meaningful to the publisher. This attribute is
// optional and has a maximum length of 255 characters.
//
ExternalId string `xml:"externalId,omitempty" json:"externalId,omitempty"`
//
// Whether the user is an OAuth2 service account user. This attribute is read-only. Service
// account users can only be added through the UI.
//
IsServiceAccount bool `xml:"isServiceAccount,omitempty" json:"isServiceAccount,omitempty"`
//
// The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI
// for this {@code User}. Set this to {@code null} to indicate that no such value is defined for
// the {@code User} - UI then defaults to using the Network's timezone.
//
// <p>This setting only affects the UI for this user and does not in particular affect the
// timezone of any dates and times returned in API responses.
//
OrdersUiLocalTimeZoneId string `xml:"ordersUiLocalTimeZoneId,omitempty" json:"ordersUiLocalTimeZoneId,omitempty"`
}
type UserAction ¶
type UserAction struct {
}
type UserPage ¶
type UserPage 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 users contained within this page.
//
Results []*User `xml:"results,omitempty" json:"results,omitempty"`
}
type UserRecord ¶
type UserRecord struct {
//
// The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
//
Id int64 `xml:"id,omitempty" json:"id,omitempty"`
//
// The name of the {@code User}. It has a maximum length of 128 characters.
//
Name string `xml:"name,omitempty" json:"name,omitempty"`
//
// The email or login of the {@code User}. In order to create a new user, you must already have a
// <a href="https://www.google.com/accounts/ManageAccount">Google Account</a>.
//
Email string `xml:"email,omitempty" json:"email,omitempty"`
//
// The unique role ID of the {@code User}. Roles that are created by Google will have negative
// IDs.
//
RoleId int64 `xml:"roleId,omitempty" json:"roleId,omitempty"`
//
// The name of the role assigned to the {@code User}. This attribute is readonly.
//
RoleName string `xml:"roleName,omitempty" json:"roleName,omitempty"`
}
type UserServiceInterface ¶
type UserServiceInterface interface {
// Error can be either of the following types:
//
// - ApiException
/*
Creates new {@link User} objects.
*/
CreateUsers(request *CreateUsers) (*CreateUsersResponse, error)
CreateUsersContext(ctx context.Context, request *CreateUsers) (*CreateUsersResponse, error)
// Error can be either of the following types:
//
// - ApiException
/*
Returns the {@link Role} objects that are defined for the users of the network.
*/
GetAllRoles(request *GetAllRoles) (*GetAllRolesResponse, error)
GetAllRolesContext(ctx context.Context, request *GetAllRoles) (*GetAllRolesResponse, error)
// Error can be either of the following types:
//
// - ApiException
/*
Returns the current {@link User}.
*/
GetCurrentUser(request *GetCurrentUser) (*GetCurrentUserResponse, error)
GetCurrentUserContext(ctx context.Context, request *GetCurrentUser) (*GetCurrentUserResponse, error)
// Error can be either of the following types:
//
// - ApiException
/*
Gets a {@link UserPage} of {@link User} 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 email}</td>
<td>{@link User#email}</td>
</tr>
<tr>
<td>{@code id}</td>
<td>{@link User#id}</td>
</tr>
<tr>
<td>{@code name}</td>
<td>{@link User#name}</td>
</tr>
<tr>
<td>{@code roleId}</td>
<td>{@link User#roleId}
</tr>
<tr>
<td>{@code rolename}</td>
<td>{@link User#roleName}
</tr>
<tr>
<td>{@code status}</td>
<td>{@code ACTIVE} if {@link User#isActive} is true; {@code INACTIVE}
otherwise</td>
</tr>
</table>
*/
GetUsersByStatement(request *GetUsersByStatement) (*GetUsersByStatementResponse, error)
GetUsersByStatementContext(ctx context.Context, request *GetUsersByStatement) (*GetUsersByStatementResponse, error)
// Error can be either of the following types:
//
// - ApiException
/*
Performs actions on {@link User} objects that match the given {@link Statement#query}.
*/
PerformUserAction(request *PerformUserAction) (*PerformUserActionResponse, error)
PerformUserActionContext(ctx context.Context, request *PerformUserAction) (*PerformUserActionResponse, error)
// Error can be either of the following types:
//
// - ApiException
/*
Updates the specified {@link User} objects.
*/
UpdateUsers(request *UpdateUsers) (*UpdateUsersResponse, error)
UpdateUsersContext(ctx context.Context, request *UpdateUsers) (*UpdateUsersResponse, error)
}
func NewUserServiceInterface ¶
func NewUserServiceInterface(client *soap.Client) UserServiceInterface
Click to show internal directories.
Click to hide internal directories.