daiencodingprofile

package
v0.0.1-alpha Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateDaiEncodingProfiles

type ActivateDaiEncodingProfiles struct {
	*DaiEncodingProfileAction
}

type AnyType

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

type AnyURI

type AnyURI string

type ApiError

type ApiError struct {

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

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

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

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

type ApiException

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

	*ApplicationException

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

type ApiExceptionFault

type ApiExceptionFault ApiException

type ApiVersionError

type ApiVersionError struct {
	*ApiError

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

type ApiVersionError_Reason

type ApiVersionError_Reason string
const (

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

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

type ApplicationException

type ApplicationException struct {

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

type ArchiveDaiEncodingProfiles

type ArchiveDaiEncodingProfiles struct {
	*DaiEncodingProfileAction
}

type AudioSettings

type AudioSettings struct {

	//
	// The RFC6381 codec string of the audio.
	//
	Codec string `xml:"codec,omitempty" json:"codec,omitempty"`

	//
	// The bitrate of the audio, in bits per second. Required. This value must be between 8kbps and
	// 250 Mbps.
	//
	Bitrate int64 `xml:"bitrate,omitempty" json:"bitrate,omitempty"`

	//
	// The number of audio channels, including low frequency channels. This value has a maximum of 8.
	//
	Channels int64 `xml:"channels,omitempty" json:"channels,omitempty"`

	//
	// The audio sample rate in hertz. Must be between 44kHz and 100kHz.
	//
	SampleRateHertz int64 `xml:"sampleRateHertz,omitempty" json:"sampleRateHertz,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 ContainerType

type ContainerType string
const (

	//
	// Transport stream (TS) container.
	//
	ContainerTypeTS ContainerType = "TS"

	//
	// Fragmented MPEG-4 (fMP4) output container.
	//
	ContainerTypeFMP4 ContainerType = "FMP4"

	//
	// HTTP live streaming (HLS) packed audio container.
	//
	ContainerTypeHLS_AUDIO ContainerType = "HLS_AUDIO"

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

type CreateDaiEncodingProfiles

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

	DaiEncodingProfiles []*DaiEncodingProfile `xml:"daiEncodingProfiles,omitempty" json:"daiEncodingProfiles,omitempty"`
}

type CreateDaiEncodingProfilesResponse

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

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

type DaiEncodingProfile

type DaiEncodingProfile struct {

	//
	// The unique ID of the {@link DaiEncodingProfile}. This value is read-only and is assigned by
	// Google.
	//
	Id int64 `xml:"id,omitempty" json:"id,omitempty"`

	//
	// The name of the {@link DaiEncodingProfile}. This value is required to create an encoding
	// profile and may be at most 64 characters. The name field can contain alphanumeric characters
	// and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white
	// space character.
	//
	Name string `xml:"name,omitempty" json:"name,omitempty"`

	//
	// The status of this {@link DaiEncodingProfile}.
	//
	// <p>DAI encoding profiles are created in the {@link DaiEncodingProfileStatus#ACTIVE} state. The
	// status can only be modified through the {@link
	// DaiEncodingProfileService#performDaiEncodingProfileAction} method.
	//
	// <p>Only active profiles will be allowed to be associated with live streams.
	//
	Status *DaiEncodingProfileStatus `xml:"status,omitempty" json:"status,omitempty"`

	//
	// The variant playlist type that this {@link DaiEncodingProfile} represents.
	//
	VariantType *VariantType `xml:"variantType,omitempty" json:"variantType,omitempty"`

	//
	// The digital container type of the underlying media. This is required for {@code MEDIA} and
	// {@code IFRAME} variant types.
	//
	ContainerType *ContainerType `xml:"containerType,omitempty" json:"containerType,omitempty"`

	//
	// Information about the video media, if present. This field will only be set if the media
	// contains video, or is an {@code IFRAME} variant type.
	//
	VideoSettings *VideoSettings `xml:"videoSettings,omitempty" json:"videoSettings,omitempty"`

	//
	// Information about the audio media, if present. This field will only be set if the media
	// contains audio. Only {@code MEDIA} and {@code IFRAME} variant types can set audio.
	//
	AudioSettings *AudioSettings `xml:"audioSettings,omitempty" json:"audioSettings,omitempty"`

	//
	// Whether to allow the creation or modification of this {@link DaiEncodingProfile} if its
	// settings do not match one of the encoding profiles that is supported by Google DAI.
	//
	// <p>Note that this field will not persist on the encoding profile itself, and will only affect
	// the current request.
	//
	PersistUnmatchedProfiles bool `xml:"persistUnmatchedProfiles,omitempty" json:"persistUnmatchedProfiles,omitempty"`
}

type DaiEncodingProfileAction

type DaiEncodingProfileAction struct {
}

type DaiEncodingProfileAdMatchingError

type DaiEncodingProfileAdMatchingError struct {
	*ApiError

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

type DaiEncodingProfileAdMatchingError_Reason

type DaiEncodingProfileAdMatchingError_Reason string
const (

	//
	// Encoding profile does not match any existing creative profiles.
	//
	DaiEncodingProfileAdMatchingError_ReasonNO_CREATIVE_PROFILES_MATCHED DaiEncodingProfileAdMatchingError_Reason = "NO_CREATIVE_PROFILES_MATCHED"

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

type DaiEncodingProfileContainerSettingsError

type DaiEncodingProfileContainerSettingsError struct {
	*ApiError

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

type DaiEncodingProfileContainerSettingsError_Reason

type DaiEncodingProfileContainerSettingsError_Reason string
const (

	//
	// Profiles with {@code TS} container type must have at least one of audio or video settings
	// present.
	//
	DaiEncodingProfileContainerSettingsError_ReasonTS_MUST_HAVE_AUDIO_OR_VIDEO_SETTINGS DaiEncodingProfileContainerSettingsError_Reason = "TS_MUST_HAVE_AUDIO_OR_VIDEO_SETTINGS"

	//
	// Profiles with {@code FMP4} container type must have at exactly one of audio or video settings
	// present.
	//
	DaiEncodingProfileContainerSettingsError_ReasonFMP4_MUST_HAVE_EITHER_AUDIO_OR_VIDEO_SETTINGS DaiEncodingProfileContainerSettingsError_Reason = "FMP4_MUST_HAVE_EITHER_AUDIO_OR_VIDEO_SETTINGS"

	//
	// Profiles with {@code HLS_AUDIO} container type must only have audio settings present.
	//
	DaiEncodingProfileContainerSettingsError_ReasonHLS_AUDIO_MUST_HAVE_ONLY_AUDIO_SETTINGS DaiEncodingProfileContainerSettingsError_Reason = "HLS_AUDIO_MUST_HAVE_ONLY_AUDIO_SETTINGS"

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

type DaiEncodingProfileNameError

type DaiEncodingProfileNameError struct {
	*ApiError

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

type DaiEncodingProfileNameError_Reason

type DaiEncodingProfileNameError_Reason string
const (

	//
	// Name contains invalid characters.
	//
	DaiEncodingProfileNameError_ReasonCONTAINS_INVALID_CHARACTERS DaiEncodingProfileNameError_Reason = "CONTAINS_INVALID_CHARACTERS"

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

type DaiEncodingProfilePage

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

type DaiEncodingProfileServiceInterface

type DaiEncodingProfileServiceInterface interface {

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Creates new {@link DaiEncodingProfile} objects.
	*/
	CreateDaiEncodingProfiles(request *CreateDaiEncodingProfiles) (*CreateDaiEncodingProfilesResponse, error)

	CreateDaiEncodingProfilesContext(ctx context.Context, request *CreateDaiEncodingProfiles) (*CreateDaiEncodingProfilesResponse, error)

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

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

	GetDaiEncodingProfilesByStatementContext(ctx context.Context, request *GetDaiEncodingProfilesByStatement) (*GetDaiEncodingProfilesByStatementResponse, error)

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

	PerformDaiEncodingProfileActionContext(ctx context.Context, request *PerformDaiEncodingProfileAction) (*PerformDaiEncodingProfileActionResponse, error)

	// Error can be either of the following types:
	//
	//   - ApiException
	/*
	   Updates the specified {@link DaiEncodingProfile} objects.
	*/
	UpdateDaiEncodingProfiles(request *UpdateDaiEncodingProfiles) (*UpdateDaiEncodingProfilesResponse, error)

	UpdateDaiEncodingProfilesContext(ctx context.Context, request *UpdateDaiEncodingProfiles) (*UpdateDaiEncodingProfilesResponse, error)
}

func NewDaiEncodingProfileServiceInterface

func NewDaiEncodingProfileServiceInterface(client *soap.Client) DaiEncodingProfileServiceInterface

type DaiEncodingProfileStatus

type DaiEncodingProfileStatus string
const (

	//
	// Indicates the {@link DaiEncodingProfile} has been created and is eligible for streaming.
	//
	DaiEncodingProfileStatusACTIVE DaiEncodingProfileStatus = "ACTIVE"

	//
	// Indicates the {@link DaiEncodingProfile} has been archived.
	//
	DaiEncodingProfileStatusARCHIVED DaiEncodingProfileStatus = "ARCHIVED"

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

type DaiEncodingProfileUpdateError

type DaiEncodingProfileUpdateError struct {
	*ApiError

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

type DaiEncodingProfileUpdateError_Reason

type DaiEncodingProfileUpdateError_Reason string
const (

	//
	// Profiles cannot be updated if they are associated with running live stream events.
	//
	DaiEncodingProfileUpdateError_ReasonCANNOT_UPDATE_IF_USED_BY_RUNNING_LIVE_STREAMS DaiEncodingProfileUpdateError_Reason = "CANNOT_UPDATE_IF_USED_BY_RUNNING_LIVE_STREAMS"

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

type DaiEncodingProfileVariantSettingsError

type DaiEncodingProfileVariantSettingsError struct {
	*ApiError

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

type DaiEncodingProfileVariantSettingsError_Reason

type DaiEncodingProfileVariantSettingsError_Reason string
const (

	//
	// Container type is required for a {@code MEDIA} or {@code IFRAME} variant.
	//
	DaiEncodingProfileVariantSettingsError_ReasonCONTAINER_TYPE_REQUIRED DaiEncodingProfileVariantSettingsError_Reason = "CONTAINER_TYPE_REQUIRED"

	//
	// Video settings are only allowed for {@code MEDIA} or {@code IFRAME} variant types.
	//
	DaiEncodingProfileVariantSettingsError_ReasonVIDEO_SETTINGS_NOT_ALLOWED DaiEncodingProfileVariantSettingsError_Reason = "VIDEO_SETTINGS_NOT_ALLOWED"

	//
	// Audio settings are only allowed for {@code MEDIA} or {@code IFRAME} variant types.
	//
	DaiEncodingProfileVariantSettingsError_ReasonAUDIO_SETTINGS_NOT_ALLOWED DaiEncodingProfileVariantSettingsError_Reason = "AUDIO_SETTINGS_NOT_ALLOWED"

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

type Date

type Date struct {

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

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

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

type DateTime

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

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

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

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

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

type DateTimeValue

type DateTimeValue struct {

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

type DateValue

type DateValue struct {

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

type EntityLimitReachedError

type EntityLimitReachedError struct {
	*ApiError

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

type EntityLimitReachedError_Reason

type EntityLimitReachedError_Reason string
const (

	//
	// The number of custom targeting values exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonCUSTOM_TARGETING_VALUES_LIMIT_REACHED EntityLimitReachedError_Reason = "CUSTOM_TARGETING_VALUES_LIMIT_REACHED"

	//
	// The number of ad exclusion rules exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonAD_EXCLUSION_RULES_LIMIT_REACHED EntityLimitReachedError_Reason = "AD_EXCLUSION_RULES_LIMIT_REACHED"

	//
	// The number of first party audience segments exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonFIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED EntityLimitReachedError_Reason = "FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED"

	//
	// The number of active placements exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonPLACEMENTS_LIMIT_REACHED EntityLimitReachedError_Reason = "PLACEMENTS_LIMIT_REACHED"

	//
	// The number of line items excceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonLINE_ITEMS_LIMIT_REACHED EntityLimitReachedError_Reason = "LINE_ITEMS_LIMIT_REACHED"

	//
	// The number of active line items exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonACTIVE_LINE_ITEMS_LIMIT_REACHED EntityLimitReachedError_Reason = "ACTIVE_LINE_ITEMS_LIMIT_REACHED"

	//
	// The number of not-archived encoding profiles exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonDAI_ENCODING_PROFILES_LIMIT_REACHED EntityLimitReachedError_Reason = "DAI_ENCODING_PROFILES_LIMIT_REACHED"

	//
	// The number of traffic forecast segments exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonTRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED EntityLimitReachedError_Reason = "TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED"

	//
	// The number of forecast adjustments exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonFORECAST_ADJUSTMENTS_LIMIT_REACHED EntityLimitReachedError_Reason = "FORECAST_ADJUSTMENTS_LIMIT_REACHED"

	//
	// The number of active experiments exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonACTIVE_EXPERIMENTS_LIMIT_REACHED EntityLimitReachedError_Reason = "ACTIVE_EXPERIMENTS_LIMIT_REACHED"

	//
	// The number of sites exceeds the max number allowed in the network.
	//
	EntityLimitReachedError_ReasonSITES_LIMIT_REACHED EntityLimitReachedError_Reason = "SITES_LIMIT_REACHED"

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

type FeatureError

type FeatureError struct {
	*ApiError

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

type FeatureError_Reason

type FeatureError_Reason string
const (

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

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

type FieldPathElement

type FieldPathElement struct {

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

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

type GetDaiEncodingProfilesByStatement

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

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

type GetDaiEncodingProfilesByStatementResponse

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

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

type InternalApiError

type InternalApiError struct {
	*ApiError

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

type InternalApiError_Reason

type InternalApiError_Reason string
const (

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

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

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

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

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

type NCName

type NCName string

type NotNullError

type NotNullError struct {
	*ApiError

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

type NotNullError_Reason

type NotNullError_Reason string
const (

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

	NotNullError_ReasonARG2_NULL NotNullError_Reason = "ARG2_NULL"

	NotNullError_ReasonARG3_NULL NotNullError_Reason = "ARG3_NULL"

	NotNullError_ReasonNULL NotNullError_Reason = "NULL"

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

type NullError

type NullError struct {
	*ApiError

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

type NullError_Reason

type NullError_Reason string
const (
	NullError_ReasonNOT_NULL NullError_Reason = "NOT_NULL"

	//
	// The value returned if the actual value is not exposed by the requested API version.
	//
	NullError_ReasonUNKNOWN NullError_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 PerformDaiEncodingProfileAction

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

	DaiEncodingProfileAction *DaiEncodingProfileAction `xml:"daiEncodingProfileAction,omitempty" json:"daiEncodingProfileAction,omitempty"`

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

type PerformDaiEncodingProfileActionResponse

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

	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 RangeError

type RangeError struct {
	*ApiError

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

type RangeError_Reason

type RangeError_Reason string
const (
	RangeError_ReasonTOO_HIGH RangeError_Reason = "TOO_HIGH"

	RangeError_ReasonTOO_LOW RangeError_Reason = "TOO_LOW"

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

type RequestHeader

type RequestHeader SoapRequestHeader

type RequiredCollectionError

type RequiredCollectionError struct {
	*ApiError

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

type RequiredCollectionError_Reason

type RequiredCollectionError_Reason string
const (

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

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

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

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

type RequiredError

type RequiredError struct {
	*ApiError

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

type RequiredError_Reason

type RequiredError_Reason string
const (

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

type ResponseHeader

type ResponseHeader SoapResponseHeader

type ServerError

type ServerError struct {
	*ApiError

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

type ServerError_Reason

type ServerError_Reason string
const (

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

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

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

type SetValue

type SetValue struct {

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

type Size

type Size struct {

	//
	// The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
	//
	Width int32 `xml:"width,omitempty" json:"width,omitempty"`

	//
	// The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
	//
	Height int32 `xml:"height,omitempty" json:"height,omitempty"`

	//
	// Whether this size represents an aspect ratio.
	//
	IsAspectRatio bool `xml:"isAspectRatio,omitempty" json:"isAspectRatio,omitempty"`
}

type SoapRequestHeader

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

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

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

type SoapResponseHeader

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

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

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

type Statement

type Statement struct {

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

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

type StatementError

type StatementError struct {
	*ApiError

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

type StatementError_Reason

type StatementError_Reason string
const (

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

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

type StringFormatError

type StringFormatError struct {
	*ApiError

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

type StringFormatError_Reason

type StringFormatError_Reason string
const (
	StringFormatError_ReasonUNKNOWN StringFormatError_Reason = "UNKNOWN"

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

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

type StringLengthError

type StringLengthError struct {
	*ApiError

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

type StringLengthError_Reason

type StringLengthError_Reason string
const (
	StringLengthError_ReasonTOO_LONG StringLengthError_Reason = "TOO_LONG"

	StringLengthError_ReasonTOO_SHORT StringLengthError_Reason = "TOO_SHORT"

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

type String_ValueMapEntry

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

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

type TextValue

type TextValue struct {

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

type UniqueError

type UniqueError struct {
	*ApiError
}

type UpdateDaiEncodingProfiles

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

	DaiEncodingProfiles []*DaiEncodingProfile `xml:"daiEncodingProfiles,omitempty" json:"daiEncodingProfiles,omitempty"`
}

type UpdateDaiEncodingProfilesResponse

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

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

type UpdateResult

type UpdateResult struct {

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

type VariantType

type VariantType string
const (

	//
	// Media variant playlist type. Media playlists may: contain audio only, video only, or audio and
	// video.
	//
	VariantTypeMEDIA VariantType = "MEDIA"

	//
	// iFrame variant playlist type. iFrame playlists may: contain video or contain audio and video
	// (i.e. video must be present).
	//
	VariantTypeIFRAME VariantType = "IFRAME"

	//
	// Subtitles variant playlist type.
	//
	VariantTypeSUBTITLES VariantType = "SUBTITLES"

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

type VideoSettings

type VideoSettings struct {

	//
	// The RFC6381 codec string of the audio.
	//
	Codec string `xml:"codec,omitempty" json:"codec,omitempty"`

	//
	// The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
	//
	Bitrate int64 `xml:"bitrate,omitempty" json:"bitrate,omitempty"`

	//
	// The frames per second of the video. This value will be truncated to three decimal places.
	//
	FramesPerSecond float64 `xml:"framesPerSecond,omitempty" json:"framesPerSecond,omitempty"`

	//
	// The resolution of the video, in pixels.
	//
	Resolution *Size `xml:"resolution,omitempty" json:"resolution,omitempty"`
}

Jump to

Keyboard shortcuts

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