Documentation ¶
Index ¶
- type AdUnitCodeError
- type AdUnitCodeError_Reason
- type AdUnitTargeting
- type AllowedFormats
- type AlternativeUnitTypeForecast
- type AnyType
- type AnyURI
- type ApiError
- type ApiException
- type ApiExceptionFault
- type ApiVersionError
- type ApiVersionError_Reason
- type ApplicationException
- type AppliedLabel
- type AssetError
- type AssetError_Reason
- type AudienceExtensionError
- type AudienceExtensionError_Reason
- type AudienceSegmentCriteria
- type AudienceSegmentCriteria_ComparisonOperator
- type AudienceSegmentError
- type AudienceSegmentError_Reason
- type AuthenticationError
- type AuthenticationError_Reason
- type AvailabilityForecast
- type AvailabilityForecastOptions
- type BandwidthGroup
- type BandwidthGroupTargeting
- type BaseCustomFieldValue
- type BooleanValue
- type BreakdownForecast
- type Browser
- type BrowserLanguage
- type BrowserLanguageTargeting
- type BrowserTargeting
- type BuyerUserListTargeting
- type ChildContentEligibility
- type ClickTrackingLineItemError
- type ClickTrackingLineItemError_Reason
- type CmsMetadataCriteria
- type CmsMetadataCriteria_ComparisonOperator
- type CollectionSizeError
- type CollectionSizeError_Reason
- type CommonError
- type CommonError_Reason
- type CompanionDeliveryOption
- type CompanyCreditStatusError
- type CompanyCreditStatusError_Reason
- type CompetitiveConstraintScope
- type ComputedStatus
- type ContendingLineItem
- type ContentTargeting
- type CostType
- type CreativeError
- type CreativeError_Reason
- type CreativePlaceholder
- type CreativeRotationType
- type CreativeSizeType
- type CreativeTargeting
- type CrossSellError
- type CrossSellError_Reason
- type CurrencyCodeError
- type CurrencyCodeError_Reason
- type CustomCriteria
- type CustomCriteriaLeaf
- type CustomCriteriaNode
- type CustomCriteriaSet
- type CustomCriteriaSet_LogicalOperator
- type CustomCriteria_ComparisonOperator
- type CustomFieldValue
- type CustomFieldValueError
- type CustomFieldValueError_Reason
- type CustomPacingCurve
- type CustomPacingGoal
- type CustomPacingGoalUnit
- type CustomTargetingError
- type CustomTargetingError_Reason
- type Date
- type DateError
- type DateError_Reason
- type DateRange
- type DateTime
- type DateTimeRange
- type DateTimeRangeTargeting
- type DateTimeRangeTargetingError
- type DateTimeRangeTargetingError_Reason
- type DateTimeValue
- type DateValue
- type DayOfWeek
- type DayPart
- type DayPartTargeting
- type DayPartTargetingError
- type DayPartTargetingError_Reason
- type DeliveryData
- type DeliveryForecast
- type DeliveryForecastOptions
- type DeliveryForecastSource
- type DeliveryIndicator
- type DeliveryRateType
- type DeliveryTimeZone
- type DeviceCapability
- type DeviceCapabilityTargeting
- type DeviceCategory
- type DeviceCategoryTargeting
- type DeviceManufacturer
- type DeviceManufacturerTargeting
- type DropDownCustomFieldValue
- type EntityChildrenLimitReachedError
- type EntityChildrenLimitReachedError_Reason
- type EntityLimitReachedError
- type EntityLimitReachedError_Reason
- type EnvironmentType
- type FeatureError
- type FeatureError_Reason
- type FieldPathElement
- type ForecastBreakdown
- type ForecastBreakdownEntry
- type ForecastBreakdownOptions
- type ForecastBreakdownTarget
- type ForecastError
- type ForecastError_Reason
- type ForecastServiceInterface
- type FrequencyCap
- type FrequencyCapError
- type FrequencyCapError_Reason
- type GenericTargetingError
- type GenericTargetingError_Reason
- type GeoTargeting
- type GeoTargetingError
- type GeoTargetingError_Reason
- type GetAvailabilityForecast
- type GetAvailabilityForecastById
- type GetAvailabilityForecastByIdResponse
- type GetAvailabilityForecastResponse
- type GetDeliveryForecast
- type GetDeliveryForecastByIds
- type GetDeliveryForecastByIdsResponse
- type GetDeliveryForecastResponse
- type GetTrafficData
- type GetTrafficDataResponse
- type Goal
- type GoalType
- type GrpProvider
- type GrpSettings
- type GrpSettingsError
- type GrpSettingsError_Reason
- type GrpTargetGender
- type ImageError
- type ImageError_Reason
- type InternalApiError
- type InternalApiError_Reason
- type InvalidUrlError
- type InvalidUrlError_Reason
- type InventorySizeTargeting
- type InventoryTargeting
- type InventoryTargetingError
- type InventoryTargetingError_Reason
- type InventoryUnitError
- type InventoryUnitError_Reason
- type InventoryUrl
- type InventoryUrlTargeting
- type LabelEntityAssociationError
- type LabelEntityAssociationError_Reason
- type LineItem
- type LineItemActivityAssociation
- type LineItemActivityAssociationError
- type LineItemActivityAssociationError_Reason
- type LineItemCreativeAssociationError
- type LineItemCreativeAssociationError_Reason
- type LineItemDealInfoDto
- type LineItemDeliveryForecast
- type LineItemDiscountType
- type LineItemError
- type LineItemError_Reason
- type LineItemFlightDateError
- type LineItemFlightDateError_Reason
- type LineItemOperationError
- type LineItemOperationError_Reason
- type LineItemSummary
- type LineItemSummary_ReservationStatus
- type LineItemType
- type Location
- type MinuteOfHour
- type MobileApplicationTargeting
- type MobileApplicationTargetingError
- type MobileApplicationTargetingError_Reason
- type MobileCarrier
- type MobileCarrierTargeting
- type MobileDevice
- type MobileDeviceSubmodel
- type MobileDeviceSubmodelTargeting
- type MobileDeviceTargeting
- type Money
- type NCName
- type NegotiationRole
- type NielsenCtvPacingType
- type NotNullError
- type NotNullError_Reason
- type NullError
- type NullError_Reason
- type NumberValue
- type ObjectValue
- type OperatingSystem
- type OperatingSystemTargeting
- type OperatingSystemVersion
- type OperatingSystemVersionTargeting
- type OrderActionError
- type OrderActionError_Reason
- type OrderError
- type OrderError_Reason
- type PacingDeviceCategorizationType
- type ParseError
- type ParseError_Reason
- type PermissionError
- type PermissionError_Reason
- type PrecisionError
- type PrecisionError_Reason
- type ProgrammaticCreativeSource
- type ProgrammaticError
- type ProgrammaticError_Reason
- type ProposalLineItem
- type ProposalLineItemMakegoodInfo
- type ProspectiveLineItem
- type PublisherQueryLanguageContextError
- type PublisherQueryLanguageContextError_Reason
- type PublisherQueryLanguageSyntaxError
- type PublisherQueryLanguageSyntaxError_Reason
- type QuotaError
- type QuotaError_Reason
- type RangeError
- type RangeError_Reason
- type RateType
- type RegExError
- type RegExError_Reason
- type RequestHeader
- type RequestPlatform
- type RequestPlatformTargeting
- type RequestPlatformTargetingError
- type RequestPlatformTargetingError_Reason
- type RequiredCollectionError
- type RequiredCollectionError_Reason
- type RequiredError
- type RequiredError_Reason
- type RequiredNumberError
- type RequiredNumberError_Reason
- type RequiredSizeError
- type RequiredSizeError_Reason
- type ReservationDetailsError
- type ReservationDetailsError_Reason
- type ReservationStatus
- type ResponseHeader
- type RoadblockingType
- type ServerError
- type ServerError_Reason
- type SetTopBoxLineItemError
- type SetTopBoxLineItemError_Reason
- type SetValue
- type Size
- type SkippableAdType
- type SoapRequestHeader
- type SoapResponseHeader
- type StartDateTimeType
- type StatementError
- type StatementError_Reason
- type Stats
- type StringFormatError
- type StringFormatError_Reason
- type StringLengthError
- type StringLengthError_Reason
- type TargetedSize
- type Targeting
- type TargetingCriteriaBreakdown
- type TargetingDimension
- type TeamError
- type TeamError_Reason
- type Technology
- type TechnologyTargeting
- type TechnologyTargetingError
- type TechnologyTargetingError_Reason
- type TextValue
- type ThirdPartyBrandLiftIntegrationPartner
- type ThirdPartyMeasurementSettings
- type ThirdPartyReachIntegrationPartner
- type ThirdPartyViewabilityIntegrationPartner
- type TimeOfDay
- type TimeSeries
- type TimeUnit
- type TimeZoneError
- type TimeZoneError_Reason
- type TrafficDataRequest
- type TrafficDataResponse
- type TranscodingError
- type TranscodingError_Reason
- type TypeError
- type UniqueError
- type UnitType
- type UserDomainTargeting
- type UserDomainTargetingError
- type UserDomainTargetingError_Reason
- type VideoBumperType
- type VideoPosition
- type VideoPositionTarget
- type VideoPositionTargeting
- type VideoPositionTargetingError
- type VideoPositionTargetingError_Reason
- type VideoPositionWithinPod
- type VideoPosition_Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdUnitCodeError ¶
type AdUnitCodeError struct { *ApiError Reason *AdUnitCodeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type AdUnitCodeError_Reason ¶
type AdUnitCodeError_Reason string
const ( // // For {@link AdUnit#adUnitCode}, only alpha-numeric characters, // underscores, hyphens, periods, asterisks, double quotes, back slashes, // forward slashes, exclamations, left angle brackets, colons and // parentheses are allowed. // AdUnitCodeError_ReasonINVALID_CHARACTERS AdUnitCodeError_Reason = "INVALID_CHARACTERS" // // For {@link AdUnit#adUnitCode}, only letters, numbers, // underscores, hyphens, periods, asterisks, double quotes, back slashes, // forward slashes, exclamations, left angle brackets, colons and // parentheses are allowed. // AdUnitCodeError_ReasonINVALID_CHARACTERS_WHEN_UTF_CHARACTERS_ARE_ALLOWED AdUnitCodeError_Reason = "INVALID_CHARACTERS_WHEN_UTF_CHARACTERS_ARE_ALLOWED" // // For {@link AdUnit#adUnitCode} representing slot codes, only alphanumeric characters, // underscores, hyphens, periods and colons are allowed. // AdUnitCodeError_ReasonINVALID_CHARACTERS_FOR_LEGACY_AD_EXCHANGE_TAG AdUnitCodeError_Reason = "INVALID_CHARACTERS_FOR_LEGACY_AD_EXCHANGE_TAG" // // For {@link AdUnit#adUnitCode}, forward slashes are not allowed as // the first character. // AdUnitCodeError_ReasonLEADING_FORWARD_SLASH AdUnitCodeError_Reason = "LEADING_FORWARD_SLASH" // // Specific codes matching ca-*pub-*-tag are reserved for "Web Property IUs" // generated as part of the SlotCode migration. // AdUnitCodeError_ReasonRESERVED_CODE AdUnitCodeError_Reason = "RESERVED_CODE" // // The value returned if the actual value is not exposed by the requested API version. // AdUnitCodeError_ReasonUNKNOWN AdUnitCodeError_Reason = "UNKNOWN" )
type AdUnitTargeting ¶
type AdUnitTargeting struct { // // Included or excluded ad unit id. // AdUnitId string `xml:"adUnitId,omitempty" json:"adUnitId,omitempty"` // // Whether or not all descendants are included (or excluded) as part of including (or excluding) // this ad unit. By default, the value is {@code true} which means targeting this ad unit will // target all of its descendants. // IncludeDescendants bool `xml:"includeDescendants,omitempty" json:"includeDescendants,omitempty"` }
type AllowedFormats ¶
type AllowedFormats string
const ( // // Audio format. // This is only relevant for programmatic video line items. // AllowedFormatsAUDIO AllowedFormats = "AUDIO" // // The value returned if the actual value is not exposed by the requested API version. // AllowedFormatsUNKNOWN AllowedFormats = "UNKNOWN" )
type AlternativeUnitTypeForecast ¶
type AlternativeUnitTypeForecast struct { // // The alternative unit type being presented. // UnitType *UnitType `xml:"unitType,omitempty" json:"unitType,omitempty"` // // The number of units, defined by {@link #unitType}, that match the // specified targeting and delivery settings. // MatchedUnits int64 `xml:"matchedUnits,omitempty" json:"matchedUnits,omitempty"` // // The number of units, defined by {@link #unitType}, that can be // booked without affecting the delivery of any reserved line items. Exceeding // this value will not cause an overbook, but lower-priority line items may // not run. // AvailableUnits int64 `xml:"availableUnits,omitempty" json:"availableUnits,omitempty"` // // The maximum number of units, defined by {@link #unitType}, that // could be booked by taking inventory away from lower-priority line items. // PossibleUnits int64 `xml:"possibleUnits,omitempty" json:"possibleUnits,omitempty"` }
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 AppliedLabel ¶
type AppliedLabel struct { // // The ID of a created {@link Label}. // LabelId int64 `xml:"labelId,omitempty" json:"labelId,omitempty"` // // {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}. // IsNegated bool `xml:"isNegated,omitempty" json:"isNegated,omitempty"` }
type AssetError ¶
type AssetError struct { *ApiError // // The error reason represented by an enum. // Reason *AssetError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type AssetError_Reason ¶
type AssetError_Reason string
const ( // // An asset name must be unique across advertiser. // AssetError_ReasonNON_UNIQUE_NAME AssetError_Reason = "NON_UNIQUE_NAME" // // The file name is too long. // AssetError_ReasonFILE_NAME_TOO_LONG AssetError_Reason = "FILE_NAME_TOO_LONG" // // The file size is too large. // AssetError_ReasonFILE_SIZE_TOO_LARGE AssetError_Reason = "FILE_SIZE_TOO_LARGE" // // Required client code is not present in the code snippet. // AssetError_ReasonMISSING_REQUIRED_DYNAMIC_ALLOCATION_CLIENT AssetError_Reason = "MISSING_REQUIRED_DYNAMIC_ALLOCATION_CLIENT" // // Required height is not present in the code snippet. // AssetError_ReasonMISSING_REQUIRED_DYNAMIC_ALLOCATION_HEIGHT AssetError_Reason = "MISSING_REQUIRED_DYNAMIC_ALLOCATION_HEIGHT" // // Required width is not present in the code snippet. // AssetError_ReasonMISSING_REQUIRED_DYNAMIC_ALLOCATION_WIDTH AssetError_Reason = "MISSING_REQUIRED_DYNAMIC_ALLOCATION_WIDTH" // // Required format is not present in the mobile code snippet. // AssetError_ReasonMISSING_REQUIRED_DYNAMIC_ALLOCATION_FORMAT AssetError_Reason = "MISSING_REQUIRED_DYNAMIC_ALLOCATION_FORMAT" // // The parameter value in the code snippet is invalid. // AssetError_ReasonINVALID_CODE_SNIPPET_PARAMETER_VALUE AssetError_Reason = "INVALID_CODE_SNIPPET_PARAMETER_VALUE" // // Invalid asset Id. // AssetError_ReasonINVALID_ASSET_ID AssetError_Reason = "INVALID_ASSET_ID" // // The value returned if the actual value is not exposed by the requested API version. // AssetError_ReasonUNKNOWN AssetError_Reason = "UNKNOWN" )
type AudienceExtensionError ¶
type AudienceExtensionError struct { *ApiError // // The error reason represented by an enum. // Reason *AudienceExtensionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type AudienceExtensionError_Reason ¶
type AudienceExtensionError_Reason string
const ( // // Frequency caps are not supported by audience extension line items // AudienceExtensionError_ReasonFREQUENCY_CAPS_NOT_SUPPORTED AudienceExtensionError_Reason = "FREQUENCY_CAPS_NOT_SUPPORTED" // // Audience extension line items can only target geography // AudienceExtensionError_ReasonINVALID_TARGETING AudienceExtensionError_Reason = "INVALID_TARGETING" // // Audience extension line items can only target audience extension inventory units // AudienceExtensionError_ReasonINVENTORY_UNIT_TARGETING_INVALID AudienceExtensionError_Reason = "INVENTORY_UNIT_TARGETING_INVALID" // // Audience extension line items do not support {@link CreativeRotationType#SEQUENTIAL}. // AudienceExtensionError_ReasonINVALID_CREATIVE_ROTATION AudienceExtensionError_Reason = "INVALID_CREATIVE_ROTATION" // // The given ID of the external entity is not valid // AudienceExtensionError_ReasonINVALID_EXTERNAL_ENTITY_ID AudienceExtensionError_Reason = "INVALID_EXTERNAL_ENTITY_ID" // // Audience extension line items only support {@link LineItemType#STANDARD}. // AudienceExtensionError_ReasonINVALID_LINE_ITEM_TYPE AudienceExtensionError_Reason = "INVALID_LINE_ITEM_TYPE" // // Audience extension max bid is invalid when it is greater then the max budget. // AudienceExtensionError_ReasonINVALID_MAX_BID AudienceExtensionError_Reason = "INVALID_MAX_BID" // // Bulk update for audience extension line items is not allowed. // AudienceExtensionError_ReasonAUDIENCE_EXTENSION_BULK_UPDATE_NOT_ALLOWED AudienceExtensionError_Reason = "AUDIENCE_EXTENSION_BULK_UPDATE_NOT_ALLOWED" // // An unexpected error occurred. // AudienceExtensionError_ReasonUNEXPECTED_AUDIENCE_EXTENSION_ERROR AudienceExtensionError_Reason = "UNEXPECTED_AUDIENCE_EXTENSION_ERROR" // // The value entered for the maximum daily budget on an audience extension line item exceeds // the maximum allowed. // AudienceExtensionError_ReasonMAX_DAILY_BUDGET_AMOUNT_EXCEEDED AudienceExtensionError_Reason = "MAX_DAILY_BUDGET_AMOUNT_EXCEEDED" // // Creating a campaign for a line item that already has an associated campaign is not allowed. // AudienceExtensionError_ReasonEXTERNAL_CAMPAIGN_ALREADY_EXISTS AudienceExtensionError_Reason = "EXTERNAL_CAMPAIGN_ALREADY_EXISTS" // // Audience extension was specified on a line item but the feature was not // enabled. // AudienceExtensionError_ReasonAUDIENCE_EXTENSION_WITHOUT_FEATURE AudienceExtensionError_Reason = "AUDIENCE_EXTENSION_WITHOUT_FEATURE" // // Audience extension was specified on a line item but no audience extension account has // been linked. // AudienceExtensionError_ReasonAUDIENCE_EXTENSION_WITHOUT_LINKED_ACCOUNT AudienceExtensionError_Reason = "AUDIENCE_EXTENSION_WITHOUT_LINKED_ACCOUNT" // // Assocation creative size overrides are not allowed with audience extension. // AudienceExtensionError_ReasonCANNOT_OVERRIDE_CREATIVE_SIZE_WITH_AUDIENCE_EXTENSION AudienceExtensionError_Reason = "CANNOT_OVERRIDE_CREATIVE_SIZE_WITH_AUDIENCE_EXTENSION" // // Some association overrides are not allowed with audience extension. // AudienceExtensionError_ReasonCANNOT_OVERRIDE_FIELD_WITH_AUDIENCE_EXTENSION AudienceExtensionError_Reason = "CANNOT_OVERRIDE_FIELD_WITH_AUDIENCE_EXTENSION" // // Only one creative placeholder is allowed for an audience extension line item. // AudienceExtensionError_ReasonONLY_ONE_CREATIVE_PLACEHOLDER_ALLOWED AudienceExtensionError_Reason = "ONLY_ONE_CREATIVE_PLACEHOLDER_ALLOWED" // // Only one audience extension line item can be associated with a given order. // AudienceExtensionError_ReasonMULTIPLE_AUDIENCE_EXTENSION_LINE_ITEMS_ON_ORDER AudienceExtensionError_Reason = "MULTIPLE_AUDIENCE_EXTENSION_LINE_ITEMS_ON_ORDER" // // Audience extension line items must be copied separately from their associated creatives. // AudienceExtensionError_ReasonCANNOT_COPY_AUDIENCE_EXTENSION_LINE_ITEMS_AND_CREATIVES_TOGETHER AudienceExtensionError_Reason = "CANNOT_COPY_AUDIENCE_EXTENSION_LINE_ITEMS_AND_CREATIVES_TOGETHER" // // Audience extension is no longer supported and cannot be used. // AudienceExtensionError_ReasonFEATURE_DEPRECATED AudienceExtensionError_Reason = "FEATURE_DEPRECATED" // // The value returned if the actual value is not exposed by the requested API version. // AudienceExtensionError_ReasonUNKNOWN AudienceExtensionError_Reason = "UNKNOWN" )
type AudienceSegmentCriteria ¶
type AudienceSegmentCriteria struct { *CustomCriteriaLeaf // // The comparison operator. This attribute is required. // Operator *AudienceSegmentCriteria_ComparisonOperator `xml:"operator,omitempty" json:"operator,omitempty"` // // The ids of {@link AudienceSegment} objects used to target audience segments. This attribute is // required. // AudienceSegmentIds []int64 `xml:"audienceSegmentIds,omitempty" json:"audienceSegmentIds,omitempty"` }
type AudienceSegmentCriteria_ComparisonOperator ¶
type AudienceSegmentCriteria_ComparisonOperator string
const ( AudienceSegmentCriteria_ComparisonOperatorIS AudienceSegmentCriteria_ComparisonOperator = "IS" AudienceSegmentCriteria_ComparisonOperatorIS_NOT AudienceSegmentCriteria_ComparisonOperator = "IS_NOT" )
type AudienceSegmentError ¶
type AudienceSegmentError struct { *ApiError Reason *AudienceSegmentError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type AudienceSegmentError_Reason ¶
type AudienceSegmentError_Reason string
const ( // // First party audience segment is not supported. // AudienceSegmentError_ReasonFIRST_PARTY_AUDIENCE_SEGMENT_NOT_SUPPORTED AudienceSegmentError_Reason = "FIRST_PARTY_AUDIENCE_SEGMENT_NOT_SUPPORTED" // // Only rule-based first-party audience segments can be created. // AudienceSegmentError_ReasonONLY_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENTS_CAN_BE_CREATED AudienceSegmentError_Reason = "ONLY_RULE_BASED_FIRST_PARTY_AUDIENCE_SEGMENTS_CAN_BE_CREATED" // // Audience segment for the given id is not found. // AudienceSegmentError_ReasonAUDIENCE_SEGMENT_ID_NOT_FOUND AudienceSegmentError_Reason = "AUDIENCE_SEGMENT_ID_NOT_FOUND" // // Audience segment rule is invalid. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_RULE AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_RULE" // // Audience segment rule contains too many ad units and/or custom criteria. // AudienceSegmentError_ReasonAUDIENCE_SEGMENT_RULE_TOO_LONG AudienceSegmentError_Reason = "AUDIENCE_SEGMENT_RULE_TOO_LONG" // // Audience segment name is invalid. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_NAME AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_NAME" // // Audience segment with this name already exists. // AudienceSegmentError_ReasonDUPLICATE_AUDIENCE_SEGMENT_NAME AudienceSegmentError_Reason = "DUPLICATE_AUDIENCE_SEGMENT_NAME" // // Audience segment description is invalid. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_DESCRIPTION AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_DESCRIPTION" // // Audience segment pageviews value is invalid. It must be between 1 and 12. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_PAGEVIEWS AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_PAGEVIEWS" // // Audience segment recency value is invalid. It must be between 1 and 90 if pageviews > 1. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_RECENCY AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_RECENCY" // // Audience segment membership expiration value is invalid. It must be between 1 and 180. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_MEMBERSHIP_EXPIRATION AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_MEMBERSHIP_EXPIRATION" // // The given custom key cannot be part of audience segment rule due to unsupported characters. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_CUSTOM_KEY_NAME AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_CUSTOM_KEY_NAME" // // The given custom value cannot be part of audience segment rule due to unsupported characters. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_NAME AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_NAME" // // Broad-match custom value cannot be part of audience segment rule. // AudienceSegmentError_ReasonINVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_MATCH_TYPE AudienceSegmentError_Reason = "INVALID_AUDIENCE_SEGMENT_CUSTOM_VALUE_MATCH_TYPE" // // Audience segment rule cannot contain itself. // AudienceSegmentError_ReasonINVALID_NESTED_FIRST_PARTY_AUDIENCE_SEGMENT AudienceSegmentError_Reason = "INVALID_NESTED_FIRST_PARTY_AUDIENCE_SEGMENT" // // Audience segment rule cannot contain shared selling inventory unit. // AudienceSegmentError_ReasonSHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED AudienceSegmentError_Reason = "SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED" // // Audience segment rule cannot contain a nested third-party segment. // AudienceSegmentError_ReasonINVALID_NESTED_THIRD_PARTY_AUDIENCE_SEGMENT AudienceSegmentError_Reason = "INVALID_NESTED_THIRD_PARTY_AUDIENCE_SEGMENT" // // Audience segment rule cannot contain a nested inactive segment. // AudienceSegmentError_ReasonINACTIVE_NESTED_AUDIENCE_SEGMENT AudienceSegmentError_Reason = "INACTIVE_NESTED_AUDIENCE_SEGMENT" // // An error occurred when purchasing global licenses. // AudienceSegmentError_ReasonAUDIENCE_SEGMENT_GLOBAL_LICENSE_ERROR AudienceSegmentError_Reason = "AUDIENCE_SEGMENT_GLOBAL_LICENSE_ERROR" // // Segment cannot be activated as it violates Google's Platform Policy. // AudienceSegmentError_ReasonSEGMENT_VIOLATED_POLICY AudienceSegmentError_Reason = "SEGMENT_VIOLATED_POLICY" // // The value returned if the actual value is not exposed by the requested API version. // AudienceSegmentError_ReasonUNKNOWN AudienceSegmentError_Reason = "UNKNOWN" )
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 AvailabilityForecast ¶
type AvailabilityForecast struct { // // Uniquely identifies this availability forecast. This value is read-only and is assigned by // Google when the forecast is created. The attribute will be either the ID of the {@link // LineItem} object it represents, or {@code null} if the forecast represents a prospective line // item. // LineItemId int64 `xml:"lineItemId,omitempty" json:"lineItemId,omitempty"` // // The unique ID for the {@link Order} object that this line item belongs to, or {@code null} if // the forecast represents a prospective line item without an {@link LineItem#orderId} set. // OrderId int64 `xml:"orderId,omitempty" json:"orderId,omitempty"` // // The unit with which the goal or cap of the {@link LineItem} is defined. Will be the same value // as {@link Goal#unitType} for both a set line item or a prospective one. // UnitType *UnitType `xml:"unitType,omitempty" json:"unitType,omitempty"` // // The number of units, defined by {@link Goal#unitType}, that can be booked without affecting the // delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower // priority line items may not run. // AvailableUnits int64 `xml:"availableUnits,omitempty" json:"availableUnits,omitempty"` // // The number of units, defined by {@link Goal#unitType}, that have already been served if the // reservation is already running. // DeliveredUnits int64 `xml:"deliveredUnits,omitempty" json:"deliveredUnits,omitempty"` // // The number of units, defined by {@link Goal#unitType}, that match the specified targeting and // delivery settings. // MatchedUnits int64 `xml:"matchedUnits,omitempty" json:"matchedUnits,omitempty"` // // The maximum number of units, defined by {@link Goal#unitType}, that could be booked by taking // inventory away from lower priority line items and some same priority line items. // // <p>Please note: booking this number may cause lower priority line items and some same priority // line items to underdeliver. // PossibleUnits int64 `xml:"possibleUnits,omitempty" json:"possibleUnits,omitempty"` // // The number of reserved units, defined by {@link Goal#unitType}, requested. This can be an // absolute or percentage value. // ReservedUnits int64 `xml:"reservedUnits,omitempty" json:"reservedUnits,omitempty"` // // The breakdowns for each time window defined in {@link ForecastBreakdownOptions#timeWindows}. // // <p>If no breakdown was requested through {@link AvailabilityForecastOptions#breakdown}, this // field will be empty. // // If targeting breakdown was requested by {@link ForecastBreakdownOptions#targets} with no time // breakdown, this list will contain a single {@link ForecastBreakdown} corresponding to the time // window of the forecasted {@link LineItem}. // // Otherwise, each time window defined by {@link ForecastBreakdownOptions#timeWindows} will // correspond to one {@link ForecastBreakdown} in the same order. // // Targeting breakdowns for every time window are returned in // {@link ForecastBreakdown#breakdownEntries}. // // Some examples: // // For a targeting breakdown in the form of // {@code ForecastBreakdownOptions{targets=[IU=A, {IU=B, creative=1x1}]}}, the {@link #breakdowns} // field may look like: // {@code [ForecastBreakdown{breakdownEntries=[availableUnits=10, availableUnits=20]}]} // where the entries correspond to {@code {IU=A}} and {@code {IU=B, creative=1x1}} respectively. // // For a time breakdown in the form of // {@code ForecastBreakdownOptions{timeWindows=[1am, 2am, 3am]}}, the {@code breakdowns} field may // look like: <pre>{@code // [ // ForecastBreakdown{startTime=1am, endTime=2am, breakdownEntries=[availableUnits=10]}, // ForecastBreakdown{startTime=2am, endTime=3am, breakdownEntries=[availableUnits=20]} // ] // }</pre> // where the two {@link #ForecastBreakdown} correspond to the [1am, 2am) and [2am, 3am) time // windows respecively. // // For a two-dimensional breakdown in the form of // {@code ForecastBreakdownOptions{timeWindows=[1am, 2am, 3am], targets=[IU=A, IU=B]}, the {@code // breakdowns} field may look like: <pre>{@code // [ // ForecastBreakdown{startTime=1am, endTime=2am, // breakdownEntries=[availableUnits=10, availableUnits=100]}, // ForecastBreakdown{startTime=2am, endTime=3am, // breakdownEntries=[availableUnits=20, availableUnits=200]} // ] // }</pre> // where the first ForecastBreakdown respresents the [1am, 2am) time window with two entries for // the IU A and IU B respectively; and the second ForecastBreakdown represents the [2am, 3am) // time window also with two entries corresponding to the two IUs. // Breakdowns []*ForecastBreakdown `xml:"breakdowns,omitempty" json:"breakdowns,omitempty"` // // The forecast result broken down by the targeting of the forecasted line item. // TargetingCriteriaBreakdowns []*TargetingCriteriaBreakdown `xml:"targetingCriteriaBreakdowns,omitempty" json:"targetingCriteriaBreakdowns,omitempty"` // // List of {@link ContendingLineItem contending line items} for this forecast. // ContendingLineItems []*ContendingLineItem `xml:"contendingLineItems,omitempty" json:"contendingLineItems,omitempty"` // // Views of this forecast, with alternative unit types. // AlternativeUnitTypeForecasts []*AlternativeUnitTypeForecast `xml:"alternativeUnitTypeForecasts,omitempty" json:"alternativeUnitTypeForecasts,omitempty"` }
type AvailabilityForecastOptions ¶
type AvailabilityForecastOptions struct { // // When specified, forecast result for the availability line item will also include breakdowns by // its targeting in {@link AvailabilityForecast#targetingCriteriaBreakdowns}. // IncludeTargetingCriteriaBreakdown bool `xml:"includeTargetingCriteriaBreakdown,omitempty" json:"includeTargetingCriteriaBreakdown,omitempty"` // // When specified, the forecast result for the availability line item will also include contending // line items in {@link AvailabilityForecast#contendingLineItems}. // IncludeContendingLineItems bool `xml:"includeContendingLineItems,omitempty" json:"includeContendingLineItems,omitempty"` Breakdown *ForecastBreakdownOptions `xml:"breakdown,omitempty" json:"breakdown,omitempty"` }
type BandwidthGroup ¶
type BandwidthGroup struct {
*Technology
}
type BandwidthGroupTargeting ¶
type BandwidthGroupTargeting struct { // // Indicates whether bandwidth groups should be targeted or excluded. This attribute is optional // and defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // The bandwidth groups that are being targeted or excluded by the {@link LineItem}. // BandwidthGroups []*Technology `xml:"bandwidthGroups,omitempty" json:"bandwidthGroups,omitempty"` }
type BaseCustomFieldValue ¶
type BaseCustomFieldValue struct { // // Id of the {@code CustomField} to which this value belongs. This attribute is required. // CustomFieldId int64 `xml:"customFieldId,omitempty" json:"customFieldId,omitempty"` }
type BooleanValue ¶
type BooleanValue struct { // // The boolean value. // Value bool `xml:"value,omitempty" json:"value,omitempty"` // contains filtered or unexported fields }
type BreakdownForecast ¶
type Browser ¶
type Browser struct { *Technology // // Browser major version. // MajorVersion string `xml:"majorVersion,omitempty" json:"majorVersion,omitempty"` // // Browser minor version. // MinorVersion string `xml:"minorVersion,omitempty" json:"minorVersion,omitempty"` }
type BrowserLanguage ¶
type BrowserLanguage struct {
*Technology
}
type BrowserLanguageTargeting ¶
type BrowserLanguageTargeting struct { // // Indicates whether browsers languages should be targeted or excluded. This attribute is optional // and defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // Browser languages that are being targeted or excluded by the {@link LineItem}. // BrowserLanguages []*Technology `xml:"browserLanguages,omitempty" json:"browserLanguages,omitempty"` }
type BrowserTargeting ¶
type BrowserTargeting struct { // // Indicates whether browsers should be targeted or excluded. This attribute is optional and // defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // Browsers that are being targeted or excluded by the {@link LineItem}. // Browsers []*Technology `xml:"browsers,omitempty" json:"browsers,omitempty"` }
type BuyerUserListTargeting ¶
type BuyerUserListTargeting struct { // // Whether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user // list targeting. // HasBuyerUserListTargeting bool `xml:"hasBuyerUserListTargeting,omitempty" json:"hasBuyerUserListTargeting,omitempty"` }
type ChildContentEligibility ¶
type ChildContentEligibility string
const ( ChildContentEligibilityUNKNOWN ChildContentEligibility = "UNKNOWN" // // This line item is not eligible to serve on any requests that are child-directed. // ChildContentEligibilityDISALLOWED ChildContentEligibility = "DISALLOWED" // // This line item is eligible to serve on requests that are child-directed. // ChildContentEligibilityALLOWED ChildContentEligibility = "ALLOWED" )
type ClickTrackingLineItemError ¶
type ClickTrackingLineItemError struct { *ApiError // // The error reason represented by an enum. // Reason *ClickTrackingLineItemError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type ClickTrackingLineItemError_Reason ¶
type ClickTrackingLineItemError_Reason string
const ( // // The line item type cannot be changed once created. // ClickTrackingLineItemError_ReasonTYPE_IMMUTABLE ClickTrackingLineItemError_Reason = "TYPE_IMMUTABLE" // // Click tracking line items can only be targeted at ad unit inventory, all other // types are invalid, as well as placements. // ClickTrackingLineItemError_ReasonINVALID_TARGETING_TYPE ClickTrackingLineItemError_Reason = "INVALID_TARGETING_TYPE" // // Click tracking line items do not allow us to control creative delivery so // are by nature one or more as entered by the third party. // ClickTrackingLineItemError_ReasonINVALID_ROADBLOCKING_TYPE ClickTrackingLineItemError_Reason = "INVALID_ROADBLOCKING_TYPE" // // Click tracking line items do not support the // {@link CreativeRotationType#OPTIMIZED} creative rotation type. // ClickTrackingLineItemError_ReasonINVALID_CREATIVEROTATION_TYPE ClickTrackingLineItemError_Reason = "INVALID_CREATIVEROTATION_TYPE" // // Click tracking line items do not allow us to control line item delivery so // we can not control the rate at which they are served. // ClickTrackingLineItemError_ReasonINVALID_DELIVERY_RATE_TYPE ClickTrackingLineItemError_Reason = "INVALID_DELIVERY_RATE_TYPE" // // Not all fields are supported by the click tracking line items. // ClickTrackingLineItemError_ReasonUNSUPPORTED_FIELD ClickTrackingLineItemError_Reason = "UNSUPPORTED_FIELD" // // The value returned if the actual value is not exposed by the requested API version. // ClickTrackingLineItemError_ReasonUNKNOWN ClickTrackingLineItemError_Reason = "UNKNOWN" )
type CmsMetadataCriteria ¶
type CmsMetadataCriteria struct { *CustomCriteriaLeaf // // The comparison operator. This attribute is required. // Operator *CmsMetadataCriteria_ComparisonOperator `xml:"operator,omitempty" json:"operator,omitempty"` // // The ids of {@link CmsMetadataValue} objects used to target CMS metadata. This attribute is // required. // CmsMetadataValueIds []int64 `xml:"cmsMetadataValueIds,omitempty" json:"cmsMetadataValueIds,omitempty"` }
type CmsMetadataCriteria_ComparisonOperator ¶
type CmsMetadataCriteria_ComparisonOperator string
const ( CmsMetadataCriteria_ComparisonOperatorEQUALS CmsMetadataCriteria_ComparisonOperator = "EQUALS" CmsMetadataCriteria_ComparisonOperatorNOT_EQUALS CmsMetadataCriteria_ComparisonOperator = "NOT_EQUALS" )
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 CompanionDeliveryOption ¶
type CompanionDeliveryOption string
const ( // // Companions are not required to serve a creative set. The creative set can // serve to inventory that has zero or more matching companions. // CompanionDeliveryOptionOPTIONAL CompanionDeliveryOption = "OPTIONAL" // // At least one companion must be served in order for the creative set to be used. // CompanionDeliveryOptionAT_LEAST_ONE CompanionDeliveryOption = "AT_LEAST_ONE" // // All companions in the set must be served in order for the creative set to // be used. This can still serve to inventory that has more companions // than can be filled. // CompanionDeliveryOptionALL CompanionDeliveryOption = "ALL" // // The delivery type is unknown. // CompanionDeliveryOptionUNKNOWN CompanionDeliveryOption = "UNKNOWN" )
type CompanyCreditStatusError ¶
type CompanyCreditStatusError struct { *ApiError // // The error reason represented by an enum. // Reason *CompanyCreditStatusError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CompanyCreditStatusError_Reason ¶
type CompanyCreditStatusError_Reason string
const ( // // The user's role does not have permission to change // {@link Company#creditStatus} from the default value. The default value is // {@link Company.CreditStatus#ACTIVE} for the Basic credit status setting // and {@link Company.CreditStatus#ON_HOLD} for the Advanced credit status // setting. // CompanyCreditStatusError_ReasonCOMPANY_CREDIT_STATUS_CHANGE_NOT_ALLOWED CompanyCreditStatusError_Reason = "COMPANY_CREDIT_STATUS_CHANGE_NOT_ALLOWED" // // The network has not been enabled for editing credit status settings for // companies. // CompanyCreditStatusError_ReasonCANNOT_USE_CREDIT_STATUS_SETTING CompanyCreditStatusError_Reason = "CANNOT_USE_CREDIT_STATUS_SETTING" // // The network has not been enabled for the Advanced credit status // settings for companies. {@link Company#creditStatus} must be either // {@code ACTIVE} or {@code INACTIVE}. // CompanyCreditStatusError_ReasonCANNOT_USE_ADVANCED_CREDIT_STATUS_SETTING CompanyCreditStatusError_Reason = "CANNOT_USE_ADVANCED_CREDIT_STATUS_SETTING" // // An order cannot be created or updated because the // {@link Order#advertiserId} or the {@link Order#agencyId} it is associated // with has {@link Company#creditStatus} that is not {@code ACTIVE} or // {@code ON_HOLD}. // CompanyCreditStatusError_ReasonUNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_ORDER CompanyCreditStatusError_Reason = "UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_ORDER" // // A line item cannot be created for the order because the // {@link Order#advertiserId} or {Order#agencyId} it is associated with has // {@link Company#creditStatus} that is not {@code ACTIVE} or // {@code ON_HOLD}. // CompanyCreditStatusError_ReasonUNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_LINE_ITEM CompanyCreditStatusError_Reason = "UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_LINE_ITEM" // // The company cannot be blocked because there are more than 200 approved // orders of the company. Archive some, so that there are less than 200 of // them. // CompanyCreditStatusError_ReasonCANNOT_BLOCK_COMPANY_TOO_MANY_APPROVED_ORDERS CompanyCreditStatusError_Reason = "CANNOT_BLOCK_COMPANY_TOO_MANY_APPROVED_ORDERS" // // The value returned if the actual value is not exposed by the requested API version. // CompanyCreditStatusError_ReasonUNKNOWN CompanyCreditStatusError_Reason = "UNKNOWN" )
type CompetitiveConstraintScope ¶
type CompetitiveConstraintScope string
const ( // // The competitive exclusion label applies to all line items within a single pod (or group). // CompetitiveConstraintScopePOD CompetitiveConstraintScope = "POD" // // The competitive exclusion label applies to all line items within the entire stream of content. // CompetitiveConstraintScopeSTREAM CompetitiveConstraintScope = "STREAM" // // The value returned if the actual value is not exposed by the requested API version. // CompetitiveConstraintScopeUNKNOWN CompetitiveConstraintScope = "UNKNOWN" )
type ComputedStatus ¶
type ComputedStatus string
const ( // // The {@link LineItem} has past its {@link LineItem#endDateTime} with an auto extension, but // hasn't met its goal. // ComputedStatusDELIVERY_EXTENDED ComputedStatus = "DELIVERY_EXTENDED" // // The {@link LineItem} has begun serving. // ComputedStatusDELIVERING ComputedStatus = "DELIVERING" // // The {@link LineItem} has been activated and is ready to serve. // ComputedStatusREADY ComputedStatus = "READY" // // The {@link LineItem} has been paused from serving. // ComputedStatusPAUSED ComputedStatus = "PAUSED" // // The {@link LineItem} is inactive. It is either caused by missing creatives or // the network disabling auto-activation. // ComputedStatusINACTIVE ComputedStatus = "INACTIVE" // // The {@link LineItem} has been paused and its reserved inventory has been // released. The {@code LineItem} will not serve. // ComputedStatusPAUSED_INVENTORY_RELEASED ComputedStatus = "PAUSED_INVENTORY_RELEASED" // // The {@link LineItem} has been submitted for approval. // ComputedStatusPENDING_APPROVAL ComputedStatus = "PENDING_APPROVAL" // // The {@link LineItem} has completed its run. // ComputedStatusCOMPLETED ComputedStatus = "COMPLETED" // // The {@link LineItem} has been disapproved and is not eligible to serve. // ComputedStatusDISAPPROVED ComputedStatus = "DISAPPROVED" // // The {@link LineItem} is still being drafted. // ComputedStatusDRAFT ComputedStatus = "DRAFT" // // The {@link LineItem} has been canceled and is no longer eligible to serve. // This is a legacy status imported from Google Ad Manager orders. // ComputedStatusCANCELED ComputedStatus = "CANCELED" )
type ContendingLineItem ¶
type ContendingLineItem struct { // // The {@link LineItem#id Id} of the contending line item. // LineItemId int64 `xml:"lineItemId,omitempty" json:"lineItemId,omitempty"` // // Number of impressions contended for by both the forecasted line item and this line item, but // served to this line item in the forecast simulation. // ContendingImpressions int64 `xml:"contendingImpressions,omitempty" json:"contendingImpressions,omitempty"` }
type ContentTargeting ¶
type ContentTargeting struct { // // The IDs of content being targeted by the {@code LineItem}. // TargetedContentIds []int64 `xml:"targetedContentIds,omitempty" json:"targetedContentIds,omitempty"` // // The IDs of content being excluded by the {@code LineItem}. // ExcludedContentIds []int64 `xml:"excludedContentIds,omitempty" json:"excludedContentIds,omitempty"` // // A list of video content bundles, represented by {@link ContentBundle} IDs, that are being // targeted by the {@code LineItem}. // TargetedVideoContentBundleIds []int64 `xml:"targetedVideoContentBundleIds,omitempty" json:"targetedVideoContentBundleIds,omitempty"` // // A list of video content bundles, represented by {@link ContentBundle} IDs, that are being // excluded by the {@code LineItem}. // ExcludedVideoContentBundleIds []int64 `xml:"excludedVideoContentBundleIds,omitempty" json:"excludedVideoContentBundleIds,omitempty"` }
type CostType ¶
type CostType string
const ( // // Cost per action. The {@link LineItem#lineItemType} must be one of: // <ul> // <li>{@link LineItemType#SPONSORSHIP}</li> // <li>{@link LineItemType#STANDARD}</li> // <li>{@link LineItemType#BULK}</li> // <li>{@link LineItemType#NETWORK}</li> // </ul> // CostTypeCPA CostType = "CPA" // // Cost per click. The {@link LineItem#lineItemType} must be one of: // <ul> // <li>{@link LineItemType#SPONSORSHIP}</li> // <li>{@link LineItemType#STANDARD}</li> // <li>{@link LineItemType#BULK}</li> // <li>{@link LineItemType#NETWORK}</li> // <li>{@link LineItemType#PRICE_PRIORITY}</li> // <li>{@link LineItemType#HOUSE}</li> // </ul> // CostTypeCPC CostType = "CPC" // // Cost per day. The {@link LineItem#lineItemType} must be one of: // <ul> // <li>{@link LineItemType#SPONSORSHIP}<li> // <li>{@link LineItemType#NETWORK}<li> // </ul> // CostTypeCPD CostType = "CPD" // // Cost per mille (cost per thousand impressions). The // {@link LineItem#lineItemType} must be one of: // <ul> // <li>{@link LineItemType#SPONSORSHIP}</li> // <li>{@link LineItemType#STANDARD}</li> // <li>{@link LineItemType#BULK}</li> // <li>{@link LineItemType#NETWORK}</li> // <li>{@link LineItemType#PRICE_PRIORITY}</li> // <li>{@link LineItemType#HOUSE}</li> // </ul> // CostTypeCPM CostType = "CPM" // // Cost per thousand Active View viewable impressions. The {@link LineItem#lineItemType} // must be {@link LineItemType#STANDARD}. // CostTypeVCPM CostType = "VCPM" // // Cost per thousand in-target impressions. The {@link LineItem#lineItemType} // must be {@link LineItemType#STANDARD}. // CostTypeCPM_IN_TARGET CostType = "CPM_IN_TARGET" // // The value returned if the actual value is not exposed by the requested API version. // CostTypeUNKNOWN CostType = "UNKNOWN" )
type CreativeError ¶
type CreativeError struct { *ApiError // // The error reason represented by an enum. // Reason *CreativeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CreativeError_Reason ¶
type CreativeError_Reason string
const ( // // {@link FlashRedirectCreative#flashUrl} and // {@link FlashRedirectCreative#fallbackUrl} are the same. The fallback URL // is used when the flash URL does not work and must be different from it. // CreativeError_ReasonFLASH_AND_FALLBACK_URL_ARE_SAME CreativeError_Reason = "FLASH_AND_FALLBACK_URL_ARE_SAME" // // The internal redirect URL was invalid. The URL must have the following // syntax http://ad.doubleclick.net/ad/sitename/;sz=size. // CreativeError_ReasonINVALID_INTERNAL_REDIRECT_URL CreativeError_Reason = "INVALID_INTERNAL_REDIRECT_URL" // // {@link HasDestinationUrlCreative#destinationUrl} is required. // CreativeError_ReasonDESTINATION_URL_REQUIRED CreativeError_Reason = "DESTINATION_URL_REQUIRED" // // {@link HasDestinationUrlCreative#destinationUrl} must be empty when its type is // {@link DestinationUrlType#NONE}. // CreativeError_ReasonDESTINATION_URL_NOT_EMPTY CreativeError_Reason = "DESTINATION_URL_NOT_EMPTY" // // The provided {@link DestinationUrlType} is not supported for the creative type it is // being used on. // CreativeError_ReasonDESTINATION_URL_TYPE_NOT_SUPPORTED CreativeError_Reason = "DESTINATION_URL_TYPE_NOT_SUPPORTED" // // Cannot create or update legacy DART For Publishers creative. // CreativeError_ReasonCANNOT_CREATE_OR_UPDATE_LEGACY_DFP_CREATIVE CreativeError_Reason = "CANNOT_CREATE_OR_UPDATE_LEGACY_DFP_CREATIVE" // // Cannot create or update legacy mobile creative. // CreativeError_ReasonCANNOT_CREATE_OR_UPDATE_LEGACY_DFP_MOBILE_CREATIVE CreativeError_Reason = "CANNOT_CREATE_OR_UPDATE_LEGACY_DFP_MOBILE_CREATIVE" // // The user is missing a necessary feature. // CreativeError_ReasonMISSING_FEATURE CreativeError_Reason = "MISSING_FEATURE" // // Company type should be one of Advertisers, House Advertisers and // Ad Networks. // CreativeError_ReasonINVALID_COMPANY_TYPE CreativeError_Reason = "INVALID_COMPANY_TYPE" // // Invalid size for AdSense dynamic allocation creative. // Only valid AFC sizes are allowed. // CreativeError_ReasonINVALID_ADSENSE_CREATIVE_SIZE CreativeError_Reason = "INVALID_ADSENSE_CREATIVE_SIZE" // // Invalid size for Ad Exchange dynamic allocation creative. // Only valid Ad Exchange sizes are allowed. // CreativeError_ReasonINVALID_AD_EXCHANGE_CREATIVE_SIZE CreativeError_Reason = "INVALID_AD_EXCHANGE_CREATIVE_SIZE" // // Assets associated with the same creative must be unique. // CreativeError_ReasonDUPLICATE_ASSET_IN_CREATIVE CreativeError_Reason = "DUPLICATE_ASSET_IN_CREATIVE" // // A creative asset cannot contain an asset ID and a byte array. // CreativeError_ReasonCREATIVE_ASSET_CANNOT_HAVE_ID_AND_BYTE_ARRAY CreativeError_Reason = "CREATIVE_ASSET_CANNOT_HAVE_ID_AND_BYTE_ARRAY" // // Cannot create or update unsupported creative. // CreativeError_ReasonCANNOT_CREATE_OR_UPDATE_UNSUPPORTED_CREATIVE CreativeError_Reason = "CANNOT_CREATE_OR_UPDATE_UNSUPPORTED_CREATIVE" // // Cannot create programmatic creatives. // CreativeError_ReasonCANNOT_CREATE_PROGRAMMATIC_CREATIVES CreativeError_Reason = "CANNOT_CREATE_PROGRAMMATIC_CREATIVES" // // A creative must have valid size to use the third-party impression tracker. // CreativeError_ReasonINVALID_SIZE_FOR_THIRD_PARTY_IMPRESSION_TRACKER CreativeError_Reason = "INVALID_SIZE_FOR_THIRD_PARTY_IMPRESSION_TRACKER" // // Ineligible creatives can not be deactivated. // CreativeError_ReasonCANNOT_DEACTIVATE_CREATIVES_IN_CREATIVE_SETS CreativeError_Reason = "CANNOT_DEACTIVATE_CREATIVES_IN_CREATIVE_SETS" // // Ad Manager hosted video creatives must contain a video asset. // CreativeError_ReasonHOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET CreativeError_Reason = "HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET" // // {@link ImageCreative#thirdPartyImpressionTrackingUrls} should not contain more than one url. // CreativeError_ReasonCANNOT_SET_MULTIPLE_IMPRESSION_TRACKING_URLS CreativeError_Reason = "CANNOT_SET_MULTIPLE_IMPRESSION_TRACKING_URLS" // // The value returned if the actual value is not exposed by the requested API version. // CreativeError_ReasonUNKNOWN CreativeError_Reason = "UNKNOWN" )
type CreativePlaceholder ¶
type CreativePlaceholder struct { // // The dimensions that the creative is expected to have. This attribute is required. // Size *Size `xml:"size,omitempty" json:"size,omitempty"` // // The native creative template ID. // // <p>This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}. // CreativeTemplateId int64 `xml:"creativeTemplateId,omitempty" json:"creativeTemplateId,omitempty"` // // The companions that the creative is expected to have. This attribute can only be set if the // line item it belongs to has a {@link LineItem#environmentType} of {@link // EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link // RoadblockingType#CREATIVE_SET}. // Companions []*CreativePlaceholder `xml:"companions,omitempty" json:"companions,omitempty"` // // The set of label frequency caps applied directly to this creative placeholder. // AppliedLabels []*AppliedLabel `xml:"appliedLabels,omitempty" json:"appliedLabels,omitempty"` // // Contains the set of labels applied directly to this creative placeholder as well as those // inherited from the creative template from which this creative placeholder was instantiated. // This field is readonly and is assigned by Google. // EffectiveAppliedLabels []*AppliedLabel `xml:"effectiveAppliedLabels,omitempty" json:"effectiveAppliedLabels,omitempty"` // // Expected number of creatives that will be uploaded corresponding to this creative placeholder. // This estimate is used to improve the accuracy of forecasting; for example, if label frequency // capping limits the number of times a creative may be served. // ExpectedCreativeCount int32 `xml:"expectedCreativeCount,omitempty" json:"expectedCreativeCount,omitempty"` // // Describes the types of sizes a creative can be. By default, the creative's size is {@link // CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair). // CreativeSizeType *CreativeSizeType `xml:"creativeSizeType,omitempty" json:"creativeSizeType,omitempty"` // // The name of the {@link CreativeTargeting} for creatives this placeholder represents. // // <p>This attribute is optional. Specifying creative targeting here is for forecasting purposes // only and has no effect on serving. The same creative targeting should be specified on a {@link // LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}. // TargetingName string `xml:"targetingName,omitempty" json:"targetingName,omitempty"` // // Indicate if the expected creative of this placeholder has an AMP only variant. // // <p>This attribute is optional. It is for forecasting purposes only and has no effect on // serving. // IsAmpOnly bool `xml:"isAmpOnly,omitempty" json:"isAmpOnly,omitempty"` }
type CreativeRotationType ¶
type CreativeRotationType string
const ( // // Creatives are displayed roughly the same number of times over // the duration of the line item. // CreativeRotationTypeEVEN CreativeRotationType = "EVEN" // // Creatives are served roughly proportionally to their performance. // CreativeRotationTypeOPTIMIZED CreativeRotationType = "OPTIMIZED" // // Creatives are served roughly proportionally to their weights, set on the // {@link LineItemCreativeAssociation}. // CreativeRotationTypeMANUAL CreativeRotationType = "MANUAL" // // Creatives are served exactly in sequential order, aka Storyboarding. // Set on the {@link LineItemCreativeAssociation}. // CreativeRotationTypeSEQUENTIAL CreativeRotationType = "SEQUENTIAL" )
type CreativeSizeType ¶
type CreativeSizeType string
const ( // // Dimension based size, an actual height and width. // CreativeSizeTypePIXEL CreativeSizeType = "PIXEL" // // Mobile size, that is expressed as a ratio of say 4 by 1, that could be // met by a 100 x 25 sized image. // CreativeSizeTypeASPECT_RATIO CreativeSizeType = "ASPECT_RATIO" // // Out-of-page size, that is not related to the slot it is served. But rather // is a function of the snippet, and the values set. This must be used with // 1x1 size. // CreativeSizeTypeINTERSTITIAL CreativeSizeType = "INTERSTITIAL" // // Size has no meaning // // <p>1. For Click Tracking entities, where size doesn't matter 2. For entities that allow all // requested sizes, where the size represents all sizes. // CreativeSizeTypeIGNORED CreativeSizeType = "IGNORED" // // Native size, which is a function of the how the client renders the creative. // This must be used with 1x1 size. // CreativeSizeTypeNATIVE CreativeSizeType = "NATIVE" // // Audio size. Used with audio ads. This must be used with 1x1 size. // CreativeSizeTypeAUDIO CreativeSizeType = "AUDIO" )
type CreativeTargeting ¶
type CreativeTargeting struct { // // The name of this creative targeting. This attribute is required. // Name string `xml:"name,omitempty" json:"name,omitempty"` // // The {@link Targeting} criteria of this creative targeting. This attribute is required. // Targeting *Targeting `xml:"targeting,omitempty" json:"targeting,omitempty"` }
type CrossSellError ¶
type CrossSellError struct { *ApiError // // The error reason represented by an enum. // Reason *CrossSellError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CrossSellError_Reason ¶
type CrossSellError_Reason string
const ( // // A company for cross-sell partner must be of type {@link Company.Type#PARTNER}. // CrossSellError_ReasonCOMPANY_IS_NOT_DISTRIBUTION_PARTNER CrossSellError_Reason = "COMPANY_IS_NOT_DISTRIBUTION_PARTNER" // // The network code of a cross-sell partner cannot be changed. // CrossSellError_ReasonCHANGING_PARTNER_NETWORK_IS_NOT_SUPPORTED CrossSellError_Reason = "CHANGING_PARTNER_NETWORK_IS_NOT_SUPPORTED" // // A cross-sell partner must have a partner name. // CrossSellError_ReasonMISSING_DISTRIBUTOR_PARTNER_NAME CrossSellError_Reason = "MISSING_DISTRIBUTOR_PARTNER_NAME" // // The cross-sell distributor publisher feature must be enabled. // CrossSellError_ReasonDISTRIBUTOR_NETWORK_MISSING_PUBLISHER_FEATURE CrossSellError_Reason = "DISTRIBUTOR_NETWORK_MISSING_PUBLISHER_FEATURE" // // The cross-sell publisher features must be enabled on the partner's network. // CrossSellError_ReasonCONTENT_PROVIDER_NETWORK_MISSING_PUBLISHER_FEATURE CrossSellError_Reason = "CONTENT_PROVIDER_NETWORK_MISSING_PUBLISHER_FEATURE" // // The cross-sell partner name conflicts with an ad unit name on the partner's network. // CrossSellError_ReasonINVALID_DISTRIBUTOR_PARTNER_NAME CrossSellError_Reason = "INVALID_DISTRIBUTOR_PARTNER_NAME" // // The network code of a cross-sell partner is invalid. // CrossSellError_ReasonINVALID_CONTENT_PROVIDER_NETWORK CrossSellError_Reason = "INVALID_CONTENT_PROVIDER_NETWORK" // // The content provider network must be different than the distributor network. // CrossSellError_ReasonCONTENT_PROVIDER_NETWORK_CANNOT_BE_ACTIVE_NETWORK CrossSellError_Reason = "CONTENT_PROVIDER_NETWORK_CANNOT_BE_ACTIVE_NETWORK" // // The same network code was already enabled for cross-sell in a different company. // CrossSellError_ReasonCONTENT_PROVIDER_NETWORK_ALREADY_ENABLED_FOR_CROSS_SELLING CrossSellError_Reason = "CONTENT_PROVIDER_NETWORK_ALREADY_ENABLED_FOR_CROSS_SELLING" // // A rule defined by the cross selling distributor has been violated by a line item targeting // a shared ad unit. Violating this rule is an error. // CrossSellError_ReasonDISTRIBUTOR_RULE_VIOLATION_ERROR CrossSellError_Reason = "DISTRIBUTOR_RULE_VIOLATION_ERROR" // // A rule defined by the cross selling distributor has been violated by a line item targeting // a shared ad unit. Violating this rule is a warning. // // <p>By setting {@link LineItem#skipCrossSellingRuleWarningChecks}, the content partner can // suppress the warning (and create or save the line item). // // <p>This flag is available beginning in V201411. // CrossSellError_ReasonDISTRIBUTOR_RULE_VIOLATION_WARNING CrossSellError_Reason = "DISTRIBUTOR_RULE_VIOLATION_WARNING" // // The value returned if the actual value is not exposed by the requested API version. // CrossSellError_ReasonUNKNOWN CrossSellError_Reason = "UNKNOWN" )
type CurrencyCodeError ¶
type CurrencyCodeError struct { *ApiError Reason *CurrencyCodeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CurrencyCodeError_Reason ¶
type CurrencyCodeError_Reason string
const ( // // The currency code is invalid and does not follow ISO 4217. // CurrencyCodeError_ReasonINVALID CurrencyCodeError_Reason = "INVALID" // // The currency code is valid, but is not supported. // CurrencyCodeError_ReasonUNSUPPORTED CurrencyCodeError_Reason = "UNSUPPORTED" // // The currency has been used for entity creation after its deprecation // CurrencyCodeError_ReasonDEPRECATED_CURRENCY_USED CurrencyCodeError_Reason = "DEPRECATED_CURRENCY_USED" )
type CustomCriteria ¶
type CustomCriteria struct { *CustomCriteriaLeaf // // The {@link CustomTargetingKey#id} of the {@link CustomTargetingKey} object that was created // using {@link CustomTargetingService}. This attribute is required. // KeyId int64 `xml:"keyId,omitempty" json:"keyId,omitempty"` // // The ids of {@link CustomTargetingValue} objects to target the custom targeting key with id // {@link CustomCriteria#keyId}. This attribute is required. // ValueIds []int64 `xml:"valueIds,omitempty" json:"valueIds,omitempty"` // // The comparison operator. This attribute is required. // Operator *CustomCriteria_ComparisonOperator `xml:"operator,omitempty" json:"operator,omitempty"` }
type CustomCriteriaLeaf ¶
type CustomCriteriaLeaf struct {
*CustomCriteriaNode
}
type CustomCriteriaNode ¶
type CustomCriteriaNode struct { }
type CustomCriteriaSet ¶
type CustomCriteriaSet struct { *CustomCriteriaNode // // The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is // required. // <span class="constraint Required">This attribute is required.</span> // LogicalOperator *CustomCriteriaSet_LogicalOperator `xml:"logicalOperator,omitempty" json:"logicalOperator,omitempty"` // // The custom criteria. This attribute is required. // Children []*CustomCriteriaNode `xml:"children,omitempty" json:"children,omitempty"` }
type CustomCriteriaSet_LogicalOperator ¶
type CustomCriteriaSet_LogicalOperator string
const ( CustomCriteriaSet_LogicalOperatorAND CustomCriteriaSet_LogicalOperator = "AND" CustomCriteriaSet_LogicalOperatorOR CustomCriteriaSet_LogicalOperator = "OR" )
type CustomCriteria_ComparisonOperator ¶
type CustomCriteria_ComparisonOperator string
const ( CustomCriteria_ComparisonOperatorIS CustomCriteria_ComparisonOperator = "IS" CustomCriteria_ComparisonOperatorIS_NOT CustomCriteria_ComparisonOperator = "IS_NOT" )
type CustomFieldValue ¶
type CustomFieldValue struct { *BaseCustomFieldValue // // The value for this field. The appropriate type of {@code Value} is determined by the {@link // CustomField#dataType} of the {@code CustomField} that this conforms to. // // <table> // <tr><th>{@link CustomFieldDataType}</th><th>{@link Value} type</th></tr> // <tr><td>{@link CustomFieldDataType#STRING STRING}</td><td>{@link TextValue}</td></tr> // <tr><td>{@link CustomFieldDataType#NUMBER NUMBER}</td><td>{@link NumberValue}</td></tr> // <tr><td>{@link CustomFieldDataType#TOGGLE TOGGLE}</td><td>{@link BooleanValue}</td></tr> // </table> // Value *_Value `xml:"value,omitempty" json:"value,omitempty"` }
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 CustomPacingCurve ¶
type CustomPacingCurve struct { // // The unit of the {@link CustomPacingGoalDto#amount} values. // CustomPacingGoalUnit *CustomPacingGoalUnit `xml:"customPacingGoalUnit,omitempty" json:"customPacingGoalUnit,omitempty"` // // The list of goals that make up the custom pacing curve. // CustomPacingGoals []*CustomPacingGoal `xml:"customPacingGoals,omitempty" json:"customPacingGoals,omitempty"` }
type CustomPacingGoal ¶
type CustomPacingGoal struct { // // The start date and time of the goal. This field is required unless {@code // useLineItemStartDateTime} is true. // StartDateTime soap.XSDDateTime `xml:"startDateTime,omitempty" json:"startDateTime,omitempty"` // // Whether the {@link LineItem#startDateTime} should be used for the start date and time of this // goal. This field is not persisted and if it is set to true, the {@code startDateTime} field // will be populated by the line item's start time. // UseLineItemStartDateTime bool `xml:"useLineItemStartDateTime,omitempty" json:"useLineItemStartDateTime,omitempty"` Amount int64 `xml:"amount,omitempty" json:"amount,omitempty"` }
type CustomPacingGoalUnit ¶
type CustomPacingGoalUnit string
const ( // // The custom pacing goal amounts represent absolute numbers corresponding to the line item's // {@link Goal#unitType}. // CustomPacingGoalUnitABSOLUTE CustomPacingGoalUnit = "ABSOLUTE" // // The custom pacing goal amounts represent a millipercent. For example, 15000 millipercent // equals 15%. // CustomPacingGoalUnitMILLI_PERCENT CustomPacingGoalUnit = "MILLI_PERCENT" // // The value returned if the actual value is not exposed by the requested API version. // CustomPacingGoalUnitUNKNOWN CustomPacingGoalUnit = "UNKNOWN" )
type CustomTargetingError ¶
type CustomTargetingError struct { *ApiError Reason *CustomTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type CustomTargetingError_Reason ¶
type CustomTargetingError_Reason string
const ( // // Requested {@link CustomTargetingKey} is not found. // CustomTargetingError_ReasonKEY_NOT_FOUND CustomTargetingError_Reason = "KEY_NOT_FOUND" // // Number of {@link CustomTargetingKey} objects created exceeds the limit // allowed for the network. // CustomTargetingError_ReasonKEY_COUNT_TOO_LARGE CustomTargetingError_Reason = "KEY_COUNT_TOO_LARGE" // // {@link CustomTargetingKey} with the same {@link CustomTargetingKey#name} // already exists. // CustomTargetingError_ReasonKEY_NAME_DUPLICATE CustomTargetingError_Reason = "KEY_NAME_DUPLICATE" // // {@link CustomTargetingKey#name} is empty. // CustomTargetingError_ReasonKEY_NAME_EMPTY CustomTargetingError_Reason = "KEY_NAME_EMPTY" // // {@link CustomTargetingKey#name} is too long. // CustomTargetingError_ReasonKEY_NAME_INVALID_LENGTH CustomTargetingError_Reason = "KEY_NAME_INVALID_LENGTH" // // {@link CustomTargetingKey#name} contains unsupported or reserved // characters. // CustomTargetingError_ReasonKEY_NAME_INVALID_CHARS CustomTargetingError_Reason = "KEY_NAME_INVALID_CHARS" // // {@link CustomTargetingKey#name} matches one of the reserved custom // targeting key names. // CustomTargetingError_ReasonKEY_NAME_RESERVED CustomTargetingError_Reason = "KEY_NAME_RESERVED" // // {@link CustomTargetingKey#displayName} is too long. // CustomTargetingError_ReasonKEY_DISPLAY_NAME_INVALID_LENGTH CustomTargetingError_Reason = "KEY_DISPLAY_NAME_INVALID_LENGTH" // // Key is not active. // CustomTargetingError_ReasonKEY_STATUS_NOT_ACTIVE CustomTargetingError_Reason = "KEY_STATUS_NOT_ACTIVE" // // Requested {@link CustomTargetingValue} is not found. // CustomTargetingError_ReasonVALUE_NOT_FOUND CustomTargetingError_Reason = "VALUE_NOT_FOUND" // // The {@code WHERE} clause in the {@link Statement#query} must always // contain {@link CustomTargetingValue#customTargetingKeyId} as one of its // columns in a way that it is AND'ed with the rest of the query. // CustomTargetingError_ReasonGET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID CustomTargetingError_Reason = "GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID" // // The number of {@link CustomTargetingValue} objects associated with a // {@link CustomTargetingKey} exceeds the network limit. This is only // applicable for keys of type {@code CustomTargetingKey.Type#PREDEFINED}. // CustomTargetingError_ReasonVALUE_COUNT_FOR_KEY_TOO_LARGE CustomTargetingError_Reason = "VALUE_COUNT_FOR_KEY_TOO_LARGE" // // {@link CustomTargetingValue} with the same // {@link CustomTargetingValue#name} already exists. // CustomTargetingError_ReasonVALUE_NAME_DUPLICATE CustomTargetingError_Reason = "VALUE_NAME_DUPLICATE" // // {@link CustomTargetingValue#name} is empty. // CustomTargetingError_ReasonVALUE_NAME_EMPTY CustomTargetingError_Reason = "VALUE_NAME_EMPTY" // // {@link CustomTargetingValue#name} is too long. // CustomTargetingError_ReasonVALUE_NAME_INVALID_LENGTH CustomTargetingError_Reason = "VALUE_NAME_INVALID_LENGTH" // // {@link CustomTargetingValue#name} contains unsupported or reserved // characters. // CustomTargetingError_ReasonVALUE_NAME_INVALID_CHARS CustomTargetingError_Reason = "VALUE_NAME_INVALID_CHARS" // // {@link CustomTargetingValue#displayName} is too long. // CustomTargetingError_ReasonVALUE_DISPLAY_NAME_INVALID_LENGTH CustomTargetingError_Reason = "VALUE_DISPLAY_NAME_INVALID_LENGTH" // // Only Ad Manager 360 networks can have {@link CustomTargetingValue#matchType} // other than {@link CustomTargetingValue.MatchType#EXACT}. // CustomTargetingError_ReasonVALUE_MATCH_TYPE_NOT_ALLOWED CustomTargetingError_Reason = "VALUE_MATCH_TYPE_NOT_ALLOWED" // // You can only create {@link CustomTargetingValue} objects with match type // {@link CustomTargetingValue.MatchType#EXACT} when associating // with {@link CustomTargetingKey} objects of type // {@link CustomTargetingKey.Type#PREDEFINED} // CustomTargetingError_ReasonVALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY CustomTargetingError_Reason = "VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY" // // {@link CustomTargetingValue} object cannot have match type of // {@link CustomTargetingValue.MatchType#SUFFIX} when adding a // {@link CustomTargetingValue} to a line item. // CustomTargetingError_ReasonSUFFIX_MATCH_TYPE_NOT_ALLOWED CustomTargetingError_Reason = "SUFFIX_MATCH_TYPE_NOT_ALLOWED" // // {@link CustomTargetingValue} object cannot have match type of // {@link CustomTargetingValue.MatchType#CONTAINS} when adding a // {@link CustomTargetingValue} to targeting expression of a line item. // CustomTargetingError_ReasonCONTAINS_MATCH_TYPE_NOT_ALLOWED CustomTargetingError_Reason = "CONTAINS_MATCH_TYPE_NOT_ALLOWED" // // Value is not active. // CustomTargetingError_ReasonVALUE_STATUS_NOT_ACTIVE CustomTargetingError_Reason = "VALUE_STATUS_NOT_ACTIVE" // // The {@link CustomTargetingKey} does not have any // {@link CustomTargetingValue} associated with it. // CustomTargetingError_ReasonKEY_WITH_MISSING_VALUES CustomTargetingError_Reason = "KEY_WITH_MISSING_VALUES" // // The {@link CustomTargetingKey} has a {@link CustomTargetingValue} specified for which the // value is not a valid child. // CustomTargetingError_ReasonINVALID_VALUE_FOR_KEY CustomTargetingError_Reason = "INVALID_VALUE_FOR_KEY" // // {@link CustomCriteriaSet.LogicalOperator#OR} operation cannot be applied // to values with different keys. // CustomTargetingError_ReasonCANNOT_OR_DIFFERENT_KEYS CustomTargetingError_Reason = "CANNOT_OR_DIFFERENT_KEYS" // // Targeting expression is invalid. This can happen if the sequence of // operators is wrong, or a node contains invalid number of children. // CustomTargetingError_ReasonINVALID_TARGETING_EXPRESSION CustomTargetingError_Reason = "INVALID_TARGETING_EXPRESSION" // // The key has been deleted. {@link CustomCriteria} cannot have deleted // keys. // CustomTargetingError_ReasonDELETED_KEY_CANNOT_BE_USED_FOR_TARGETING CustomTargetingError_Reason = "DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING" // // The value has been deleted. {@link CustomCriteria} cannot have deleted // values. // CustomTargetingError_ReasonDELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING CustomTargetingError_Reason = "DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING" // // The key is set as the video browse-by key, which cannot be used for // custom targeting. // CustomTargetingError_ReasonVIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING CustomTargetingError_Reason = "VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING" // // Only active custom-criteria keys are supported in content metadata mapping. // CustomTargetingError_ReasonCANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING CustomTargetingError_Reason = "CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING" // // Only active custom-criteria values are supported in content metadata mapping. // CustomTargetingError_ReasonCANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING CustomTargetingError_Reason = "CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING" // // Cannot delete a custom criteria key that is targeted by an active partner assignment. // CustomTargetingError_ReasonCANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING CustomTargetingError_Reason = "CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING" // // Cannot delete a custom criteria value that is targeted by an active partner assignment. // CustomTargetingError_ReasonCANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING CustomTargetingError_Reason = "CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING" // // {@link AudienceSegment} object cannot be targeted. // CustomTargetingError_ReasonCANNOT_TARGET_AUDIENCE_SEGMENT CustomTargetingError_Reason = "CANNOT_TARGET_AUDIENCE_SEGMENT" // // Third party {@link AudienceSegment} cannot be targeted. // CustomTargetingError_ReasonCANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT CustomTargetingError_Reason = "CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT" // // Inactive {@link AudienceSegment} object cannot be targeted. // CustomTargetingError_ReasonCANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT CustomTargetingError_Reason = "CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT" // // Targeted {@link AudienceSegment} object is not valid. // CustomTargetingError_ReasonINVALID_AUDIENCE_SEGMENTS CustomTargetingError_Reason = "INVALID_AUDIENCE_SEGMENTS" // // Mapped metadata key-values are deprecated and cannot be targeted. // CustomTargetingError_ReasonCANNOT_TARGET_MAPPED_METADATA CustomTargetingError_Reason = "CANNOT_TARGET_MAPPED_METADATA" // // Targeted {@link AudienceSegment} objects have not been approved. // CustomTargetingError_ReasonONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED CustomTargetingError_Reason = "ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED" // // The value returned if the actual value is not exposed by the requested API version. // CustomTargetingError_ReasonUNKNOWN CustomTargetingError_Reason = "UNKNOWN" )
type DateError ¶
type DateError struct { *ApiError Reason *DateError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type DateError_Reason ¶
type DateError_Reason string
const ( DateError_ReasonDATE_IN_PAST DateError_Reason = "DATE_IN_PAST" DateError_ReasonSTART_DATE_AFTER_END_DATE DateError_Reason = "START_DATE_AFTER_END_DATE" DateError_ReasonEND_DATE_BEFORE_START_DATE DateError_Reason = "END_DATE_BEFORE_START_DATE" DateError_ReasonNOT_CERTAIN_DAY_OF_MONTH DateError_Reason = "NOT_CERTAIN_DAY_OF_MONTH" DateError_ReasonINVALID_DATES DateError_Reason = "INVALID_DATES" // // The value returned if the actual value is not exposed by the requested API version. // DateError_ReasonUNKNOWN DateError_Reason = "UNKNOWN" )
type DateRange ¶
type DateRange struct { // // The start date of this range. This field is optional and if it is not set then there is no // lower bound on the date range. If this field is not set then {@code endDate} must be specified. // StartDate soap.XSDDate `xml:"startDate,omitempty" json:"startDate,omitempty"` // // The end date of this range. This field is optional and if it is not set then there is no upper // bound on the date range. If this field is not set then {@code startDate} must be specified. // EndDate soap.XSDDate `xml:"endDate,omitempty" json:"endDate,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 DateTimeRange ¶
type DateTimeRange struct { // // The start date time of this range. This field is optional and if it is not set then there is no // lower bound on the date time range. If this field is not set then {@code endDateTime} must be // specified. // StartDateTime soap.XSDDateTime `xml:"startDateTime,omitempty" json:"startDateTime,omitempty"` // // The end date time of this range. This field is optional and if it is not set then there is no // upper bound on the date time range. If this field is not set then {@code startDateTime} must be // specified. // EndDateTime soap.XSDDateTime `xml:"endDateTime,omitempty" json:"endDateTime,omitempty"` }
type DateTimeRangeTargeting ¶
type DateTimeRangeTargeting struct {
TargetedDateTimeRanges []*DateTimeRange `xml:"targetedDateTimeRanges,omitempty" json:"targetedDateTimeRanges,omitempty"`
}
type DateTimeRangeTargetingError ¶
type DateTimeRangeTargetingError struct { *ApiError // // The error reason represented by an enum. // Reason *DateTimeRangeTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type DateTimeRangeTargetingError_Reason ¶
type DateTimeRangeTargetingError_Reason string
const ( // // No targeted ranges exists. // DateTimeRangeTargetingError_ReasonEMPTY_RANGES DateTimeRangeTargetingError_Reason = "EMPTY_RANGES" // // Type of lineitem is not sponsorship. // DateTimeRangeTargetingError_ReasonNOT_SPONSORSHIP_LINEITEM DateTimeRangeTargetingError_Reason = "NOT_SPONSORSHIP_LINEITEM" // // Type of lineitem is not sponsorship or standard. // DateTimeRangeTargetingError_ReasonNOT_SPONSORSHIP_OR_STANDARD_LINEITEM DateTimeRangeTargetingError_Reason = "NOT_SPONSORSHIP_OR_STANDARD_LINEITEM" // // Line item must have a reservation type of sponsorship, standard or preferred deal to use date // time range targeting. // DateTimeRangeTargetingError_ReasonUNSUPPORTED_LINEITEM_RESERVATION_TYPE DateTimeRangeTargetingError_Reason = "UNSUPPORTED_LINEITEM_RESERVATION_TYPE" // // Past ranges are changed. // DateTimeRangeTargetingError_ReasonPAST_RANGES_CHANGED DateTimeRangeTargetingError_Reason = "PAST_RANGES_CHANGED" // // Targeted date time ranges overlap. // DateTimeRangeTargetingError_ReasonRANGES_OVERLAP DateTimeRangeTargetingError_Reason = "RANGES_OVERLAP" // // First date time does not match line item's start time. // DateTimeRangeTargetingError_ReasonFIRST_DATE_TIME_DOES_NOT_MATCH_START_TIME DateTimeRangeTargetingError_Reason = "FIRST_DATE_TIME_DOES_NOT_MATCH_START_TIME" // // Last date time does not match line item's end time. // DateTimeRangeTargetingError_ReasonLAST_DATE_TIME_DOES_NOT_MATCH_END_TIME DateTimeRangeTargetingError_Reason = "LAST_DATE_TIME_DOES_NOT_MATCH_END_TIME" // // Targeted date time ranges fall out the active period of lineitem. // DateTimeRangeTargetingError_ReasonRANGES_OUT_OF_LINEITEM_ACTIVE_PERIOD DateTimeRangeTargetingError_Reason = "RANGES_OUT_OF_LINEITEM_ACTIVE_PERIOD" // // Start time of range (except the earliest range) is not at start of day. // Start of day is 00:00:00. // DateTimeRangeTargetingError_ReasonSTART_TIME_IS_NOT_START_OF_DAY DateTimeRangeTargetingError_Reason = "START_TIME_IS_NOT_START_OF_DAY" // // End time of range (except the latest range) is not at end of day. // End of day is 23:59:59. // DateTimeRangeTargetingError_ReasonEND_TIME_IS_NOT_END_OF_DAY DateTimeRangeTargetingError_Reason = "END_TIME_IS_NOT_END_OF_DAY" // // Start date time of earliest targeted ranges is in past. // DateTimeRangeTargetingError_ReasonSTART_DATE_TIME_IS_IN_PAST DateTimeRangeTargetingError_Reason = "START_DATE_TIME_IS_IN_PAST" // // Cannot modify the start date time for date time targeting to the past. // DateTimeRangeTargetingError_ReasonMODIFY_START_DATE_TIME_TO_PAST DateTimeRangeTargetingError_Reason = "MODIFY_START_DATE_TIME_TO_PAST" // // The end time of range is before the start time. // Could happen when start type is IMMEDIATE or ONE_HOUR_LATER. // DateTimeRangeTargetingError_ReasonRANGE_END_TIME_BEFORE_START_TIME DateTimeRangeTargetingError_Reason = "RANGE_END_TIME_BEFORE_START_TIME" // // End date time of latest targeted ranges is too late. // DateTimeRangeTargetingError_ReasonEND_DATE_TIME_IS_TOO_LATE DateTimeRangeTargetingError_Reason = "END_DATE_TIME_IS_TOO_LATE" DateTimeRangeTargetingError_ReasonLIMITED_RANGES_IN_UNLIMITED_LINEITEM DateTimeRangeTargetingError_Reason = "LIMITED_RANGES_IN_UNLIMITED_LINEITEM" // // The value returned if the actual value is not exposed by the requested API version. // DateTimeRangeTargetingError_ReasonUNKNOWN DateTimeRangeTargetingError_Reason = "UNKNOWN" )
type DateTimeValue ¶
type DateTimeValue struct { // // The {@code DateTime} value. // Value soap.XSDDateTime `xml:"value,omitempty" json:"value,omitempty"` // contains filtered or unexported fields }
type DayOfWeek ¶
type DayOfWeek string
const ( // // The day of week named Monday. // DayOfWeekMONDAY DayOfWeek = "MONDAY" // // The day of week named Tuesday. // DayOfWeekTUESDAY DayOfWeek = "TUESDAY" // // The day of week named Wednesday. // DayOfWeekWEDNESDAY DayOfWeek = "WEDNESDAY" // // The day of week named Thursday. // DayOfWeekTHURSDAY DayOfWeek = "THURSDAY" // // The day of week named Friday. // DayOfWeekFRIDAY DayOfWeek = "FRIDAY" // // The day of week named Saturday. // DayOfWeekSATURDAY DayOfWeek = "SATURDAY" // // The day of week named Sunday. // DayOfWeekSUNDAY DayOfWeek = "SUNDAY" )
type DayPart ¶
type DayPart struct { // // Day of the week the target applies to. This field is required. // DayOfWeek *DayOfWeek `xml:"dayOfWeek,omitempty" json:"dayOfWeek,omitempty"` // // Represents the start time of the targeted period (inclusive). // StartTime *TimeOfDay `xml:"startTime,omitempty" json:"startTime,omitempty"` // // Represents the end time of the targeted period (exclusive). // EndTime *TimeOfDay `xml:"endTime,omitempty" json:"endTime,omitempty"` }
type DayPartTargeting ¶
type DayPartTargeting struct { // // Specifies days of the week and times at which a {@code LineItem} will be delivered. // // <p>If targeting all days and times, this value will be ignored. // DayParts []*DayPart `xml:"dayParts,omitempty" json:"dayParts,omitempty"` // // Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is // optional and defaults to {@link DeliveryTimeZone#BROWSER}. // // <p>Setting this has no effect if targeting all days and times. // TimeZone *DeliveryTimeZone `xml:"timeZone,omitempty" json:"timeZone,omitempty"` }
type DayPartTargetingError ¶
type DayPartTargetingError struct { *ApiError // // The error reason represented by an enum. // Reason *DayPartTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type DayPartTargetingError_Reason ¶
type DayPartTargetingError_Reason string
const ( // // Hour of day must be between 0 and 24, inclusive. // DayPartTargetingError_ReasonINVALID_HOUR DayPartTargetingError_Reason = "INVALID_HOUR" // // Minute of hour must be one of 0, 15,30, 45. // DayPartTargetingError_ReasonINVALID_MINUTE DayPartTargetingError_Reason = "INVALID_MINUTE" // // The {@link DayPart#endTime} cannot be after {@link DayPart#startTime}. // DayPartTargetingError_ReasonEND_TIME_NOT_AFTER_START_TIME DayPartTargetingError_Reason = "END_TIME_NOT_AFTER_START_TIME" // // Cannot create day-parts that overlap. // DayPartTargetingError_ReasonTIME_PERIODS_OVERLAP DayPartTargetingError_Reason = "TIME_PERIODS_OVERLAP" // // The value returned if the actual value is not exposed by the requested API version. // DayPartTargetingError_ReasonUNKNOWN DayPartTargetingError_Reason = "UNKNOWN" )
type DeliveryData ¶
type DeliveryData struct { // // Clicks or impressions delivered for the last 7 days. // Units []int64 `xml:"units,omitempty" json:"units,omitempty"` }
type DeliveryForecast ¶
type DeliveryForecast struct { // // The delivery forecasts of the forecasted line items. // LineItemDeliveryForecasts []*LineItemDeliveryForecast `xml:"lineItemDeliveryForecasts,omitempty" json:"lineItemDeliveryForecasts,omitempty"` }
type DeliveryForecastOptions ¶
type DeliveryForecastOptions struct { // // Line item IDs to be ignored while performing the delivery simulation. // IgnoredLineItemIds []int64 `xml:"ignoredLineItemIds,omitempty" json:"ignoredLineItemIds,omitempty"` }
type DeliveryForecastSource ¶
type DeliveryForecastSource string
const ( // // The line item's historical traffic shape will be used to pace line item delivery. // DeliveryForecastSourceHISTORICAL DeliveryForecastSource = "HISTORICAL" // // The line item's projected future traffic will be used to pace line item delivery. // DeliveryForecastSourceFORECASTING DeliveryForecastSource = "FORECASTING" // // A user specified custom pacing curve will be used to pace line item delivery. // DeliveryForecastSourceCUSTOM_PACING_CURVE DeliveryForecastSource = "CUSTOM_PACING_CURVE" // // The value returned if the actual value is not exposed by the requested API version. // DeliveryForecastSourceUNKNOWN DeliveryForecastSource = "UNKNOWN" )
type DeliveryIndicator ¶
type DeliveryIndicator struct { // // How much the {@code LineItem} was expected to deliver as a percentage of // {@link LineItem#primaryGoal}. // ExpectedDeliveryPercentage float64 `xml:"expectedDeliveryPercentage,omitempty" json:"expectedDeliveryPercentage,omitempty"` // // How much the line item actually delivered as a percentage of // {@link LineItem#primaryGoal}. // ActualDeliveryPercentage float64 `xml:"actualDeliveryPercentage,omitempty" json:"actualDeliveryPercentage,omitempty"` }
type DeliveryRateType ¶
type DeliveryRateType string
const ( // // Line items are served as evenly as possible across the number of // days specified in a line item's {@link LineItem#duration}. // DeliveryRateTypeEVENLY DeliveryRateType = "EVENLY" // // Line items are served more aggressively in the beginning of the flight // date. // DeliveryRateTypeFRONTLOADED DeliveryRateType = "FRONTLOADED" // // The booked impressions for a line item may be delivered well before the // {@link LineItem#endDateTime}. Other lower-priority or lower-value line // items will be stopped from delivering until this line item meets the number // of impressions or clicks it is booked for. // DeliveryRateTypeAS_FAST_AS_POSSIBLE DeliveryRateType = "AS_FAST_AS_POSSIBLE" )
type DeliveryTimeZone ¶
type DeliveryTimeZone string
const ( // // Use the time zone of the publisher. // DeliveryTimeZonePUBLISHER DeliveryTimeZone = "PUBLISHER" // // Use the time zone of the browser. // DeliveryTimeZoneBROWSER DeliveryTimeZone = "BROWSER" )
type DeviceCapability ¶
type DeviceCapability struct {
*Technology
}
type DeviceCapabilityTargeting ¶
type DeviceCapabilityTargeting struct { // // Device capabilities that are being targeted by the {@link LineItem}. // TargetedDeviceCapabilities []*Technology `xml:"targetedDeviceCapabilities,omitempty" json:"targetedDeviceCapabilities,omitempty"` // // Device capabilities that are being excluded by the {@link LineItem}. // ExcludedDeviceCapabilities []*Technology `xml:"excludedDeviceCapabilities,omitempty" json:"excludedDeviceCapabilities,omitempty"` }
type DeviceCategory ¶
type DeviceCategory struct {
*Technology
}
type DeviceCategoryTargeting ¶
type DeviceCategoryTargeting struct { // // Device categories that are being targeted by the {@link LineItem}. // TargetedDeviceCategories []*Technology `xml:"targetedDeviceCategories,omitempty" json:"targetedDeviceCategories,omitempty"` // // Device categories that are being excluded by the {@link LineItem}. // ExcludedDeviceCategories []*Technology `xml:"excludedDeviceCategories,omitempty" json:"excludedDeviceCategories,omitempty"` }
type DeviceManufacturer ¶
type DeviceManufacturer struct {
*Technology
}
type DeviceManufacturerTargeting ¶
type DeviceManufacturerTargeting struct { // // Indicates whether device manufacturers should be targeted or excluded. This attribute is // optional and defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // Device manufacturers that are being targeted or excluded by the {@link LineItem}. // DeviceManufacturers []*Technology `xml:"deviceManufacturers,omitempty" json:"deviceManufacturers,omitempty"` }
type DropDownCustomFieldValue ¶
type DropDownCustomFieldValue struct { *BaseCustomFieldValue // // The {@link CustomFieldOption#id ID} of the {@link CustomFieldOption} for this value. // CustomFieldOptionId int64 `xml:"customFieldOptionId,omitempty" json:"customFieldOptionId,omitempty"` }
type EntityChildrenLimitReachedError ¶
type EntityChildrenLimitReachedError struct { *ApiError Reason *EntityChildrenLimitReachedError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type EntityChildrenLimitReachedError_Reason ¶
type EntityChildrenLimitReachedError_Reason string
const ( // // The number of line items on the order exceeds the max number of line items allowed per order // in the network. // EntityChildrenLimitReachedError_ReasonLINE_ITEM_LIMIT_FOR_ORDER_REACHED EntityChildrenLimitReachedError_Reason = "LINE_ITEM_LIMIT_FOR_ORDER_REACHED" // // The number of creatives associated with the line item exceeds the max number of creatives // allowed to be associated with a line item in the network. // EntityChildrenLimitReachedError_ReasonCREATIVE_ASSOCIATION_LIMIT_FOR_LINE_ITEM_REACHED EntityChildrenLimitReachedError_Reason = "CREATIVE_ASSOCIATION_LIMIT_FOR_LINE_ITEM_REACHED" // // The number of ad units on the placement exceeds the max number of ad units // allowed per placement in the network. // EntityChildrenLimitReachedError_ReasonAD_UNIT_LIMIT_FOR_PLACEMENT_REACHED EntityChildrenLimitReachedError_Reason = "AD_UNIT_LIMIT_FOR_PLACEMENT_REACHED" // // The number of targeting expressions on the line item exceeds the max number of targeting // expressions allowed per line item in the network. // EntityChildrenLimitReachedError_ReasonTARGETING_EXPRESSION_LIMIT_FOR_LINE_ITEM_REACHED EntityChildrenLimitReachedError_Reason = "TARGETING_EXPRESSION_LIMIT_FOR_LINE_ITEM_REACHED" // // The size of a single targeting expression tree exceeds the max size allowed by the network. // EntityChildrenLimitReachedError_ReasonTARGETING_EXPRESSION_SIZE_LIMIT_REACHED EntityChildrenLimitReachedError_Reason = "TARGETING_EXPRESSION_SIZE_LIMIT_REACHED" // // The number of custom targeting values for the free-form or predefined custom targeting key // exceeds the max number allowed. // EntityChildrenLimitReachedError_ReasonCUSTOM_TARGETING_VALUES_FOR_KEY_LIMIT_REACHED EntityChildrenLimitReachedError_Reason = "CUSTOM_TARGETING_VALUES_FOR_KEY_LIMIT_REACHED" // // The total number of targeting expressions on the creatives for the line item exceeds // the max number allowed per line item in the network. // EntityChildrenLimitReachedError_ReasonTARGETING_EXPRESSION_LIMIT_FOR_CREATIVES_ON_LINE_ITEM_REACHED EntityChildrenLimitReachedError_Reason = "TARGETING_EXPRESSION_LIMIT_FOR_CREATIVES_ON_LINE_ITEM_REACHED" // // The number of attachments added to the proposal exceeds the max number // allowed per proposal in the network. // EntityChildrenLimitReachedError_ReasonATTACHMENT_LIMIT_FOR_PROPOSAL_REACHED EntityChildrenLimitReachedError_Reason = "ATTACHMENT_LIMIT_FOR_PROPOSAL_REACHED" // // The number of proposal line items on the proposal exceeds the max number // allowed per proposal in the network. // EntityChildrenLimitReachedError_ReasonPROPOSAL_LINE_ITEM_LIMIT_FOR_PROPOSAL_REACHED EntityChildrenLimitReachedError_Reason = "PROPOSAL_LINE_ITEM_LIMIT_FOR_PROPOSAL_REACHED" // // The number of product package items on the product package exceeds the max number // allowed per product package in the network. // EntityChildrenLimitReachedError_ReasonPRODUCT_LIMIT_FOR_PRODUCT_PACKAGE_REACHED EntityChildrenLimitReachedError_Reason = "PRODUCT_LIMIT_FOR_PRODUCT_PACKAGE_REACHED" // // The number of product template and product base rates on the rate card (including excluded // product base rates) exceeds the max number allowed per rate card in the network. // EntityChildrenLimitReachedError_ReasonPRODUCT_TEMPLATE_AND_PRODUCT_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED EntityChildrenLimitReachedError_Reason = "PRODUCT_TEMPLATE_AND_PRODUCT_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED" // // The number of product package item base rates on the rate card exceeds the max number // allowed per rate card in the network. // EntityChildrenLimitReachedError_ReasonPRODUCT_PACKAGE_ITEM_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED EntityChildrenLimitReachedError_Reason = "PRODUCT_PACKAGE_ITEM_BASE_RATE_LIMIT_FOR_RATE_CARD_REACHED" // // The number of premiums of the rate card exceeds the max number allowed per rate card // in the network. // EntityChildrenLimitReachedError_ReasonPREMIUM_LIMIT_FOR_RATE_CARD_REACHED EntityChildrenLimitReachedError_Reason = "PREMIUM_LIMIT_FOR_RATE_CARD_REACHED" // // The number of ad units on {@link AdExclusionRule#inventoryTargeting} exceeds the max number // of ad units allowed per ad exclusion rule inventory targeting in the network. // EntityChildrenLimitReachedError_ReasonAD_UNIT_LIMIT_FOR_AD_EXCLUSION_RULE_TARGETING_REACHED EntityChildrenLimitReachedError_Reason = "AD_UNIT_LIMIT_FOR_AD_EXCLUSION_RULE_TARGETING_REACHED" // // The number of native styles under the native creative template exceeds the // max number of native styles allowed per native creative template in the // network. // EntityChildrenLimitReachedError_ReasonNATIVE_STYLE_LIMIT_FOR_NATIVE_AD_FORMAT_REACHED EntityChildrenLimitReachedError_Reason = "NATIVE_STYLE_LIMIT_FOR_NATIVE_AD_FORMAT_REACHED" // // The number of targeting expressions on the native style exceeds the max number of targeting // expressions allowed per native style in the network. // EntityChildrenLimitReachedError_ReasonTARGETING_EXPRESSION_LIMIT_FOR_PRESENTATION_ASSIGNMENT_REACHED EntityChildrenLimitReachedError_Reason = "TARGETING_EXPRESSION_LIMIT_FOR_PRESENTATION_ASSIGNMENT_REACHED" // // The value returned if the actual value is not exposed by the requested API version. // EntityChildrenLimitReachedError_ReasonUNKNOWN EntityChildrenLimitReachedError_Reason = "UNKNOWN" )
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 EnvironmentType ¶
type EnvironmentType string
const ( // // A regular web browser. // EnvironmentTypeBROWSER EnvironmentType = "BROWSER" // // Video players. // EnvironmentTypeVIDEO_PLAYER EnvironmentType = "VIDEO_PLAYER" )
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 ForecastBreakdown ¶
type ForecastBreakdown struct { // // The starting time of the represented breakdown. // StartTime soap.XSDDateTime `xml:"startTime,omitempty" json:"startTime,omitempty"` // // The end time of the represented breakdown. // EndTime soap.XSDDateTime `xml:"endTime,omitempty" json:"endTime,omitempty"` // // The forecast breakdown entries in the same order as in the {@link // ForecastBreakdownOptions#targets} field. // BreakdownEntries []*ForecastBreakdownEntry `xml:"breakdownEntries,omitempty" json:"breakdownEntries,omitempty"` }
type ForecastBreakdownEntry ¶
type ForecastBreakdownEntry struct { // // The optional name of this entry, as specified in the corresponding {@link // ForecastBreakdownTarget#name} field. // Name string `xml:"name,omitempty" json:"name,omitempty"` // // The forecast of this entry. // Forecast *BreakdownForecast `xml:"forecast,omitempty" json:"forecast,omitempty"` }
type ForecastBreakdownOptions ¶
type ForecastBreakdownOptions struct { // // The boundaries of time windows to configure time breakdown. // // <p>By default, the time window of the forecasted {@link LineItem} is assumed if none are // explicitly specified in this field. But if set, at least two {@link DateTime}s are needed to // define the boundaries of minimally one time window. // // <p>Also, the time boundaries are required to be in the same time zone, in strictly ascending // order. // TimeWindows []soap.XSDDateTime `xml:"timeWindows,omitempty" json:"timeWindows,omitempty"` // // For each time window, these are the breakdown targets. If none specified, the targeting of the // forecasted {@link LineItem} is assumed. // Targets []*ForecastBreakdownTarget `xml:"targets,omitempty" json:"targets,omitempty"` }
type ForecastBreakdownTarget ¶
type ForecastBreakdownTarget struct { // // An optional name for this breakdown target, to be populated in the corresponding {@link // ForecastBreakdownEntry#name} field. // Name string `xml:"name,omitempty" json:"name,omitempty"` // // If specified, the targeting for this breakdown. // Targeting *Targeting `xml:"targeting,omitempty" json:"targeting,omitempty"` // // If specified, restrict the breakdown to only inventory matching this creative. // Creative *CreativePlaceholder `xml:"creative,omitempty" json:"creative,omitempty"` }
type ForecastError ¶
type ForecastError struct { *ApiError // // The reason for the forecast error. // Reason *ForecastError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type ForecastError_Reason ¶
type ForecastError_Reason string
const ( // // The forecast could not be retrieved due to a server side // connection problem. Please try again soon. // ForecastError_ReasonSERVER_NOT_AVAILABLE ForecastError_Reason = "SERVER_NOT_AVAILABLE" // // There was an unexpected internal error. // ForecastError_ReasonINTERNAL_ERROR ForecastError_Reason = "INTERNAL_ERROR" // // The forecast could not be retrieved because there is not // enough forecasting data available yet. It may take up to one week before // enough data is available. // ForecastError_ReasonNO_FORECAST_YET ForecastError_Reason = "NO_FORECAST_YET" // // There's not enough inventory for the requested reservation. // ForecastError_ReasonNOT_ENOUGH_INVENTORY ForecastError_Reason = "NOT_ENOUGH_INVENTORY" // // No error from forecast. // ForecastError_ReasonSUCCESS ForecastError_Reason = "SUCCESS" // // The requested reservation is of zero length. No forecast is returned. // ForecastError_ReasonZERO_LENGTH_RESERVATION ForecastError_Reason = "ZERO_LENGTH_RESERVATION" // // 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 2 per second. // Once again this does not guarantee that every request will succeed, but // may help reduce the number of times you receive this error. // </p> // ForecastError_ReasonEXCEEDED_QUOTA ForecastError_Reason = "EXCEEDED_QUOTA" // // The request falls outside the date range of the available data. // ForecastError_ReasonOUTSIDE_AVAILABLE_DATE_RANGE ForecastError_Reason = "OUTSIDE_AVAILABLE_DATE_RANGE" // // The value returned if the actual value is not exposed by the requested API version. // ForecastError_ReasonUNKNOWN ForecastError_Reason = "UNKNOWN" )
type ForecastServiceInterface ¶
type ForecastServiceInterface interface { // Error can be either of the following types: // // - ApiException /* Gets the availability forecast for a {@link ProspectiveLineItem}. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting. */ GetAvailabilityForecast(request *GetAvailabilityForecast) (*GetAvailabilityForecastResponse, error) GetAvailabilityForecastContext(ctx context.Context, request *GetAvailabilityForecast) (*GetAvailabilityForecastResponse, error) // Error can be either of the following types: // // - ApiException /* Gets an {@link AvailabilityForecast} for an existing {@link LineItem} object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting. <p>Only line items having type {@link LineItemType#SPONSORSHIP} or {@link LineItemType#STANDARD} are valid. Other types will result in {@link ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED}. */ GetAvailabilityForecastById(request *GetAvailabilityForecastById) (*GetAvailabilityForecastByIdResponse, error) GetAvailabilityForecastByIdContext(ctx context.Context, request *GetAvailabilityForecastById) (*GetAvailabilityForecastByIdResponse, error) // Error can be either of the following types: // // - ApiException /* Gets the delivery forecast for a list of {@link ProspectiveLineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. */ GetDeliveryForecast(request *GetDeliveryForecast) (*GetDeliveryForecastResponse, error) GetDeliveryForecastContext(ctx context.Context, request *GetDeliveryForecast) (*GetDeliveryForecastResponse, error) // Error can be either of the following types: // // - ApiException /* Gets the delivery forecast for a list of existing {@link LineItem} objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. */ GetDeliveryForecastByIds(request *GetDeliveryForecastByIds) (*GetDeliveryForecastByIdsResponse, error) GetDeliveryForecastByIdsContext(ctx context.Context, request *GetDeliveryForecastByIds) (*GetDeliveryForecastByIdsResponse, error) // Error can be either of the following types: // // - ApiException /* Returns forecasted and historical traffic data for the segment of traffic specified by the provided request. <p>Calling this endpoint programmatically is only available for Ad Manager 360 networks. */ GetTrafficData(request *GetTrafficData) (*GetTrafficDataResponse, error) GetTrafficDataContext(ctx context.Context, request *GetTrafficData) (*GetTrafficDataResponse, error) }
func NewForecastServiceInterface ¶
func NewForecastServiceInterface(client *soap.Client) ForecastServiceInterface
type FrequencyCap ¶
type FrequencyCap struct { // // The maximum number of impressions than can be served to a user within a specified time period. // MaxImpressions int32 `xml:"maxImpressions,omitempty" json:"maxImpressions,omitempty"` // // The number of {@code FrequencyCap#timeUnit} to represent the total time period. // NumTimeUnits int32 `xml:"numTimeUnits,omitempty" json:"numTimeUnits,omitempty"` // // The unit of time for specifying the time period. // TimeUnit *TimeUnit `xml:"timeUnit,omitempty" json:"timeUnit,omitempty"` }
type FrequencyCapError ¶
type FrequencyCapError struct { *ApiError // // The error reason represented by an enum. // Reason *FrequencyCapError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type FrequencyCapError_Reason ¶
type FrequencyCapError_Reason string
const ( FrequencyCapError_ReasonIMPRESSION_LIMIT_EXCEEDED FrequencyCapError_Reason = "IMPRESSION_LIMIT_EXCEEDED" FrequencyCapError_ReasonIMPRESSIONS_TOO_LOW FrequencyCapError_Reason = "IMPRESSIONS_TOO_LOW" FrequencyCapError_ReasonRANGE_LIMIT_EXCEEDED FrequencyCapError_Reason = "RANGE_LIMIT_EXCEEDED" FrequencyCapError_ReasonRANGE_TOO_LOW FrequencyCapError_Reason = "RANGE_TOO_LOW" FrequencyCapError_ReasonDUPLICATE_TIME_RANGE FrequencyCapError_Reason = "DUPLICATE_TIME_RANGE" FrequencyCapError_ReasonTOO_MANY_FREQUENCY_CAPS FrequencyCapError_Reason = "TOO_MANY_FREQUENCY_CAPS" // // The value returned if the actual value is not exposed by the requested API version. // FrequencyCapError_ReasonUNKNOWN FrequencyCapError_Reason = "UNKNOWN" )
type GenericTargetingError ¶
type GenericTargetingError struct { *ApiError Reason *GenericTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type GenericTargetingError_Reason ¶
type GenericTargetingError_Reason string
const ( // // Both including and excluding sibling criteria is disallowed. // GenericTargetingError_ReasonCONFLICTING_INCLUSION_OR_EXCLUSION_OF_SIBLINGS GenericTargetingError_Reason = "CONFLICTING_INCLUSION_OR_EXCLUSION_OF_SIBLINGS" // // Including descendants of excluded criteria is disallowed. // GenericTargetingError_ReasonINCLUDING_DESCENDANTS_OF_EXCLUDED_CRITERIA GenericTargetingError_Reason = "INCLUDING_DESCENDANTS_OF_EXCLUDED_CRITERIA" // // The value returned if the actual value is not exposed by the requested API version. // GenericTargetingError_ReasonUNKNOWN GenericTargetingError_Reason = "UNKNOWN" )
type GeoTargeting ¶
type GeoTargeting struct { // // The geographical locations being targeted by the {@link LineItem}. // TargetedLocations []*Location `xml:"targetedLocations,omitempty" json:"targetedLocations,omitempty"` // // The geographical locations being excluded by the {@link LineItem}. // ExcludedLocations []*Location `xml:"excludedLocations,omitempty" json:"excludedLocations,omitempty"` }
type GeoTargetingError ¶
type GeoTargetingError struct { *ApiError // // The error reason represented by an enum. // Reason *GeoTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type GeoTargetingError_Reason ¶
type GeoTargetingError_Reason string
const ( // // A location that is targeted cannot also be excluded. // GeoTargetingError_ReasonTARGETED_LOCATIONS_NOT_EXCLUDABLE GeoTargetingError_Reason = "TARGETED_LOCATIONS_NOT_EXCLUDABLE" // // Excluded locations cannot have any of their children targeted. // GeoTargetingError_ReasonEXCLUDED_LOCATIONS_CANNOT_HAVE_CHILDREN_TARGETED GeoTargetingError_Reason = "EXCLUDED_LOCATIONS_CANNOT_HAVE_CHILDREN_TARGETED" // // Postal codes cannot be excluded. // GeoTargetingError_ReasonPOSTAL_CODES_CANNOT_BE_EXCLUDED GeoTargetingError_Reason = "POSTAL_CODES_CANNOT_BE_EXCLUDED" // // Indicates that location targeting is not allowed. // GeoTargetingError_ReasonUNTARGETABLE_LOCATION GeoTargetingError_Reason = "UNTARGETABLE_LOCATION" // // The value returned if the actual value is not exposed by the requested API version. // GeoTargetingError_ReasonUNKNOWN GeoTargetingError_Reason = "UNKNOWN" )
type GetAvailabilityForecast ¶
type GetAvailabilityForecast struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getAvailabilityForecast"` LineItem *ProspectiveLineItem `xml:"lineItem,omitempty" json:"lineItem,omitempty"` ForecastOptions *AvailabilityForecastOptions `xml:"forecastOptions,omitempty" json:"forecastOptions,omitempty"` }
type GetAvailabilityForecastById ¶
type GetAvailabilityForecastById struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getAvailabilityForecastById"` LineItemId int64 `xml:"lineItemId,omitempty" json:"lineItemId,omitempty"` ForecastOptions *AvailabilityForecastOptions `xml:"forecastOptions,omitempty" json:"forecastOptions,omitempty"` }
type GetAvailabilityForecastByIdResponse ¶
type GetAvailabilityForecastByIdResponse struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getAvailabilityForecastByIdResponse"` Rval *AvailabilityForecast `xml:"rval,omitempty" json:"rval,omitempty"` }
type GetAvailabilityForecastResponse ¶
type GetAvailabilityForecastResponse struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getAvailabilityForecastResponse"` Rval *AvailabilityForecast `xml:"rval,omitempty" json:"rval,omitempty"` }
type GetDeliveryForecast ¶
type GetDeliveryForecast struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getDeliveryForecast"` LineItems []*ProspectiveLineItem `xml:"lineItems,omitempty" json:"lineItems,omitempty"` ForecastOptions *DeliveryForecastOptions `xml:"forecastOptions,omitempty" json:"forecastOptions,omitempty"` }
type GetDeliveryForecastByIds ¶
type GetDeliveryForecastByIds struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getDeliveryForecastByIds"` LineItemIds []int64 `xml:"lineItemIds,omitempty" json:"lineItemIds,omitempty"` ForecastOptions *DeliveryForecastOptions `xml:"forecastOptions,omitempty" json:"forecastOptions,omitempty"` }
type GetDeliveryForecastByIdsResponse ¶
type GetDeliveryForecastByIdsResponse struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getDeliveryForecastByIdsResponse"` Rval *DeliveryForecast `xml:"rval,omitempty" json:"rval,omitempty"` }
type GetDeliveryForecastResponse ¶
type GetDeliveryForecastResponse struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getDeliveryForecastResponse"` Rval *DeliveryForecast `xml:"rval,omitempty" json:"rval,omitempty"` }
type GetTrafficData ¶
type GetTrafficData struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getTrafficData"` TrafficDataRequest *TrafficDataRequest `xml:"trafficDataRequest,omitempty" json:"trafficDataRequest,omitempty"` }
type GetTrafficDataResponse ¶
type GetTrafficDataResponse struct { XMLName xml.Name `xml:"https://www.google.com/apis/ads/publisher/v202311 getTrafficDataResponse"` Rval *TrafficDataResponse `xml:"rval,omitempty" json:"rval,omitempty"` }
type Goal ¶
type Goal struct { // // The type of the goal for the {@code LineItem}. It defines the period over which the goal for // {@code LineItem} should be reached. // GoalType *GoalType `xml:"goalType,omitempty" json:"goalType,omitempty"` // // The type of the goal unit for the {@code LineItem}. // UnitType *UnitType `xml:"unitType,omitempty" json:"unitType,omitempty"` // // If this is a primary goal, it represents the number or percentage of impressions or clicks that // will be reserved for the {@code LineItem}. If the line item is of type {@link // LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If // the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it // represents the number of remaining impressions reserved. If the line item is of type {@link // LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining // impressions reserved. // // <p>If this is a secondary goal, it represents the number of impressions or conversions that the // line item will stop serving at if reached. For valid line item types, see {@link // LineItem#secondaryGoals}. // Units int64 `xml:"units,omitempty" json:"units,omitempty"` }
type GoalType ¶
type GoalType string
const ( // // No goal is specified for the number of ads delivered. The // {@link LineItem#lineItemType} must be one of: // <ul> // <li>{@link LineItemType#PRICE_PRIORITY}</li> // <li>{@link LineItemType#AD_EXCHANGE}</li> // <li>{@link LineItemType#CLICK_TRACKING}</li> // </ul> // GoalTypeNONE GoalType = "NONE" // // There is a goal on the number of ads delivered for this line item during // its entire lifetime. The {@link LineItem#lineItemType} must be // one of: // <ul> // <li>{@link LineItemType#STANDARD}</li> // <li>{@link LineItemType#BULK}</li> // <li>{@link LineItemType#PRICE_PRIORITY}</li> // <li>{@link LineItemType#ADSENSE}</li> // <li>{@link LineItemType#AD_EXCHANGE}</li> // <li>{@link LineItemType#ADMOB}</li> // <li>{@link LineItemType#CLICK_TRACKING}</li> // </ul> // GoalTypeLIFETIME GoalType = "LIFETIME" // // There is a daily goal on the number of ads delivered for this line item. // The {@link LineItem#lineItemType} must be one of: // <ul> // <li>{@link LineItemType#SPONSORSHIP}</li> // <li>{@link LineItemType#NETWORK}</li> // <li>{@link LineItemType#PRICE_PRIORITY}</li> // <li>{@link LineItemType#HOUSE}</li> // <li>{@link LineItemType#ADSENSE}</li> // <li>{@link LineItemType#AD_EXCHANGE}</li> // <li>{@link LineItemType#ADMOB}</li> // <li>{@link LineItemType#BUMPER}</li> // </ul> // GoalTypeDAILY GoalType = "DAILY" // // The value returned if the actual value is not exposed by the requested API version. // GoalTypeUNKNOWN GoalType = "UNKNOWN" )
type GrpProvider ¶
type GrpProvider string
const ( // // The value returned if the actual value is not exposed by the requested API version. // GrpProviderUNKNOWN GrpProvider = "UNKNOWN" GrpProviderNIELSEN GrpProvider = "NIELSEN" // // Renamed to {@code GOOGLE} beginning in V201608. // GrpProviderGOOGLE GrpProvider = "GOOGLE" )
type GrpSettings ¶
type GrpSettings struct { // // Specifies the minimum target age (in years) of the {@link LineItem}. This field is only // applicable if {@link #provider} is not null. // MinTargetAge int64 `xml:"minTargetAge,omitempty" json:"minTargetAge,omitempty"` // // Specifies the maximum target age (in years) of the {@link LineItem}. This field is only // applicable if {@link #provider} is not null. // MaxTargetAge int64 `xml:"maxTargetAge,omitempty" json:"maxTargetAge,omitempty"` // // Specifies the target gender of the {@link LineItem}. This field is only applicable if {@link // #provider} is not null. // TargetGender *GrpTargetGender `xml:"targetGender,omitempty" json:"targetGender,omitempty"` // // Specifies the GRP provider of the {@link LineItem}. // Provider *GrpProvider `xml:"provider,omitempty" json:"provider,omitempty"` // // Specifies the impression goal for the given target demographic. This field is only applicable // if {@link #provider} is not null and demographics-based goal is selected by the user. If this // field is set, {@link LineItem#primaryGoal} will have its {@link Goal#units} value set by Google // to represent the estimated total quantity. // TargetImpressionGoal int64 `xml:"targetImpressionGoal,omitempty" json:"targetImpressionGoal,omitempty"` // // Estimate for the in-target ratio given the line item's audience targeting. This field is only // applicable if {@link #provider} is Nielsen, {@link LineItem#primaryGoal#unitType} is in-target // impressions, and {@link LineItem#CostType} is in-target CPM. This field determines the // in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is // available. Represented as a milli percent, so 55.7% becomes 55700. // InTargetRatioEstimateMilliPercent int64 `xml:"inTargetRatioEstimateMilliPercent,omitempty" json:"inTargetRatioEstimateMilliPercent,omitempty"` // // Specifies which pacing computation to apply in pacing to impressions from connected devices. // This field is required if {@code enableNielsenCoViewingSupport} is true. // NielsenCtvPacingType *NielsenCtvPacingType `xml:"nielsenCtvPacingType,omitempty" json:"nielsenCtvPacingType,omitempty"` // // Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing. // PacingDeviceCategorizationType *PacingDeviceCategorizationType `xml:"pacingDeviceCategorizationType,omitempty" json:"pacingDeviceCategorizationType,omitempty"` ApplyTrueCoview bool `xml:"applyTrueCoview,omitempty" json:"applyTrueCoview,omitempty"` }
type GrpSettingsError ¶
type GrpSettingsError struct { *ApiError // // The error reason represented by an enum. // Reason *GrpSettingsError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type GrpSettingsError_Reason ¶
type GrpSettingsError_Reason string
const ( // // Age range for GRP audience is not valid. Please see the // <a href="https://support.google.com/admanager/answer/6135438">Ad Manager Help Center</a> // for more information. // GrpSettingsError_ReasonINVALID_AGE_RANGE GrpSettingsError_Reason = "INVALID_AGE_RANGE" // // Age range for GRP audience is not allowed to include ages under 18 unless designating all // ages in target(2-65+). // GrpSettingsError_ReasonUNDER_18_MIN_AGE_REQUIRES_ALL_AGES GrpSettingsError_Reason = "UNDER_18_MIN_AGE_REQUIRES_ALL_AGES" // // GRP settings are only supported for video line items. // GrpSettingsError_ReasonLINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED GrpSettingsError_Reason = "LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED" // // For deals with Nielsen DAR enabled, there must be an instream video environment. // GrpSettingsError_ReasonNIELSEN_DAR_REQUIRES_INSTREAM_VIDEO GrpSettingsError_Reason = "NIELSEN_DAR_REQUIRES_INSTREAM_VIDEO" // // GRP settings are not supported for the given line item type. // GrpSettingsError_ReasonLINE_ITEM_TYPE_NOT_SUPPORTED GrpSettingsError_Reason = "LINE_ITEM_TYPE_NOT_SUPPORTED" // // GRP audience gender cannot be specified for the selected age range. // GrpSettingsError_ReasonCANNOT_SPECIFY_GENDER_FOR_GIVEN_AGE_RANGE GrpSettingsError_Reason = "CANNOT_SPECIFY_GENDER_FOR_GIVEN_AGE_RANGE" // // Minimum age for GRP audience is not valid. // GrpSettingsError_ReasonINVALID_MIN_AGE GrpSettingsError_Reason = "INVALID_MIN_AGE" // // Maximum age for GRP audience is not valid. // GrpSettingsError_ReasonINVALID_MAX_AGE GrpSettingsError_Reason = "INVALID_MAX_AGE" // // GRP settings cannot be disabled. // GrpSettingsError_ReasonCANNOT_DISABLE_GRP_AFTER_ENABLING GrpSettingsError_Reason = "CANNOT_DISABLE_GRP_AFTER_ENABLING" // // GRP provider cannot be updated. // GrpSettingsError_ReasonCANNOT_CHANGE_GRP_PROVIDERS GrpSettingsError_Reason = "CANNOT_CHANGE_GRP_PROVIDERS" // // GRP settings cannot be updated once the line item has started serving. // GrpSettingsError_ReasonCANNOT_CHANGE_GRP_SETTINGS GrpSettingsError_Reason = "CANNOT_CHANGE_GRP_SETTINGS" // // Impression goal based on GRP audience is not supported. // GrpSettingsError_ReasonGRP_AUDIENCE_GOAL_NOT_SUPPORTED GrpSettingsError_Reason = "GRP_AUDIENCE_GOAL_NOT_SUPPORTED" // // Impression goal based on GRP audience expected. // GrpSettingsError_ReasonDEMOG_GOAL_EXPECTED GrpSettingsError_Reason = "DEMOG_GOAL_EXPECTED" // // Impression goal based on GRP audience cannot be set once the line item has started serving. // GrpSettingsError_ReasonCANNOT_SET_GRP_AUDIENCE_GOAL GrpSettingsError_Reason = "CANNOT_SET_GRP_AUDIENCE_GOAL" // // Impression goal based on GRP audience cannot be removed once the line item has started // serving. // GrpSettingsError_ReasonCANNOT_REMOVE_GRP_AUDIENCE_GOAL GrpSettingsError_Reason = "CANNOT_REMOVE_GRP_AUDIENCE_GOAL" // // Unsupported geographic location targeted for line item with GRP audience goal. // GrpSettingsError_ReasonUNSUPPORTED_GEO_TARGETING GrpSettingsError_Reason = "UNSUPPORTED_GEO_TARGETING" // // GRP Settings specified are unsupported. // GrpSettingsError_ReasonUNSUPPORTED_GRP_SETTING GrpSettingsError_Reason = "UNSUPPORTED_GRP_SETTING" // // In-target line items should be set through the grpSettings target impression goal. // GrpSettingsError_ReasonSHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS GrpSettingsError_Reason = "SHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS" // // In-target line items should be set through the primaryReservationUnit's in-target Impressions // unit type. // GrpSettingsError_ReasonSHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL GrpSettingsError_Reason = "SHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL" // // Attempt to register with Nielsen failed. // GrpSettingsError_ReasonNIELSEN_REGISTRATION_FAILED GrpSettingsError_Reason = "NIELSEN_REGISTRATION_FAILED" // // Attempted to register a placement on a legacy Nielsen campaign. // GrpSettingsError_ReasonLEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT GrpSettingsError_Reason = "LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT" // // The value returned if the actual value is not exposed by the requested API version. // GrpSettingsError_ReasonUNKNOWN GrpSettingsError_Reason = "UNKNOWN" )
type GrpTargetGender ¶
type GrpTargetGender string
const ( // // The value returned if the actual value is not exposed by the requested API version. // GrpTargetGenderUNKNOWN GrpTargetGender = "UNKNOWN" // // Indicates that the GRP target gender is Male. // GrpTargetGenderMALE GrpTargetGender = "MALE" // // Indicates that the GRP target gender is Female. // GrpTargetGenderFEMALE GrpTargetGender = "FEMALE" // // Indicates that the GRP target gender is both male and female. // GrpTargetGenderBOTH GrpTargetGender = "BOTH" )
type ImageError ¶
type ImageError struct { *ApiError // // The error reason represented by an enum. // Reason *ImageError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type ImageError_Reason ¶
type ImageError_Reason string
const ( // // The file's format is invalid. // ImageError_ReasonINVALID_IMAGE ImageError_Reason = "INVALID_IMAGE" // // {@link Size#width} and {@link Size#height} cannot be negative. // ImageError_ReasonINVALID_SIZE ImageError_Reason = "INVALID_SIZE" // // The actual image size does not match the expected image size. // ImageError_ReasonUNEXPECTED_SIZE ImageError_Reason = "UNEXPECTED_SIZE" // // The size of the asset is larger than that of the overlay creative. // ImageError_ReasonOVERLAY_SIZE_TOO_LARGE ImageError_Reason = "OVERLAY_SIZE_TOO_LARGE" // // Animated images are not allowed. // ImageError_ReasonANIMATED_NOT_ALLOWED ImageError_Reason = "ANIMATED_NOT_ALLOWED" // // Animation length exceeded the allowed policy limit. // ImageError_ReasonANIMATION_TOO_LONG ImageError_Reason = "ANIMATION_TOO_LONG" // // Images in CMYK color formats are not allowed. // ImageError_ReasonCMYK_JPEG_NOT_ALLOWED ImageError_Reason = "CMYK_JPEG_NOT_ALLOWED" // // Flash files are not allowed. // ImageError_ReasonFLASH_NOT_ALLOWED ImageError_Reason = "FLASH_NOT_ALLOWED" // // If {@link FlashCreative#clickTagRequired} is {@code true}, then the flash // file is required to have a click tag embedded in it. // ImageError_ReasonFLASH_WITHOUT_CLICKTAG ImageError_Reason = "FLASH_WITHOUT_CLICKTAG" // // Animated visual effect is not allowed. // ImageError_ReasonANIMATED_VISUAL_EFFECT ImageError_Reason = "ANIMATED_VISUAL_EFFECT" // // An error was encountered in the flash file. // ImageError_ReasonFLASH_ERROR ImageError_Reason = "FLASH_ERROR" // // Incorrect image layout. // ImageError_ReasonLAYOUT_PROBLEM ImageError_Reason = "LAYOUT_PROBLEM" // // Flash files with network objects are not allowed. // ImageError_ReasonFLASH_HAS_NETWORK_OBJECTS ImageError_Reason = "FLASH_HAS_NETWORK_OBJECTS" // // Flash files with network methods are not allowed. // ImageError_ReasonFLASH_HAS_NETWORK_METHODS ImageError_Reason = "FLASH_HAS_NETWORK_METHODS" // // Flash files with hard-coded click thru URLs are not allowed. // ImageError_ReasonFLASH_HAS_URL ImageError_Reason = "FLASH_HAS_URL" // // Flash files with mouse tracking are not allowed. // ImageError_ReasonFLASH_HAS_MOUSE_TRACKING ImageError_Reason = "FLASH_HAS_MOUSE_TRACKING" // // Flash files that generate or use random numbers are not allowed. // ImageError_ReasonFLASH_HAS_RANDOM_NUM ImageError_Reason = "FLASH_HAS_RANDOM_NUM" // // Flash files with self targets are not allowed. // ImageError_ReasonFLASH_SELF_TARGETS ImageError_Reason = "FLASH_SELF_TARGETS" // // Flash file contains a bad geturl target. // ImageError_ReasonFLASH_BAD_GETURL_TARGET ImageError_Reason = "FLASH_BAD_GETURL_TARGET" // // Flash or ActionScript version in the submitted file is not supported. // ImageError_ReasonFLASH_VERSION_NOT_SUPPORTED ImageError_Reason = "FLASH_VERSION_NOT_SUPPORTED" // // The uploaded file is too large. // ImageError_ReasonFILE_TOO_LARGE ImageError_Reason = "FILE_TOO_LARGE" // // A system error occurred, please try again. // ImageError_ReasonSYSTEM_ERROR_IRS ImageError_Reason = "SYSTEM_ERROR_IRS" // // A system error occurred, please try again. // ImageError_ReasonSYSTEM_ERROR_SCS ImageError_Reason = "SYSTEM_ERROR_SCS" // // The image density for a primary asset was not one of the expected image densities. // ImageError_ReasonUNEXPECTED_PRIMARY_ASSET_DENSITY ImageError_Reason = "UNEXPECTED_PRIMARY_ASSET_DENSITY" // // Two or more assets have the same image density. // ImageError_ReasonDUPLICATE_ASSET_DENSITY ImageError_Reason = "DUPLICATE_ASSET_DENSITY" // // The creative does not contain a primary asset. (For high-density creatives, the primary // asset must be a standard image file with 1x density.) // ImageError_ReasonMISSING_DEFAULT_ASSET ImageError_Reason = "MISSING_DEFAULT_ASSET" // // preverified_mime_type is not in the client spec's allowlist. // ImageError_ReasonPREVERIFIED_MIMETYPE_NOT_ALLOWED ImageError_Reason = "PREVERIFIED_MIMETYPE_NOT_ALLOWED" // // The value returned if the actual value is not exposed by the requested API version. // ImageError_ReasonUNKNOWN ImageError_Reason = "UNKNOWN" )
type InternalApiError ¶
type InternalApiError struct { *ApiError // // The error reason represented by an enum. // Reason *InternalApiError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type InternalApiError_Reason ¶
type InternalApiError_Reason string
const ( // // API encountered an unexpected internal error. // InternalApiError_ReasonUNEXPECTED_INTERNAL_API_ERROR InternalApiError_Reason = "UNEXPECTED_INTERNAL_API_ERROR" // // A temporary error occurred during the request. Please retry. // InternalApiError_ReasonTRANSIENT_ERROR InternalApiError_Reason = "TRANSIENT_ERROR" // // The cause of the error is not known or only defined in newer versions. // InternalApiError_ReasonUNKNOWN InternalApiError_Reason = "UNKNOWN" // // The API is currently unavailable for a planned downtime. // InternalApiError_ReasonDOWNTIME InternalApiError_Reason = "DOWNTIME" // // Mutate succeeded but server was unable to build response. Client should not retry mutate. // InternalApiError_ReasonERROR_GENERATING_RESPONSE InternalApiError_Reason = "ERROR_GENERATING_RESPONSE" )
type InvalidUrlError ¶
type InvalidUrlError struct { *ApiError Reason *InvalidUrlError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type InvalidUrlError_Reason ¶
type InvalidUrlError_Reason string
const ( // // The URL contains invalid characters. // InvalidUrlError_ReasonILLEGAL_CHARACTERS InvalidUrlError_Reason = "ILLEGAL_CHARACTERS" // // The format of the URL is not allowed. This could occur for a number of // reasons. For example, if an invalid scheme is specified (like "ftp://") // or if a port is specified when not required, or if a query was specified // when not required. // InvalidUrlError_ReasonINVALID_FORMAT InvalidUrlError_Reason = "INVALID_FORMAT" // // URL contains insecure scheme. // InvalidUrlError_ReasonINSECURE_SCHEME InvalidUrlError_Reason = "INSECURE_SCHEME" // // The URL does not contain a scheme. // InvalidUrlError_ReasonNO_SCHEME InvalidUrlError_Reason = "NO_SCHEME" // // The value returned if the actual value is not exposed by the requested API version. // InvalidUrlError_ReasonUNKNOWN InvalidUrlError_Reason = "UNKNOWN" )
type InventorySizeTargeting ¶
type InventorySizeTargeting struct { // // Whether the inventory sizes should be targeted or excluded. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // A list of {@link TargetedSizeDto}s. // TargetedSizes []*TargetedSize `xml:"targetedSizes,omitempty" json:"targetedSizes,omitempty"` }
type InventoryTargeting ¶
type InventoryTargeting struct { // // A list of targeted {@link AdUnitTargeting}. // TargetedAdUnits []*AdUnitTargeting `xml:"targetedAdUnits,omitempty" json:"targetedAdUnits,omitempty"` // // A list of excluded {@link AdUnitTargeting}. // ExcludedAdUnits []*AdUnitTargeting `xml:"excludedAdUnits,omitempty" json:"excludedAdUnits,omitempty"` // // A list of targeted {@link Placement} ids. // TargetedPlacementIds []int64 `xml:"targetedPlacementIds,omitempty" json:"targetedPlacementIds,omitempty"` }
type InventoryTargetingError ¶
type InventoryTargetingError struct { *ApiError // // The error reason represented by an enum. // Reason *InventoryTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type InventoryTargetingError_Reason ¶
type InventoryTargetingError_Reason string
const ( // // At least one placement or inventory unit is required // InventoryTargetingError_ReasonAT_LEAST_ONE_PLACEMENT_OR_INVENTORY_UNIT_REQUIRED InventoryTargetingError_Reason = "AT_LEAST_ONE_PLACEMENT_OR_INVENTORY_UNIT_REQUIRED" // // The same inventory unit or placement cannot be targeted and excluded at // the same time // InventoryTargetingError_ReasonINVENTORY_CANNOT_BE_TARGETED_AND_EXCLUDED InventoryTargetingError_Reason = "INVENTORY_CANNOT_BE_TARGETED_AND_EXCLUDED" // // A child inventory unit cannot be targeted if its ancestor inventory unit // is also targeted. // InventoryTargetingError_ReasonINVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_TARGETED InventoryTargetingError_Reason = "INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_TARGETED" // // A child inventory unit cannot be targeted if its ancestor inventory unit // is excluded. // InventoryTargetingError_ReasonINVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_EXCLUDED InventoryTargetingError_Reason = "INVENTORY_UNIT_CANNOT_BE_TARGETED_IF_ANCESTOR_IS_EXCLUDED" // // A child inventory unit cannot be excluded if its ancestor inventory unit // is also excluded. // InventoryTargetingError_ReasonINVENTORY_UNIT_CANNOT_BE_EXCLUDED_IF_ANCESTOR_IS_EXCLUDED InventoryTargetingError_Reason = "INVENTORY_UNIT_CANNOT_BE_EXCLUDED_IF_ANCESTOR_IS_EXCLUDED" // // An explicitly targeted inventory unit cannot be targeted. // InventoryTargetingError_ReasonEXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_TARGETED InventoryTargetingError_Reason = "EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_TARGETED" // // An explicitly targeted inventory unit cannot be excluded. // InventoryTargetingError_ReasonEXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_EXCLUDED InventoryTargetingError_Reason = "EXPLICITLY_TARGETED_INVENTORY_UNIT_CANNOT_BE_EXCLUDED" // // A landing page-only ad unit cannot be targeted. // InventoryTargetingError_ReasonSELF_ONLY_INVENTORY_UNIT_NOT_ALLOWED InventoryTargetingError_Reason = "SELF_ONLY_INVENTORY_UNIT_NOT_ALLOWED" // // A landing page-only ad unit cannot be targeted if it doesn't have any // children. // InventoryTargetingError_ReasonSELF_ONLY_INVENTORY_UNIT_WITHOUT_DESCENDANTS InventoryTargetingError_Reason = "SELF_ONLY_INVENTORY_UNIT_WITHOUT_DESCENDANTS" // // Audience segments shared from YouTube can only be targeted with inventory shared // from YouTube for cross selling. // InventoryTargetingError_ReasonYOUTUBE_AUDIENCE_SEGMENTS_CAN_ONLY_BE_TARGETED_WITH_YOUTUBE_SHARED_INVENTORY InventoryTargetingError_Reason = "YOUTUBE_AUDIENCE_SEGMENTS_CAN_ONLY_BE_TARGETED_WITH_YOUTUBE_SHARED_INVENTORY" // // The value returned if the actual value is not exposed by the requested API version. // InventoryTargetingError_ReasonUNKNOWN InventoryTargetingError_Reason = "UNKNOWN" )
type InventoryUnitError ¶
type InventoryUnitError struct { *ApiError Reason *InventoryUnitError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type InventoryUnitError_Reason ¶
type InventoryUnitError_Reason string
const ( // // {@link AdUnit#explicitlyTargeted} can be set to {@code true} only in an // Ad Manager 360 account. // InventoryUnitError_ReasonEXPLICIT_TARGETING_NOT_ALLOWED InventoryUnitError_Reason = "EXPLICIT_TARGETING_NOT_ALLOWED" // // The specified target platform is not applicable for the inventory unit. // InventoryUnitError_ReasonTARGET_PLATFORM_NOT_APPLICABLE InventoryUnitError_Reason = "TARGET_PLATFORM_NOT_APPLICABLE" // // AdSense cannot be enabled on this inventory unit if it is disabled for the network. // InventoryUnitError_ReasonADSENSE_CANNOT_BE_ENABLED InventoryUnitError_Reason = "ADSENSE_CANNOT_BE_ENABLED" // // A root unit cannot be deactivated. // InventoryUnitError_ReasonROOT_UNIT_CANNOT_BE_DEACTIVATED InventoryUnitError_Reason = "ROOT_UNIT_CANNOT_BE_DEACTIVATED" // // The value returned if the actual value is not exposed by the requested API version. // InventoryUnitError_ReasonUNKNOWN InventoryUnitError_Reason = "UNKNOWN" )
type InventoryUrl ¶
type InventoryUrl struct {
Id int64 `xml:"id,omitempty" json:"id,omitempty"`
}
type InventoryUrlTargeting ¶
type InventoryUrlTargeting struct { TargetedUrls []*InventoryUrl `xml:"targetedUrls,omitempty" json:"targetedUrls,omitempty"` ExcludedUrls []*InventoryUrl `xml:"excludedUrls,omitempty" json:"excludedUrls,omitempty"` }
type LabelEntityAssociationError ¶
type LabelEntityAssociationError struct { *ApiError // // The error reason represented by an enum. // Reason *LabelEntityAssociationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type LabelEntityAssociationError_Reason ¶
type LabelEntityAssociationError_Reason string
const ( // // The label has already been attached to the entity. // LabelEntityAssociationError_ReasonDUPLICATE_ASSOCIATION LabelEntityAssociationError_Reason = "DUPLICATE_ASSOCIATION" // // A label is being applied to an entity that does not support that entity // type. // LabelEntityAssociationError_ReasonINVALID_ASSOCIATION LabelEntityAssociationError_Reason = "INVALID_ASSOCIATION" // // Label negation cannot be applied to the entity type. // LabelEntityAssociationError_ReasonNEGATION_NOT_ALLOWED LabelEntityAssociationError_Reason = "NEGATION_NOT_ALLOWED" // // The same label is being applied and negated to the same entity. // LabelEntityAssociationError_ReasonDUPLICATE_ASSOCIATION_WITH_NEGATION LabelEntityAssociationError_Reason = "DUPLICATE_ASSOCIATION_WITH_NEGATION" // // The value returned if the actual value is not exposed by the requested API version. // LabelEntityAssociationError_ReasonUNKNOWN LabelEntityAssociationError_Reason = "UNKNOWN" )
type LineItem ¶
type LineItem struct { *LineItemSummary // // Contains the targeting criteria for the ad campaign. This attribute is required. // Targeting *Targeting `xml:"targeting,omitempty" json:"targeting,omitempty"` // // A list of {@link CreativeTargeting} objects that can be used to specify creative level // targeting for this line item. Creative level targeting is specified in a creative placeholder's // {@link CreativePlaceholder#targetingName} field by referencing the creative targeting's {@link // CreativeTargeting#name name}. It also needs to be re-specified in the {@link // LineItemCreativeAssociation#targetingName} field when associating a line item with a creative // that fits into that placeholder. // CreativeTargetings []*CreativeTargeting `xml:"creativeTargetings,omitempty" json:"creativeTargetings,omitempty"` }
type LineItemActivityAssociation ¶
type LineItemActivityAssociation struct { // // The ID of the {@link Activity} to which the {@link LineItem} should be associated. This // attribute is required. // ActivityId int32 `xml:"activityId,omitempty" json:"activityId,omitempty"` // // The amount of money to attribute per click through conversion. This attribute is required for // creating a {@code LineItemActivityAssociation}. The currency code is readonly and should match // the {@link LineItem}. // ClickThroughConversionCost *Money `xml:"clickThroughConversionCost,omitempty" json:"clickThroughConversionCost,omitempty"` // // The amount of money to attribute per view through conversion. This attribute is required for // creating a {@code LineItemActivityAssociation}. The currency code is readonly and should match // the {@link LineItem}. // ViewThroughConversionCost *Money `xml:"viewThroughConversionCost,omitempty" json:"viewThroughConversionCost,omitempty"` }
type LineItemActivityAssociationError ¶
type LineItemActivityAssociationError struct { *ApiError // // The error reason represented by an enum. // Reason *LineItemActivityAssociationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type LineItemActivityAssociationError_Reason ¶
type LineItemActivityAssociationError_Reason string
const ( // // When associating an activity to a line item the activity must belong to the same // advertiser as the line item. // LineItemActivityAssociationError_ReasonINVALID_ACTIVITY_FOR_ADVERTISER LineItemActivityAssociationError_Reason = "INVALID_ACTIVITY_FOR_ADVERTISER" // // Activities can only be associated with line items of {@link CostType.CPA}. // LineItemActivityAssociationError_ReasonINVALID_COST_TYPE_FOR_ASSOCIATION LineItemActivityAssociationError_Reason = "INVALID_COST_TYPE_FOR_ASSOCIATION" // // The value returned if the actual value is not exposed by the requested API version. // LineItemActivityAssociationError_ReasonUNKNOWN LineItemActivityAssociationError_Reason = "UNKNOWN" )
type LineItemCreativeAssociationError ¶
type LineItemCreativeAssociationError struct { *ApiError // // The error reason represented by an enum. // Reason *LineItemCreativeAssociationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type LineItemCreativeAssociationError_Reason ¶
type LineItemCreativeAssociationError_Reason string
const ( // // Cannot associate a creative to the wrong advertiser // LineItemCreativeAssociationError_ReasonCREATIVE_IN_WRONG_ADVERTISERS_LIBRARY LineItemCreativeAssociationError_Reason = "CREATIVE_IN_WRONG_ADVERTISERS_LIBRARY" // // The creative type being associated is a invalid for the line item type. // LineItemCreativeAssociationError_ReasonINVALID_LINEITEM_CREATIVE_PAIRING LineItemCreativeAssociationError_Reason = "INVALID_LINEITEM_CREATIVE_PAIRING" // // Association start date cannot be before line item start date // LineItemCreativeAssociationError_ReasonSTARTDATE_BEFORE_LINEITEM_STARTDATE LineItemCreativeAssociationError_Reason = "STARTDATE_BEFORE_LINEITEM_STARTDATE" // // Association start date cannot be same as or after line item end date // LineItemCreativeAssociationError_ReasonSTARTDATE_NOT_BEFORE_LINEITEM_ENDDATE LineItemCreativeAssociationError_Reason = "STARTDATE_NOT_BEFORE_LINEITEM_ENDDATE" // // Association end date cannot be after line item end date // LineItemCreativeAssociationError_ReasonENDDATE_AFTER_LINEITEM_ENDDATE LineItemCreativeAssociationError_Reason = "ENDDATE_AFTER_LINEITEM_ENDDATE" // // Association end date cannot be same as or before line item start date // LineItemCreativeAssociationError_ReasonENDDATE_NOT_AFTER_LINEITEM_STARTDATE LineItemCreativeAssociationError_Reason = "ENDDATE_NOT_AFTER_LINEITEM_STARTDATE" // // Association end date cannot be same as or before its start date // LineItemCreativeAssociationError_ReasonENDDATE_NOT_AFTER_STARTDATE LineItemCreativeAssociationError_Reason = "ENDDATE_NOT_AFTER_STARTDATE" // // Association end date cannot be in the past. // LineItemCreativeAssociationError_ReasonENDDATE_IN_THE_PAST LineItemCreativeAssociationError_Reason = "ENDDATE_IN_THE_PAST" // // Cannot copy an association to the same line item without // creating new creative // LineItemCreativeAssociationError_ReasonCANNOT_COPY_WITHIN_SAME_LINE_ITEM LineItemCreativeAssociationError_Reason = "CANNOT_COPY_WITHIN_SAME_LINE_ITEM" // // Programmatic only supports the "Video" redirect type. // LineItemCreativeAssociationError_ReasonUNSUPPORTED_CREATIVE_VAST_REDIRECT_TYPE LineItemCreativeAssociationError_Reason = "UNSUPPORTED_CREATIVE_VAST_REDIRECT_TYPE" // // Programmatic does not support YouTube hosted creatives. // LineItemCreativeAssociationError_ReasonUNSUPPORTED_YOUTUBE_HOSTED_CREATIVE LineItemCreativeAssociationError_Reason = "UNSUPPORTED_YOUTUBE_HOSTED_CREATIVE" // // Programmatic creatives can only be assigned to one line item. // LineItemCreativeAssociationError_ReasonPROGRAMMATIC_CREATIVES_CAN_ONLY_BE_ASSIGNED_TO_ONE_LINE_ITEM LineItemCreativeAssociationError_Reason = "PROGRAMMATIC_CREATIVES_CAN_ONLY_BE_ASSIGNED_TO_ONE_LINE_ITEM" // // Cannot activate a line item creative association if the associated creative is inactive. // LineItemCreativeAssociationError_ReasonCANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE LineItemCreativeAssociationError_Reason = "CANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE" // // Cannot create programmatic creatives. // LineItemCreativeAssociationError_ReasonCANNOT_CREATE_PROGRAMMATIC_CREATIVES LineItemCreativeAssociationError_Reason = "CANNOT_CREATE_PROGRAMMATIC_CREATIVES" // // Cannot update programmatic creatives. // LineItemCreativeAssociationError_ReasonCANNOT_UPDATE_PROGRAMMATIC_CREATIVES LineItemCreativeAssociationError_Reason = "CANNOT_UPDATE_PROGRAMMATIC_CREATIVES" // // Cannot associate a creative with a line item if only one of them is set-top box enabled. // LineItemCreativeAssociationError_ReasonCREATIVE_AND_LINE_ITEM_MUST_BOTH_BE_SET_TOP_BOX_ENABLED LineItemCreativeAssociationError_Reason = "CREATIVE_AND_LINE_ITEM_MUST_BOTH_BE_SET_TOP_BOX_ENABLED" // // Cannot delete associations between set-top box enabled line items and set-top box enabled // creatives. // LineItemCreativeAssociationError_ReasonCANNOT_DELETE_SET_TOP_BOX_ENABLED_ASSOCIATIONS LineItemCreativeAssociationError_Reason = "CANNOT_DELETE_SET_TOP_BOX_ENABLED_ASSOCIATIONS" // // Creative rotation weights must be integers. // LineItemCreativeAssociationError_ReasonSET_TOP_BOX_CREATIVE_ROTATION_WEIGHT_MUST_BE_INTEGER LineItemCreativeAssociationError_Reason = "SET_TOP_BOX_CREATIVE_ROTATION_WEIGHT_MUST_BE_INTEGER" // // Creative rotation weights are only valid when creative rotation type is set to // {@link CreativeRotationType#MANUAL}. // LineItemCreativeAssociationError_ReasonINVALID_CREATIVE_ROTATION_TYPE_FOR_MANUAL_WEIGHT LineItemCreativeAssociationError_Reason = "INVALID_CREATIVE_ROTATION_TYPE_FOR_MANUAL_WEIGHT" // // The code snippet of a creative must contain a click macro // (%%CLICK_URL_ESC%% or %%CLICK_URL_UNESC%%). // LineItemCreativeAssociationError_ReasonCLICK_MACROS_REQUIRED LineItemCreativeAssociationError_Reason = "CLICK_MACROS_REQUIRED" // // The code snippet of a creative must not contain a view macro // (%%VIEW_URL_ESC%% or %%VIEW_URL_UNESC%%). // LineItemCreativeAssociationError_ReasonVIEW_MACROS_NOT_ALLOWED LineItemCreativeAssociationError_Reason = "VIEW_MACROS_NOT_ALLOWED" // // The value returned if the actual value is not exposed by the requested API version. // LineItemCreativeAssociationError_ReasonUNKNOWN LineItemCreativeAssociationError_Reason = "UNKNOWN" )
type LineItemDealInfoDto ¶
type LineItemDealInfoDto struct { // // The external deal ID shared between seller and buyer. This field is only present if the deal // has been finalized. This attribute is read-only and is assigned by Google. // ExternalDealId int64 `xml:"externalDealId,omitempty" json:"externalDealId,omitempty"` }
type LineItemDeliveryForecast ¶
type LineItemDeliveryForecast struct { // // Uniquely identifies this line item delivery forecast. This value is read-only and will be // either the ID of the {@link LineItem} object it represents, or {@code null} if the forecast // represents a prospective line item. // LineItemId int64 `xml:"lineItemId,omitempty" json:"lineItemId,omitempty"` // // The unique ID for the {@link Order} object that this line item belongs to, or {@code null} if // the forecast represents a prospective line item without an {@link LineItem#orderId} set. // OrderId int64 `xml:"orderId,omitempty" json:"orderId,omitempty"` // // The unit with which the goal or cap of the {@link LineItem} is defined. Will be the same value // as {@link Goal#unitType} for both a set line item or a prospective one. // UnitType *UnitType `xml:"unitType,omitempty" json:"unitType,omitempty"` // // The number of units, defined by {@link Goal#unitType}, that will be delivered by the line item. // Delivery of existing line items that are of same or lower priorities may be impacted. // PredictedDeliveryUnits int64 `xml:"predictedDeliveryUnits,omitempty" json:"predictedDeliveryUnits,omitempty"` // // The number of units, defined by {@link Goal#unitType}, that have already been served if the // reservation is already running. // DeliveredUnits int64 `xml:"deliveredUnits,omitempty" json:"deliveredUnits,omitempty"` // // The number of units, defined by {@link Goal#unitType}, that match the specified {@link // LineItem#targeting} and delivery settings. // MatchedUnits int64 `xml:"matchedUnits,omitempty" json:"matchedUnits,omitempty"` }
type LineItemDiscountType ¶
type LineItemDiscountType string
const ( // // An absolute value will be discounted from the line item's cost. // LineItemDiscountTypeABSOLUTE_VALUE LineItemDiscountType = "ABSOLUTE_VALUE" // // A percentage of the cost will be applied as discount for booking the line // item. // LineItemDiscountTypePERCENTAGE LineItemDiscountType = "PERCENTAGE" )
type LineItemError ¶
type LineItemError struct { *ApiError // // The error reason represented by an enum. // Reason *LineItemError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type LineItemError_Reason ¶
type LineItemError_Reason string
const ( // // Some changes may not be allowed because a line item has already started. // LineItemError_ReasonALREADY_STARTED LineItemError_Reason = "ALREADY_STARTED" // // Update reservation is not allowed because a line item has // already started, users must pause the line item first. // LineItemError_ReasonUPDATE_RESERVATION_NOT_ALLOWED LineItemError_Reason = "UPDATE_RESERVATION_NOT_ALLOWED" // // Roadblocking to display all creatives is not allowed. // LineItemError_ReasonALL_ROADBLOCK_NOT_ALLOWED LineItemError_Reason = "ALL_ROADBLOCK_NOT_ALLOWED" // // Companion delivery to display all creatives is not allowed. // LineItemError_ReasonALL_COMPANION_DELIVERY_NOT_ALLOWED LineItemError_Reason = "ALL_COMPANION_DELIVERY_NOT_ALLOWED" // // Roadblocking to display all master and companion creative set is not allowed. // LineItemError_ReasonCREATIVE_SET_ROADBLOCK_NOT_ALLOWED LineItemError_Reason = "CREATIVE_SET_ROADBLOCK_NOT_ALLOWED" // // Fractional percentage is not allowed. // LineItemError_ReasonFRACTIONAL_PERCENTAGE_NOT_ALLOWED LineItemError_Reason = "FRACTIONAL_PERCENTAGE_NOT_ALLOWED" // // For certain LineItem configurations discounts are not allowed. // LineItemError_ReasonDISCOUNT_NOT_ALLOWED LineItemError_Reason = "DISCOUNT_NOT_ALLOWED" // // Updating a canceled line item is not allowed. // LineItemError_ReasonUPDATE_CANCELED_LINE_ITEM_NOT_ALLOWED LineItemError_Reason = "UPDATE_CANCELED_LINE_ITEM_NOT_ALLOWED" // // Updating a pending approval line item is not allowed. // LineItemError_ReasonUPDATE_PENDING_APPROVAL_LINE_ITEM_NOT_ALLOWED LineItemError_Reason = "UPDATE_PENDING_APPROVAL_LINE_ITEM_NOT_ALLOWED" // // Updating an archived line item is not allowed. // LineItemError_ReasonUPDATE_ARCHIVED_LINE_ITEM_NOT_ALLOWED LineItemError_Reason = "UPDATE_ARCHIVED_LINE_ITEM_NOT_ALLOWED" // // Create or update legacy dfp line item type is not allowed. // LineItemError_ReasonCREATE_OR_UPDATE_LEGACY_DFP_LINE_ITEM_TYPE_NOT_ALLOWED LineItemError_Reason = "CREATE_OR_UPDATE_LEGACY_DFP_LINE_ITEM_TYPE_NOT_ALLOWED" // // Copying line item from different company (advertiser) // to the same order is not allowed. // LineItemError_ReasonCOPY_LINE_ITEM_FROM_DIFFERENT_COMPANY_NOT_ALLOWED LineItemError_Reason = "COPY_LINE_ITEM_FROM_DIFFERENT_COMPANY_NOT_ALLOWED" // // The size is invalid for the specified platform. // LineItemError_ReasonINVALID_SIZE_FOR_PLATFORM LineItemError_Reason = "INVALID_SIZE_FOR_PLATFORM" // // The line item type is invalid for the specified platform. // LineItemError_ReasonINVALID_LINE_ITEM_TYPE_FOR_PLATFORM LineItemError_Reason = "INVALID_LINE_ITEM_TYPE_FOR_PLATFORM" // // The web property cannot be served on the specified platform. // LineItemError_ReasonINVALID_WEB_PROPERTY_FOR_PLATFORM LineItemError_Reason = "INVALID_WEB_PROPERTY_FOR_PLATFORM" // // The web property cannot be served on the specified environment. // LineItemError_ReasonINVALID_WEB_PROPERTY_FOR_ENVIRONMENT LineItemError_Reason = "INVALID_WEB_PROPERTY_FOR_ENVIRONMENT" // // AFMA backfill not supported. // LineItemError_ReasonAFMA_BACKFILL_NOT_ALLOWED LineItemError_Reason = "AFMA_BACKFILL_NOT_ALLOWED" // // Environment type cannot change once saved. // LineItemError_ReasonUPDATE_ENVIRONMENT_TYPE_NOT_ALLOWED LineItemError_Reason = "UPDATE_ENVIRONMENT_TYPE_NOT_ALLOWED" // // The placeholders are invalid because they contain companions, // but the line item does not support companions. // LineItemError_ReasonCOMPANIONS_NOT_ALLOWED LineItemError_Reason = "COMPANIONS_NOT_ALLOWED" // // The placeholders are invalid because some of them are roadblocks, // and some are not. Either all roadblock placeholders must contain // companions, or no placeholders may contain companions. This does // not apply to video creative sets. // LineItemError_ReasonROADBLOCKS_WITH_NONROADBLOCKS_NOT_ALLOWED LineItemError_Reason = "ROADBLOCKS_WITH_NONROADBLOCKS_NOT_ALLOWED" // // A line item cannot be updated from having // {@link RoadblockingType#CREATIVE_SET} to having a different // RoadblockingType, or vice versa. // LineItemError_ReasonCANNOT_UPDATE_TO_OR_FROM_CREATIVE_SET_ROADBLOCK LineItemError_Reason = "CANNOT_UPDATE_TO_OR_FROM_CREATIVE_SET_ROADBLOCK" // // Can not change from a backfill line item type once creatives have been // assigned. // LineItemError_ReasonUPDATE_FROM_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED LineItemError_Reason = "UPDATE_FROM_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED" // // Can not change to a backfill line item type once creatives have been // assigned. // LineItemError_ReasonUPDATE_TO_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED LineItemError_Reason = "UPDATE_TO_BACKFILL_LINE_ITEM_TYPE_NOT_ALLOWED" // // Can not change to backfill web property once creatives have been // assigned. // LineItemError_ReasonUPDATE_BACKFILL_WEB_PROPERTY_NOT_ALLOWED LineItemError_Reason = "UPDATE_BACKFILL_WEB_PROPERTY_NOT_ALLOWED" // // The companion delivery option is not valid for your environment type. // LineItemError_ReasonINVALID_COMPANION_DELIVERY_OPTION_FOR_ENVIRONMENT_TYPE LineItemError_Reason = "INVALID_COMPANION_DELIVERY_OPTION_FOR_ENVIRONMENT_TYPE" // // Companion backfill is enabled but environment type not video. // LineItemError_ReasonCOMPANION_BACKFILL_REQUIRES_VIDEO LineItemError_Reason = "COMPANION_BACKFILL_REQUIRES_VIDEO" // // Companion delivery options require Ad Manager 360 networks. // LineItemError_ReasonCOMPANION_DELIVERY_OPTION_REQUIRE_PREMIUM LineItemError_Reason = "COMPANION_DELIVERY_OPTION_REQUIRE_PREMIUM" // // The master size of placeholders have duplicates. // LineItemError_ReasonDUPLICATE_MASTER_SIZES LineItemError_Reason = "DUPLICATE_MASTER_SIZES" // // The line item priority is invalid if for dynamic allocation line items // it is different than the default for free publishers. When allowed, // Ad Manager 360 users can change the priority to any value. // LineItemError_ReasonINVALID_PRIORITY_FOR_LINE_ITEM_TYPE LineItemError_Reason = "INVALID_PRIORITY_FOR_LINE_ITEM_TYPE" // // The environment type is not valid. // LineItemError_ReasonINVALID_ENVIRONMENT_TYPE LineItemError_Reason = "INVALID_ENVIRONMENT_TYPE" // // The environment type is not valid for the target platform. // LineItemError_ReasonINVALID_ENVIRONMENT_TYPE_FOR_PLATFORM LineItemError_Reason = "INVALID_ENVIRONMENT_TYPE_FOR_PLATFORM" // // Only {@link LineItemType#STANDARD} line items can be auto extended. // LineItemError_ReasonINVALID_TYPE_FOR_AUTO_EXTENSION LineItemError_Reason = "INVALID_TYPE_FOR_AUTO_EXTENSION" // // Video line items cannot change the roadblocking type. // LineItemError_ReasonVIDEO_INVALID_ROADBLOCKING LineItemError_Reason = "VIDEO_INVALID_ROADBLOCKING" // // The backfill feature is not enabled according to your features. // LineItemError_ReasonBACKFILL_TYPE_NOT_ALLOWED LineItemError_Reason = "BACKFILL_TYPE_NOT_ALLOWED" // // The web property is invalid. A line item must have an appropriate web property selected. // LineItemError_ReasonINVALID_BACKFILL_LINK_TYPE LineItemError_Reason = "INVALID_BACKFILL_LINK_TYPE" // // All line items in a programmatic order must have web property codes from the same account. // LineItemError_ReasonDIFFERENT_BACKFILL_ACCOUNT LineItemError_Reason = "DIFFERENT_BACKFILL_ACCOUNT" // // Companion delivery options are not allowed with dynamic allocation line // items. // LineItemError_ReasonCOMPANION_DELIVERY_OPTIONS_NOT_ALLOWED_WITH_BACKFILL LineItemError_Reason = "COMPANION_DELIVERY_OPTIONS_NOT_ALLOWED_WITH_BACKFILL" // // Dynamic allocation using the AdExchange should always use an AFC web // property. // LineItemError_ReasonINVALID_WEB_PROPERTY_FOR_ADX_BACKFILL LineItemError_Reason = "INVALID_WEB_PROPERTY_FOR_ADX_BACKFILL" // // CPM for backfill inventory must be 0. // LineItemError_ReasonINVALID_COST_PER_UNIT_FOR_BACKFILL LineItemError_Reason = "INVALID_COST_PER_UNIT_FOR_BACKFILL" // // Aspect ratio sizes cannot be used with video line items. // LineItemError_ReasonINVALID_SIZE_FOR_ENVIRONMENT LineItemError_Reason = "INVALID_SIZE_FOR_ENVIRONMENT" // // The specified target platform is not allowed. // LineItemError_ReasonTARGET_PLATOFRM_NOT_ALLOWED LineItemError_Reason = "TARGET_PLATOFRM_NOT_ALLOWED" // // Currency on a line item must be one of the specified network currencies. // LineItemError_ReasonINVALID_LINE_ITEM_CURRENCY LineItemError_Reason = "INVALID_LINE_ITEM_CURRENCY" // // All money fields on a line item must specify the same currency. // LineItemError_ReasonLINE_ITEM_CANNOT_HAVE_MULTIPLE_CURRENCIES LineItemError_Reason = "LINE_ITEM_CANNOT_HAVE_MULTIPLE_CURRENCIES" // // Once a line item has moved into a a delivering state the currency cannot be changed. // LineItemError_ReasonCANNOT_CHANGE_CURRENCY LineItemError_Reason = "CANNOT_CHANGE_CURRENCY" // // A DateTime associated with the line item is not valid. // LineItemError_ReasonINVALID_LINE_ITEM_DATE_TIME LineItemError_Reason = "INVALID_LINE_ITEM_DATE_TIME" // // CPA {@link LineItem line items} must specify a zero cost for the // {@link LineItem#costPerUnit}. // LineItemError_ReasonINVALID_COST_PER_UNIT_FOR_CPA LineItemError_Reason = "INVALID_COST_PER_UNIT_FOR_CPA" // // Once a {@link LineItem} is activated its {@link LineItem#costPerUnit} cannot be updated // to/from CPA. // LineItemError_ReasonUPDATE_CPA_COST_TYPE_NOT_ALLOWED LineItemError_Reason = "UPDATE_CPA_COST_TYPE_NOT_ALLOWED" // // Once a {@link LineItem} is activated its {@link LineItem#costPerUnit} cannot be updated // to/from Viewable CPM. // LineItemError_ReasonUPDATE_VCPM_COST_TYPE_NOT_ALLOWED LineItemError_Reason = "UPDATE_VCPM_COST_TYPE_NOT_ALLOWED" // // A {@link LineItem} with master/companion creative placeholders cannot have Viewable CPM // as its {@link LineItem#costPerUnit}. // LineItemError_ReasonMASTER_COMPANION_LINE_ITEM_CANNOT_HAVE_VCPM_COST_TYPE LineItemError_Reason = "MASTER_COMPANION_LINE_ITEM_CANNOT_HAVE_VCPM_COST_TYPE" // // There cannot be goals with duplicated unit type among the secondary goals for a // {@link LineItem line items}. // LineItemError_ReasonDUPLICATED_UNIT_TYPE LineItemError_Reason = "DUPLICATED_UNIT_TYPE" // // The secondary goals of a {@link LineItem line items} must have the same goal type. // LineItemError_ReasonMULTIPLE_GOAL_TYPE_NOT_ALLOWED LineItemError_Reason = "MULTIPLE_GOAL_TYPE_NOT_ALLOWED" // // For a CPA {@link LineItem line item}, the possible combinations for secondary goals must // be either click-through conversion only, click-through conversion with view-through // conversion or total conversion only. For a Viewable CPM {@link LineItem line item} or a // CPM based Sponsorship {@link LineItem line item}, its secondary goal has to be // impression-based. // LineItemError_ReasonINVALID_UNIT_TYPE_COMBINATION_FOR_SECONDARY_GOALS LineItemError_Reason = "INVALID_UNIT_TYPE_COMBINATION_FOR_SECONDARY_GOALS" // // One or more of the targeting names specified by a creative placeholder or line item // creative association were not found on the line item. // LineItemError_ReasonINVALID_CREATIVE_TARGETING_NAME LineItemError_Reason = "INVALID_CREATIVE_TARGETING_NAME" // // Creative targeting expressions on the line item can only have custom criteria targeting // with {@link CustomTargetingValue.MatchType#EXACT}. // LineItemError_ReasonINVALID_CREATIVE_CUSTOM_TARGETING_MATCH_TYPE LineItemError_Reason = "INVALID_CREATIVE_CUSTOM_TARGETING_MATCH_TYPE" // // Line item with creative targeting expressions cannot have creative rotation type set to // {@link CreativeRotationType#SEQUENTIAL}. // LineItemError_ReasonINVALID_CREATIVE_ROTATION_TYPE_WITH_CREATIVE_TARGETING LineItemError_Reason = "INVALID_CREATIVE_ROTATION_TYPE_WITH_CREATIVE_TARGETING" // // Line items cannot overbook inventory when applying creative-level targeting if the // originating proposal line item did not overbook inventory. Remove creative-level targeting // and try again. // LineItemError_ReasonCANNOT_OVERBOOK_WITH_CREATIVE_TARGETING LineItemError_Reason = "CANNOT_OVERBOOK_WITH_CREATIVE_TARGETING" // // For a managed line item, inventory sizes must match sizes that are set on the originating // proposal line item. In the case that a size is broken out by creative-level targeting, // the sum of the creative counts for each size must equal the expected creative count that // is set for that size on the originating proposal line item. // LineItemError_ReasonPLACEHOLDERS_DO_NOT_MATCH_PROPOSAL LineItemError_Reason = "PLACEHOLDERS_DO_NOT_MATCH_PROPOSAL" // // The line item type is not supported for this API version. // LineItemError_ReasonUNSUPPORTED_LINE_ITEM_TYPE_FOR_THIS_API_VERSION LineItemError_Reason = "UNSUPPORTED_LINE_ITEM_TYPE_FOR_THIS_API_VERSION" // // Placeholders can only have native creative templates. // LineItemError_ReasonNATIVE_CREATIVE_TEMPLATE_REQUIRED LineItemError_Reason = "NATIVE_CREATIVE_TEMPLATE_REQUIRED" // // Non-native placeholders cannot have creative templates. // LineItemError_ReasonCANNOT_HAVE_CREATIVE_TEMPLATE LineItemError_Reason = "CANNOT_HAVE_CREATIVE_TEMPLATE" // // Cannot include native creative templates in the placeholders for Ad Exchange line items. // LineItemError_ReasonCANNOT_INCLUDE_NATIVE_CREATIVE_TEMPLATE LineItemError_Reason = "CANNOT_INCLUDE_NATIVE_CREATIVE_TEMPLATE" // // Cannot include native placeholders without native creative templates for direct-sold line // items. // LineItemError_ReasonCANNOT_INCLUDE_NATIVE_PLACEHOLDER_WITHOUT_TEMPLATE_ID LineItemError_Reason = "CANNOT_INCLUDE_NATIVE_PLACEHOLDER_WITHOUT_TEMPLATE_ID" // // For forecasting only, error when line item has duration, but no creative sizes specified. // LineItemError_ReasonNO_SIZE_WITH_DURATION LineItemError_Reason = "NO_SIZE_WITH_DURATION" // // Used when the company pointed to by the viewabilityProviderCompanyId is not of type // VIEWABILITY_PROVIDER. // LineItemError_ReasonINVALID_VIEWABILITY_PROVIDER_COMPANY LineItemError_Reason = "INVALID_VIEWABILITY_PROVIDER_COMPANY" // // An error occurred while accessing the custom pacing curve Google Cloud Storage bucket. // LineItemError_ReasonCANNOT_ACCESS_CUSTOM_PACING_CURVE_CLOUD_STORAGE_BUCKET LineItemError_Reason = "CANNOT_ACCESS_CUSTOM_PACING_CURVE_CLOUD_STORAGE_BUCKET" // // CMS Metadata targeting is only supported for video line items. // LineItemError_ReasonCMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED LineItemError_Reason = "CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED" // // The {@code SkippableAdType} is not allowed. // LineItemError_ReasonSKIPPABLE_AD_TYPE_NOT_ALLOWED LineItemError_Reason = "SKIPPABLE_AD_TYPE_NOT_ALLOWED" // // Custom pacing curve start time must match the line item's start time. // LineItemError_ReasonCUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME LineItemError_Reason = "CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME" // // Custom pacing curve goal start time must be before line item end time. // LineItemError_ReasonCUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME LineItemError_Reason = "CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME" // // The line item type is invalid for the specified delivery forecast source. // LineItemError_ReasonINVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE LineItemError_Reason = "INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE" // // The sum of the custom pacing goal amounts is invalid. // LineItemError_ReasonINVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS LineItemError_Reason = "INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS" // // Copying line items with custom pacing curves that are totally in the past is not allowed. // LineItemError_ReasonCOPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED LineItemError_Reason = "COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED" // // The last custom pacing goal cannot be zero. // LineItemError_ReasonLAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO LineItemError_Reason = "LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO" // // GRP paced line items cannot have absolute custom pacing curve goals. // LineItemError_ReasonGRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS LineItemError_Reason = "GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS" // // {@link LineItem line item} has invalid video creative duration. // LineItemError_ReasonINVALID_MAX_VIDEO_CREATIVE_DURATION LineItemError_Reason = "INVALID_MAX_VIDEO_CREATIVE_DURATION" // // Native size types must by 1x1. // LineItemError_ReasonINVALID_NATIVE_SIZE LineItemError_Reason = "INVALID_NATIVE_SIZE" // // For AdExchange Line Items, the targeted request platform must match the syndication type of // the web property code. // LineItemError_ReasonINVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE LineItemError_Reason = "INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE" // // The value returned if the actual value is not exposed by the requested API version. // LineItemError_ReasonUNKNOWN LineItemError_Reason = "UNKNOWN" )
type LineItemFlightDateError ¶
type LineItemFlightDateError struct { *ApiError // // The error reason represented by an enum. // Reason *LineItemFlightDateError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type LineItemFlightDateError_Reason ¶
type LineItemFlightDateError_Reason string
const ( LineItemFlightDateError_ReasonSTART_DATE_TIME_IS_IN_PAST LineItemFlightDateError_Reason = "START_DATE_TIME_IS_IN_PAST" LineItemFlightDateError_ReasonEND_DATE_TIME_IS_IN_PAST LineItemFlightDateError_Reason = "END_DATE_TIME_IS_IN_PAST" LineItemFlightDateError_ReasonEND_DATE_TIME_NOT_AFTER_START_TIME LineItemFlightDateError_Reason = "END_DATE_TIME_NOT_AFTER_START_TIME" LineItemFlightDateError_ReasonEND_DATE_TIME_TOO_LATE LineItemFlightDateError_Reason = "END_DATE_TIME_TOO_LATE" // // The value returned if the actual value is not exposed by the requested API version. // LineItemFlightDateError_ReasonUNKNOWN LineItemFlightDateError_Reason = "UNKNOWN" )
type LineItemOperationError ¶
type LineItemOperationError struct { *ApiError // // The error reason represented by an enum. // Reason *LineItemOperationError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type LineItemOperationError_Reason ¶
type LineItemOperationError_Reason string
const ( // // The operation is not allowed due to lack of permissions. // LineItemOperationError_ReasonNOT_ALLOWED LineItemOperationError_Reason = "NOT_ALLOWED" // // The operation is not applicable for the current state of the // {@link LineItem}. // LineItemOperationError_ReasonNOT_APPLICABLE LineItemOperationError_Reason = "NOT_APPLICABLE" // // The {@link LineItem} is completed. A {@link LineItemAction} cannot // be applied to a line item that is completed. // LineItemOperationError_ReasonHAS_COMPLETED LineItemOperationError_Reason = "HAS_COMPLETED" // // The {@link LineItem} has no active creatives. A line item cannot be // activated with no active creatives. // LineItemOperationError_ReasonHAS_NO_ACTIVE_CREATIVES LineItemOperationError_Reason = "HAS_NO_ACTIVE_CREATIVES" // // A {@link LineItem} of type {@link LineItemType#LEGACY_DFP} cannot be // Activated. // LineItemOperationError_ReasonCANNOT_ACTIVATE_LEGACY_DFP_LINE_ITEM LineItemOperationError_Reason = "CANNOT_ACTIVATE_LEGACY_DFP_LINE_ITEM" // // A {@link LineItem} with publisher creative source cannot be activated if the corresponding // deal is not yet configured by the buyer. // LineItemOperationError_ReasonCANNOT_ACTIVATE_UNCONFIGURED_LINE_ITEM LineItemOperationError_Reason = "CANNOT_ACTIVATE_UNCONFIGURED_LINE_ITEM" // // Deleting an {@link LineItem} that has delivered is not allowed // LineItemOperationError_ReasonCANNOT_DELETE_DELIVERED_LINE_ITEM LineItemOperationError_Reason = "CANNOT_DELETE_DELIVERED_LINE_ITEM" // // Reservation cannot be made for line item because the // {@link LineItem#advertiserId} it is associated with has // {@link Company#creditStatus} that is not {@code ACTIVE} // or {@code ON_HOLD}. // LineItemOperationError_ReasonCANNOT_RESERVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE LineItemOperationError_Reason = "CANNOT_RESERVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE" // // Cannot activate line item because the {@link LineItem#advertiserId} // it is associated with has {@link Company#creditStatus} that is not // {@code ACTIVE}, {@code INACTIVE}, or {@code ON_HOLD}. // LineItemOperationError_ReasonCANNOT_ACTIVATE_INVALID_COMPANY_CREDIT_STATUS LineItemOperationError_Reason = "CANNOT_ACTIVATE_INVALID_COMPANY_CREDIT_STATUS" // // The value returned if the actual value is not exposed by the requested API version. // LineItemOperationError_ReasonUNKNOWN LineItemOperationError_Reason = "UNKNOWN" )
type LineItemSummary ¶
type LineItemSummary struct { // // The ID of the {@link Order} to which the {@code LineItem} belongs. This attribute is required. // OrderId int64 `xml:"orderId,omitempty" json:"orderId,omitempty"` // // Uniquely identifies the {@code LineItem}. This attribute is read-only and is assigned by Google // when a line item is created. // Id int64 `xml:"id,omitempty" json:"id,omitempty"` // // The name of the line item. This attribute is required and has a maximum length of 255 // characters. // Name string `xml:"name,omitempty" json:"name,omitempty"` // // An identifier for the {@code LineItem} 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"` // // The name of the {@link Order}. This value is read-only. // OrderName string `xml:"orderName,omitempty" json:"orderName,omitempty"` // // The date and time on which the {@code LineItem} is enabled to begin serving. This attribute is // required and must be in the future. // StartDateTime soap.XSDDateTime `xml:"startDateTime,omitempty" json:"startDateTime,omitempty"` // // Specifies whether to start serving to the {@code LineItem} right away, in an hour, etc. This // attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}. // StartDateTimeType *StartDateTimeType `xml:"startDateTimeType,omitempty" json:"startDateTimeType,omitempty"` // // The date and time on which the {@code LineItem} will stop serving. This attribute is required // unless {@link LineItem#unlimitedEndDateTime} is set to {@code true}. If specified, it must be // after the {@link LineItem#startDateTime}. This end date and time does not include auto // extension days. // EndDateTime soap.XSDDateTime `xml:"endDateTime,omitempty" json:"endDateTime,omitempty"` // // The number of days to allow a line item to deliver past its {@link #endDateTime}. A maximum of // 7 days is allowed. This is feature is only available for Ad Manager 360 accounts. // AutoExtensionDays int32 `xml:"autoExtensionDays,omitempty" json:"autoExtensionDays,omitempty"` // // Specifies whether or not the {@code LineItem} has an end time. This attribute is optional and // defaults to false. It can be be set to {@code true} for only line items of type {@link // LineItemType#SPONSORSHIP}, {@link LineItemType#NETWORK}, {@link LineItemType#PRICE_PRIORITY} // and {@link LineItemType#HOUSE}. // UnlimitedEndDateTime bool `xml:"unlimitedEndDateTime,omitempty" json:"unlimitedEndDateTime,omitempty"` // // The strategy used for displaying multiple {@link Creative} objects that are associated with the // {@code LineItem}. This attribute is required. // CreativeRotationType *CreativeRotationType `xml:"creativeRotationType,omitempty" json:"creativeRotationType,omitempty"` // // The strategy for delivering ads over the course of the line item's duration. This attribute is // optional and defaults to {@link DeliveryRateType#EVENLY} or {@link // DeliveryRateType#FRONTLOADED} depending on the network's configuration. // DeliveryRateType *DeliveryRateType `xml:"deliveryRateType,omitempty" json:"deliveryRateType,omitempty"` // // Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and // defaults to {@link DeliveryForecastSource#HISTORICAL}. // DeliveryForecastSource *DeliveryForecastSource `xml:"deliveryForecastSource,omitempty" json:"deliveryForecastSource,omitempty"` // // The curve that is used to pace the line item's delivery. This field is required if and only if // the delivery forecast source is {@link DeliveryForecastSource#CUSTOM_PACING_CURVE}. // CustomPacingCurve *CustomPacingCurve `xml:"customPacingCurve,omitempty" json:"customPacingCurve,omitempty"` // // The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be // served together on a single web page. This attribute is optional and defaults to {@link // RoadblockingType#ONE_OR_MORE}. // RoadblockingType *RoadblockingType `xml:"roadblockingType,omitempty" json:"roadblockingType,omitempty"` // // The nature of the line item's creatives' skippability. This attribute is optional, only // applicable for video line items, and defaults to {@link SkippableAdType#NOT_SKIPPABLE}. // SkippableAdType *SkippableAdType `xml:"skippableAdType,omitempty" json:"skippableAdType,omitempty"` // // The set of frequency capping units for this {@code LineItem}. This attribute is optional. // FrequencyCaps []*FrequencyCap `xml:"frequencyCaps,omitempty" json:"frequencyCaps,omitempty"` // // Indicates the line item type of a {@code LineItem}. This attribute is required. // // <p>The line item type determines the default priority of the line item. More information can be // found on the <a href="https://support.google.com/admanager/answer/177279">Ad Manager Help // Center</a>. // LineItemType *LineItemType `xml:"lineItemType,omitempty" json:"lineItemType,omitempty"` // // The priority for the line item. Valid values range from 1 to 16. This field is optional and // defaults to the default priority of the {@link LineItemType}. // // <p>The following table shows the default, minimum, and maximum priority values are for each // line item type: // // <table> // <tr> // <th colspan="2" scope="col"> // LineItemType - default priority (minimum priority, maximum priority) // </th> // </tr> // <tr> // <td>{@link LineItemType#SPONSORSHIP}</td> // <td>4 (2, 5)</td> // </tr> // <tr> // <td>{@link LineItemType#STANDARD}</td> // <td>8 (6, 10)</td> // </tr> // <tr> // <td>{@link LineItemType#NETWORK}</td> // <td>12 (11, 14)</td> // </tr> // <tr> // <td>{@link LineItemType#BULK}</td> // <td>12 (11, 14)</td> // </tr> // <tr> // <td>{@link LineItemType#PRICE_PRIORITY}</td> // <td>12 (11, 14)</td> // </tr> // <tr> // <td>{@link LineItemType#HOUSE}</td> // <td>16 (15, 16)</td> // </tr> // <tr> // <td>{@link LineItemType#CLICK_TRACKING}</td> // <td>16 (1, 16)</td> // </tr> // <tr> // <td>{@link LineItemType#AD_EXCHANGE}</td> // <td>12 (1, 16)</td> // </tr> // <td>{@link LineItemType#ADSENSE}</td> // <td>12 (1, 16)</td> // </tr> // <td>{@link LineItemType#BUMPER}</td> // <td>16 (15, 16)</td> // </tr> // </table> // // <p>This field can only be edited by certain networks, otherwise a {@link PermissionError} will // occur. // Priority int32 `xml:"priority,omitempty" json:"priority,omitempty"` // // The amount of money to spend per impression or click. This attribute is required for creating a // {@code LineItem}. // CostPerUnit *Money `xml:"costPerUnit,omitempty" json:"costPerUnit,omitempty"` // // An amount to help the adserver rank inventory. {@link LineItem#valueCostPerUnit} artificially // raises the value of inventory over the {@link LineItem#costPerUnit} but avoids raising the // actual {@link LineItem#costPerUnit}. This attribute is optional and defaults to a {@link Money} // object in the local currency with {@link Money#microAmount} 0. // ValueCostPerUnit *Money `xml:"valueCostPerUnit,omitempty" json:"valueCostPerUnit,omitempty"` // // The method used for billing this {@code LineItem}. This attribute is required. // CostType *CostType `xml:"costType,omitempty" json:"costType,omitempty"` // // The type of discount being applied to a {@code LineItem}, either percentage based or absolute. // This attribute is optional and defaults to {@link LineItemDiscountType#PERCENTAGE}. // DiscountType *LineItemDiscountType `xml:"discountType,omitempty" json:"discountType,omitempty"` // // The number here is either a percentage or an absolute value depending on the {@code // LineItemDiscountType}. If the {@code LineItemDiscountType} is {@link // LineItemDiscountType#PERCENTAGE}, then only non-fractional values are supported. // Discount float64 `xml:"discount,omitempty" json:"discount,omitempty"` // // This attribute is only applicable for certain {@link #lineItemType line item types} and acts as // an "FYI" or note, which does not impact adserving or other backend systems. // // <p>For {@link LineItemType#SPONSORSHIP} line items, this represents the minimum quantity, which // is a lifetime impression volume goal for reporting purposes only. // // <p>For {@link LineItemType#STANDARD} line items, this represent the contracted quantity, which // is the number of units specified in the contract the advertiser has bought for this {@code // LineItem}. This field is just a "FYI" for traffickers to manually intervene with the {@code // LineItem} when needed. This attribute is only available for {@link LineItemType#STANDARD} line // items if you have this feature enabled on your network. // ContractedUnitsBought int64 `xml:"contractedUnitsBought,omitempty" json:"contractedUnitsBought,omitempty"` // // Details about the creatives that are expected to serve through this {@code LineItem}. This // attribute is required and replaces the {@code creativeSizes} attribute. // CreativePlaceholders []*CreativePlaceholder `xml:"creativePlaceholders,omitempty" json:"creativePlaceholders,omitempty"` // // This attribute is required and meaningful only if the {@link LineItem#costType} is {@link // CostType.CPA}. // ActivityAssociations []*LineItemActivityAssociation `xml:"activityAssociations,omitempty" json:"activityAssociations,omitempty"` // // The environment that the {@code LineItem} is targeting. The default value is {@link // EnvironmentType#BROWSER}. If this value is {@link EnvironmentType#VIDEO_PLAYER}, then this line // item can only target {@code AdUnits} that have {@code AdUnitSizes} whose {@code // environmentType} is also {@code VIDEO_PLAYER}. // EnvironmentType *EnvironmentType `xml:"environmentType,omitempty" json:"environmentType,omitempty"` // // The set of {@link allowedFormats} that this programmatic line item can have. If the set is // empty, this line item allows all formats. // AllowedFormats []*AllowedFormats `xml:"allowedFormats,omitempty" json:"allowedFormats,omitempty"` // // The delivery option for companions. Setting this field is only meaningful if the following // conditions are met: // // <ol> // <li>The <b>Guaranteed roadblocks</b> feature is enabled on your network. // <li>One of the following is true (both cannot be true, these are mutually exclusive). // <ul> // <li>The {@link #environmentType} is {@link EnvironmentType#VIDEO_PLAYER}. // <li>The {@link #roadblockingType} is {@link RoadblockingType#CREATIVE_SET}. // </ul> // </ol> // // <p>This field is optional and defaults to {@link CompanionDeliveryOption#OPTIONAL} if the above // conditions are met. In all other cases it defaults to {@link CompanionDeliveryOption#UNKNOWN} // and is not meaningful. // CompanionDeliveryOption *CompanionDeliveryOption `xml:"companionDeliveryOption,omitempty" json:"companionDeliveryOption,omitempty"` // // The flag indicates whether overbooking should be allowed when creating or updating reservations // of line item types {@link LineItemType#SPONSORSHIP} and {@link LineItemType#STANDARD}. When // true, operations on this line item will never trigger a {@link ForecastError}, which // corresponds to an overbook warning in the UI. The default value is false. // // <p>Note: this field will not persist on the line item itself, and the value will only affect // the current request. // AllowOverbook bool `xml:"allowOverbook,omitempty" json:"allowOverbook,omitempty"` // // The flag indicates whether the inventory check should be skipped when creating or updating a // line item. The default value is false. // // <p>Note: this field will not persist on the line item itself, and the value will only affect // the current request. // SkipInventoryCheck bool `xml:"skipInventoryCheck,omitempty" json:"skipInventoryCheck,omitempty"` // // True to skip checks for warnings from rules applied to line items targeting inventory shared by // a distributor partner for cross selling when performing an action on this line item. The // default is false. // SkipCrossSellingRuleWarningChecks bool `xml:"skipCrossSellingRuleWarningChecks,omitempty" json:"skipCrossSellingRuleWarningChecks,omitempty"` // // The flag indicates whether inventory should be reserved when creating a line item of types // {@link LineItemType#SPONSORSHIP} and {@link LineItemType#STANDARD} in an unapproved {@link // Order}. The default value is false. // ReserveAtCreation bool `xml:"reserveAtCreation,omitempty" json:"reserveAtCreation,omitempty"` // // Contains trafficking statistics for the line item. This attribute is readonly and is populated // by Google. This will be {@code null} in case there are no statistics for a line item yet. // Stats *Stats `xml:"stats,omitempty" json:"stats,omitempty"` // // Indicates how well the line item has been performing. This attribute is readonly and is // populated by Google. This will be {@code null} if the delivery indicator information is not // available due to one of the following reasons: // // <ol> // <li>The line item is not delivering. // <li>The line item has an unlimited goal or cap. // <li>The line item has a percentage based goal or cap. // </ol> // DeliveryIndicator *DeliveryIndicator `xml:"deliveryIndicator,omitempty" json:"deliveryIndicator,omitempty"` // // Delivery data provides the number of clicks or impressions delivered for a {@link LineItem} in // the last 7 days. This attribute is readonly and is populated by Google. This will be {@code // null} if the delivery data cannot be computed due to one of the following reasons: // // <ol> // <li>The line item is not deliverable. // <li>The line item has completed delivering more than 7 days ago. // <li>The line item has an absolute-based goal. {@link LineItem#deliveryIndicator} should be // used to track its progress in this case. // DeliveryData *DeliveryData `xml:"deliveryData,omitempty" json:"deliveryData,omitempty"` // // The amount of money allocated to the {@code LineItem}. This attribute is readonly and is // populated by Google. The currency code is readonly. // Budget *Money `xml:"budget,omitempty" json:"budget,omitempty"` // // The status of the {@code LineItem}. This attribute is readonly. // Status *ComputedStatus `xml:"status,omitempty" json:"status,omitempty"` // // Describes whether or not inventory has been reserved for the {@code LineItem}. This attribute // is readonly and is assigned by Google. // ReservationStatus *LineItemSummary_ReservationStatus `xml:"reservationStatus,omitempty" json:"reservationStatus,omitempty"` // // The archival status of the {@code LineItem}. This attribute is readonly. // IsArchived bool `xml:"isArchived,omitempty" json:"isArchived,omitempty"` // // The web property code used for dynamic allocation line items. This web property is only // required with line item types {@link LineItemType#AD_EXCHANGE} and {@link // LineItemType#ADSENSE}. // WebPropertyCode string `xml:"webPropertyCode,omitempty" json:"webPropertyCode,omitempty"` // // The set of labels applied directly to this line item. // AppliedLabels []*AppliedLabel `xml:"appliedLabels,omitempty" json:"appliedLabels,omitempty"` // // Contains the set of labels inherited from the order that contains this line item and the // advertiser that owns the order. If a label has been negated, only the negated label is // returned. This field is readonly and is assigned by Google. // EffectiveAppliedLabels []*AppliedLabel `xml:"effectiveAppliedLabels,omitempty" json:"effectiveAppliedLabels,omitempty"` // // If a line item has a series of competitive exclusions on it, it could be blocked from serving // with line items from the same advertiser. Setting this to {@code true} will allow line items // from the same advertiser to serve regardless of the other competitive exclusion labels being // applied. // DisableSameAdvertiserCompetitiveExclusion bool `xml:"disableSameAdvertiserCompetitiveExclusion,omitempty" json:"disableSameAdvertiserCompetitiveExclusion,omitempty"` // // The application that last modified this line item. This attribute is read only and is assigned // by Google. // LastModifiedByApp string `xml:"lastModifiedByApp,omitempty" json:"lastModifiedByApp,omitempty"` // // Provides any additional notes that may annotate the {@code LineItem}. This attribute is // optional and has a maximum length of 65,535 characters. // Notes string `xml:"notes,omitempty" json:"notes,omitempty"` // // The {@code CompetitiveConstraintScope} for the competitive exclusion labels assigned to this // line item. This field is optional, defaults to {@link CompetitiveConstraintScope#POD}, and only // applies to video line items. // CompetitiveConstraintScope *CompetitiveConstraintScope `xml:"competitiveConstraintScope,omitempty" json:"competitiveConstraintScope,omitempty"` // // The date and time this line item was last modified. // LastModifiedDateTime soap.XSDDateTime `xml:"lastModifiedDateTime,omitempty" json:"lastModifiedDateTime,omitempty"` // // This attribute may be {@code null} for line items created before this feature was introduced. // CreationDateTime soap.XSDDateTime `xml:"creationDateTime,omitempty" json:"creationDateTime,omitempty"` // // The values of the custom fields associated with this line item. // CustomFieldValues []*BaseCustomFieldValue `xml:"customFieldValues,omitempty" json:"customFieldValues,omitempty"` // // Indicates if a {@code LineItem} is missing any {@link Creative creatives} for the {@code // creativePlaceholders} specified. // // <p>{@link Creative Creatives} can be considered missing for several reasons including: // // <ul> // <li>Not enough {@link Creative creatives} of a certain size have been uploaded, as determined // by {@link CreativePlaceholder#expectedCreativeCount}. For example a {@code LineItem} // specifies 750x350, 400x200 but only a 750x350 was uploaded. Or {@code LineItem} specifies // 750x350 with an expected count of 2, but only one was uploaded. // <li>The {@link Creative#appliedLabels} of an associated {@code Creative} do not match the // {@link CreativePlaceholder#effectiveAppliedLabels} of the {@code LineItem}. For example // {@code LineItem} specifies 750x350 with a Foo {@code AppliedLabel} but a 750x350 creative // without a {@code AppliedLabel} was uploaded. // </ul> // IsMissingCreatives bool `xml:"isMissingCreatives,omitempty" json:"isMissingCreatives,omitempty"` // // Indicates the {@link ProgrammaticCreativeSource} of the programmatic line item. This is a // read-only field. Any changes must be made on the {@link ProposalLineItem}. // ProgrammaticCreativeSource *ProgrammaticCreativeSource `xml:"programmaticCreativeSource,omitempty" json:"programmaticCreativeSource,omitempty"` ThirdPartyMeasurementSettings *ThirdPartyMeasurementSettings `xml:"thirdPartyMeasurementSettings,omitempty" json:"thirdPartyMeasurementSettings,omitempty"` // // Designates this line item as intended for YT Kids app. If true, all creatives associated with // this line item must be reviewed and approved. See the <a // href="https://support.google.com/yt-partner-sales/answer/10015534">Ad Manager Help Center </a> // for more information. // YoutubeKidsRestricted bool `xml:"youtubeKidsRestricted,omitempty" json:"youtubeKidsRestricted,omitempty"` // // The max duration of a video creative associated with this {@code LineItem} in milliseconds. // // <p>This attribute is only meaningful for video line items. For version v202011 and earlier, // this attribute is optional and defaults to 0. For version v202102 and later, this attribute is // required for video line items and must be greater than 0. // VideoMaxDuration int64 `xml:"videoMaxDuration,omitempty" json:"videoMaxDuration,omitempty"` // // The primary goal that this {@code LineItem} is associated with, which is used in its pacing and // budgeting. // PrimaryGoal *Goal `xml:"primaryGoal,omitempty" json:"primaryGoal,omitempty"` // // The secondary goals that this {@code LineItem} is associated with. It is required and // meaningful only if the {@link LineItem#costType} is {@link CostType.CPA} or if the {@link // LineItem#lineItemType} is {@link LineItemType#SPONSORSHIP} and {@link LineItem#costType} is // {@link CostType.CPM}. // SecondaryGoals []*Goal `xml:"secondaryGoals,omitempty" json:"secondaryGoals,omitempty"` // // Contains the information for a line item which has a target GRP demographic. // GrpSettings *GrpSettings `xml:"grpSettings,omitempty" json:"grpSettings,omitempty"` // // The deal information associated with this line item, if it is programmatic. // DealInfo *LineItemDealInfoDto `xml:"dealInfo,omitempty" json:"dealInfo,omitempty"` // // Optional IDs of the {@link Company} that provide ad verification for this line item. {@link // Company.Type#VIEWABILITY_PROVIDER}. // ViewabilityProviderCompanyIds []int64 `xml:"viewabilityProviderCompanyIds,omitempty" json:"viewabilityProviderCompanyIds,omitempty"` // // Child content eligibility designation for this line item. // // <p>This field is optional and defaults to {@link ChildContentEligibility#DISALLOWED}. // ChildContentEligibility *ChildContentEligibility `xml:"childContentEligibility,omitempty" json:"childContentEligibility,omitempty"` // // Custom XML to be rendered in a custom VAST response at serving time. // CustomVastExtension string `xml:"customVastExtension,omitempty" json:"customVastExtension,omitempty"` }
type LineItemSummary_ReservationStatus ¶
type LineItemSummary_ReservationStatus string
const ( // // Indicates that inventory has been reserved for the line item. // LineItemSummary_ReservationStatusRESERVED LineItemSummary_ReservationStatus = "RESERVED" // // Indicates that inventory has not been reserved for the line item. // LineItemSummary_ReservationStatusUNRESERVED LineItemSummary_ReservationStatus = "UNRESERVED" )
type LineItemType ¶
type LineItemType string
const ( // // The type of {@link LineItem} for which a percentage of all the impressions that are being sold // are reserved. // LineItemTypeSPONSORSHIP LineItemType = "SPONSORSHIP" // // The type of {@link LineItem} for which a fixed quantity of impressions or clicks are reserved. // LineItemTypeSTANDARD LineItemType = "STANDARD" // // The type of {@link LineItem} most commonly used to fill a site's unsold // inventory if not contractually obligated to deliver a requested number of // impressions. Users specify the daily percentage of unsold impressions or // clicks when creating this line item. // LineItemTypeNETWORK LineItemType = "NETWORK" // // The type of {@link LineItem} for which a fixed quantity of impressions or // clicks will be delivered at a priority lower than the // {@link LineItemType#STANDARD} type. // LineItemTypeBULK LineItemType = "BULK" // // The type of {@link LineItem} most commonly used to fill a site's unsold // inventory if not contractually obligated to deliver a requested number of // impressions. Users specify the fixed quantity of unsold impressions or // clicks when creating this line item. // LineItemTypePRICE_PRIORITY LineItemType = "PRICE_PRIORITY" // // The type of {@link LineItem} typically used for ads that promote products // and services chosen by the publisher. These usually do not generate revenue // and have the lowest delivery priority. // LineItemTypeHOUSE LineItemType = "HOUSE" // // Represents a legacy {@link LineItem} that has been migrated from the DFP // system. Such line items cannot be created any more. Also, these line items // cannot be activated or resumed. // LineItemTypeLEGACY_DFP LineItemType = "LEGACY_DFP" // // The type of {@link LineItem} used for ads that track ads being served // externally of Ad Manager, for example an email newsletter. The click through would // reference this ad, and the click would be tracked via this ad. // LineItemTypeCLICK_TRACKING LineItemType = "CLICK_TRACKING" // // A {@link LineItem} using dynamic allocation backed by AdSense. // LineItemTypeADSENSE LineItemType = "ADSENSE" // // A {@link LineItem} using dynamic allocation backed by the Google Ad Exchange. // LineItemTypeAD_EXCHANGE LineItemType = "AD_EXCHANGE" // // Represents a non-monetizable video {@link LineItem} that targets one or // more bumper positions, which are short house video messages used by // publishers to separate content from ad breaks. // LineItemTypeBUMPER LineItemType = "BUMPER" // // A {@link LineItem} using dynamic allocation backed by AdMob. // LineItemTypeADMOB LineItemType = "ADMOB" // // The type of {@link LineItem} for which there are no impressions reserved, and will serve for a // second price bid. All {@link LineItem}s of type {@link LineItemType#PREFERRED_DEAL} should // be created via a {@link ProposalLineItem} with a matching type. When creating a // {@link LineItem} of type {@link LineItemType#PREFERRED_DEAL}, the // {@link ProposalLineItem#estimatedMinimumImpressions} field is required. // LineItemTypePREFERRED_DEAL LineItemType = "PREFERRED_DEAL" // // The value returned if the actual value is not exposed by the requested API // version. // LineItemTypeUNKNOWN LineItemType = "UNKNOWN" )
type Location ¶
type Location struct { // // Uniquely identifies each {@code Location}. // Id int64 `xml:"id,omitempty" json:"id,omitempty"` // // The location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.) // Type_ string `xml:"type,omitempty" json:"type,omitempty"` // // The nearest location parent's ID for this geographical entity. // CanonicalParentId int32 `xml:"canonicalParentId,omitempty" json:"canonicalParentId,omitempty"` // // The localized name of the geographical entity. // DisplayName string `xml:"displayName,omitempty" json:"displayName,omitempty"` }
type MinuteOfHour ¶
type MinuteOfHour string
const ( // // Zero minutes past hour. // MinuteOfHourZERO MinuteOfHour = "ZERO" // // Fifteen minutes past hour. // MinuteOfHourFIFTEEN MinuteOfHour = "FIFTEEN" // // Thirty minutes past hour. // MinuteOfHourTHIRTY MinuteOfHour = "THIRTY" // // Forty-five minutes past hour. // MinuteOfHourFORTY_FIVE MinuteOfHour = "FORTY_FIVE" )
type MobileApplicationTargeting ¶
type MobileApplicationTargeting struct { // // The {@link MobileApplication#applicationId IDs} that are being targeted or excluded by the // {@link LineItem}. // MobileApplicationIds []int64 `xml:"mobileApplicationIds,omitempty" json:"mobileApplicationIds,omitempty"` // // Indicates whether mobile apps should be targeted or excluded. This attribute is optional and // defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` }
type MobileApplicationTargetingError ¶
type MobileApplicationTargetingError struct { *ApiError Reason *MobileApplicationTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type MobileApplicationTargetingError_Reason ¶
type MobileApplicationTargetingError_Reason string
const ( // // Only applications that are linked to a store entry may be targeted. // MobileApplicationTargetingError_ReasonCANNOT_TARGET_UNLINKED_APPLICATION MobileApplicationTargetingError_Reason = "CANNOT_TARGET_UNLINKED_APPLICATION" // // The value returned if the actual value is not exposed by the requested API version. // MobileApplicationTargetingError_ReasonUNKNOWN MobileApplicationTargetingError_Reason = "UNKNOWN" )
type MobileCarrier ¶
type MobileCarrier struct {
*Technology
}
type MobileCarrierTargeting ¶
type MobileCarrierTargeting struct { // // Indicates whether mobile carriers should be targeted or excluded. This attribute is optional // and defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // Mobile carriers that are being targeted or excluded by the {@link LineItem}. // MobileCarriers []*Technology `xml:"mobileCarriers,omitempty" json:"mobileCarriers,omitempty"` }
type MobileDevice ¶
type MobileDevice struct { *Technology // // Manufacturer Id. // ManufacturerCriterionId int64 `xml:"manufacturerCriterionId,omitempty" json:"manufacturerCriterionId,omitempty"` }
type MobileDeviceSubmodel ¶
type MobileDeviceSubmodel struct { *Technology // // The mobile device id. // MobileDeviceCriterionId int64 `xml:"mobileDeviceCriterionId,omitempty" json:"mobileDeviceCriterionId,omitempty"` // // The device manufacturer id. // DeviceManufacturerCriterionId int64 `xml:"deviceManufacturerCriterionId,omitempty" json:"deviceManufacturerCriterionId,omitempty"` }
type MobileDeviceSubmodelTargeting ¶
type MobileDeviceSubmodelTargeting struct { // // Mobile device submodels that are being targeted by the {@link LineItem}. // TargetedMobileDeviceSubmodels []*Technology `xml:"targetedMobileDeviceSubmodels,omitempty" json:"targetedMobileDeviceSubmodels,omitempty"` // // Mobile device submodels that are being excluded by the {@link LineItem}. // ExcludedMobileDeviceSubmodels []*Technology `xml:"excludedMobileDeviceSubmodels,omitempty" json:"excludedMobileDeviceSubmodels,omitempty"` }
type MobileDeviceTargeting ¶
type MobileDeviceTargeting struct { // // Mobile devices that are being targeted by the {@link LineItem}. // TargetedMobileDevices []*Technology `xml:"targetedMobileDevices,omitempty" json:"targetedMobileDevices,omitempty"` // // Mobile devices that are being excluded by the {@link LineItem}. // ExcludedMobileDevices []*Technology `xml:"excludedMobileDevices,omitempty" json:"excludedMobileDevices,omitempty"` }
type Money ¶
type Money struct { // // Three letter currency code in string format. // CurrencyCode string `xml:"currencyCode,omitempty" json:"currencyCode,omitempty"` // // Money values are always specified in terms of micros which are a millionth // of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros. // MicroAmount int64 `xml:"microAmount,omitempty" json:"microAmount,omitempty"` }
type NegotiationRole ¶
type NegotiationRole string
const ( NegotiationRoleBUYER NegotiationRole = "BUYER" NegotiationRoleSELLER NegotiationRole = "SELLER" NegotiationRoleUNKNOWN NegotiationRole = "UNKNOWN" )
type NielsenCtvPacingType ¶
type NielsenCtvPacingType string
const ( // // The value returned if the actual value is not exposed by the requested API version. // NielsenCtvPacingTypeUNKNOWN NielsenCtvPacingType = "UNKNOWN" // // The value returned if Nielsen measurement is disabled for connected devices. // NielsenCtvPacingTypeNONE NielsenCtvPacingType = "NONE" // // Indicates that Nielsen impressions on connected devices are included, and we apply coviewing in // pacing. // NielsenCtvPacingTypeCOVIEW NielsenCtvPacingType = "COVIEW" // // Indicates that Nielsen impressions on connected devices are included, and we apply strict // coviewing in pacing. // NielsenCtvPacingTypeSTRICT_COVIEW NielsenCtvPacingType = "STRICT_COVIEW" )
type NotNullError ¶
type NotNullError struct { *ApiError // // The error reason represented by an enum. // Reason *NotNullError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type NotNullError_Reason ¶
type NotNullError_Reason string
const ( // // Assuming that a method will not have more than 3 arguments, if it does, // return NULL // NotNullError_ReasonARG1_NULL NotNullError_Reason = "ARG1_NULL" NotNullError_ReasonARG2_NULL NotNullError_Reason = "ARG2_NULL" NotNullError_ReasonARG3_NULL NotNullError_Reason = "ARG3_NULL" NotNullError_ReasonNULL NotNullError_Reason = "NULL" // // The value returned if the actual value is not exposed by the requested API version. // NotNullError_ReasonUNKNOWN NotNullError_Reason = "UNKNOWN" )
type NullError ¶
type NullError struct { *ApiError // // The error reason represented by an enum. // Reason *NullError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type NullError_Reason ¶
type NullError_Reason string
const ( // // Specified list/container must not contain any null elements // NullError_ReasonNULL_CONTENT NullError_Reason = "NULL_CONTENT" )
type NumberValue ¶
type NumberValue struct { // // The numeric value represented as a string. // Value string `xml:"value,omitempty" json:"value,omitempty"` // contains filtered or unexported fields }
type ObjectValue ¶
type ObjectValue struct {
// contains filtered or unexported fields
}
type OperatingSystem ¶
type OperatingSystem struct {
*Technology
}
type OperatingSystemTargeting ¶
type OperatingSystemTargeting struct { // // Indicates whether operating systems should be targeted or excluded. This attribute is optional // and defaults to {@code true}. // IsTargeted bool `xml:"isTargeted,omitempty" json:"isTargeted,omitempty"` // // Operating systems that are being targeted or excluded by the {@link LineItem}. // OperatingSystems []*Technology `xml:"operatingSystems,omitempty" json:"operatingSystems,omitempty"` }
type OperatingSystemVersion ¶
type OperatingSystemVersion struct { *Technology // // The operating system major version. // MajorVersion int32 `xml:"majorVersion,omitempty" json:"majorVersion,omitempty"` // // The operating system minor version. // MinorVersion int32 `xml:"minorVersion,omitempty" json:"minorVersion,omitempty"` // // The operating system micro version. // MicroVersion int32 `xml:"microVersion,omitempty" json:"microVersion,omitempty"` }
type OperatingSystemVersionTargeting ¶
type OperatingSystemVersionTargeting struct { // // Operating system versions that are being targeted by the {@link LineItem}. // TargetedOperatingSystemVersions []*Technology `xml:"targetedOperatingSystemVersions,omitempty" json:"targetedOperatingSystemVersions,omitempty"` // // Operating system versions that are being excluded by the {@link LineItem}. // ExcludedOperatingSystemVersions []*Technology `xml:"excludedOperatingSystemVersions,omitempty" json:"excludedOperatingSystemVersions,omitempty"` }
type OrderActionError ¶
type OrderActionError struct { *ApiError // // The error reason represented by an enum. // Reason *OrderActionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type OrderActionError_Reason ¶
type OrderActionError_Reason string
const ( // // The operation is not allowed due to lack of permissions. // OrderActionError_ReasonPERMISSION_DENIED OrderActionError_Reason = "PERMISSION_DENIED" // // The operation is not applicable for the current state of the // {@link Order}. // OrderActionError_ReasonNOT_APPLICABLE OrderActionError_Reason = "NOT_APPLICABLE" // // The {@link Order} is archived, an {@link OrderAction} cannot be applied // to an archived order. // OrderActionError_ReasonIS_ARCHIVED OrderActionError_Reason = "IS_ARCHIVED" // // The {@link Order} is past its end date, An {@link OrderAction} cannot // be applied to a order that has ended. // OrderActionError_ReasonHAS_ENDED OrderActionError_Reason = "HAS_ENDED" // // A {@link Order} cannot be approved if it contains reservable // {@link LineItem}s that are unreserved. // OrderActionError_ReasonCANNOT_APPROVE_WITH_UNRESERVED_LINE_ITEMS OrderActionError_Reason = "CANNOT_APPROVE_WITH_UNRESERVED_LINE_ITEMS" // // Deleting an {@link Order} with delivered line items is not allowed // OrderActionError_ReasonCANNOT_DELETE_ORDER_WITH_DELIVERED_LINEITEMS OrderActionError_Reason = "CANNOT_DELETE_ORDER_WITH_DELIVERED_LINEITEMS" // // Cannot approve because company credit status is not active. // OrderActionError_ReasonCANNOT_APPROVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE OrderActionError_Reason = "CANNOT_APPROVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE" // // The value returned if the actual value is not exposed by the requested API version. // OrderActionError_ReasonUNKNOWN OrderActionError_Reason = "UNKNOWN" )
type OrderError ¶
type OrderError struct { *ApiError // // The error reason represented by an enum. // Reason *OrderError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type OrderError_Reason ¶
type OrderError_Reason string
const ( // // Updating a canceled order is not allowed. // OrderError_ReasonUPDATE_CANCELED_ORDER_NOT_ALLOWED OrderError_Reason = "UPDATE_CANCELED_ORDER_NOT_ALLOWED" // // Updating an order that has its approval pending is not allowed. // OrderError_ReasonUPDATE_PENDING_APPROVAL_ORDER_NOT_ALLOWED OrderError_Reason = "UPDATE_PENDING_APPROVAL_ORDER_NOT_ALLOWED" // // Updating an archived order is not allowed. // OrderError_ReasonUPDATE_ARCHIVED_ORDER_NOT_ALLOWED OrderError_Reason = "UPDATE_ARCHIVED_ORDER_NOT_ALLOWED" // // DSM can set the proposal ID only at the time of creation of order. // Setting or changing proposal ID at the time of order update is not // allowed. // OrderError_ReasonCANNOT_MODIFY_PROPOSAL_ID OrderError_Reason = "CANNOT_MODIFY_PROPOSAL_ID" // // Cannot have secondary user without a primary user. // OrderError_ReasonPRIMARY_USER_REQUIRED OrderError_Reason = "PRIMARY_USER_REQUIRED" // // Primary user cannot be added as a secondary user too. // OrderError_ReasonPRIMARY_USER_CANNOT_BE_SECONDARY OrderError_Reason = "PRIMARY_USER_CANNOT_BE_SECONDARY" // // A team associated with the order must also be associated with the // advertiser. // OrderError_ReasonORDER_TEAM_NOT_ASSOCIATED_WITH_ADVERTISER OrderError_Reason = "ORDER_TEAM_NOT_ASSOCIATED_WITH_ADVERTISER" // // The user assigned to the order, like salesperson or trafficker, must // be on one of the order's teams. // OrderError_ReasonUSER_NOT_ON_ORDERS_TEAMS OrderError_Reason = "USER_NOT_ON_ORDERS_TEAMS" // // The agency assigned to the order must belong to one of the order's teams. // OrderError_ReasonAGENCY_NOT_ON_ORDERS_TEAMS OrderError_Reason = "AGENCY_NOT_ON_ORDERS_TEAMS" // // Programmatic info fields should not be set for a non-programmatic order. // OrderError_ReasonINVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_ORDER OrderError_Reason = "INVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_ORDER" // // The value returned if the actual value is not exposed by the requested API version. // OrderError_ReasonUNKNOWN OrderError_Reason = "UNKNOWN" )
type PacingDeviceCategorizationType ¶
type PacingDeviceCategorizationType string
const ( // // The value returned if the actual value is not exposed by the requested API version. // PacingDeviceCategorizationTypeUNKNOWN PacingDeviceCategorizationType = "UNKNOWN" // // Use Google's device categorization in auto-pacing. // PacingDeviceCategorizationTypeGOOGLE PacingDeviceCategorizationType = "GOOGLE" // // Use Nielsen device categorization in auto-pacing // PacingDeviceCategorizationTypeNIELSEN PacingDeviceCategorizationType = "NIELSEN" )
type ParseError ¶
type ParseError struct { *ApiError // // The error reason represented by an enum. // Reason *ParseError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type ParseError_Reason ¶
type ParseError_Reason string
const ( // // Indicates an error in parsing an attribute. // ParseError_ReasonUNPARSABLE ParseError_Reason = "UNPARSABLE" // // The value returned if the actual value is not exposed by the requested API version. // ParseError_ReasonUNKNOWN ParseError_Reason = "UNKNOWN" )
type PermissionError ¶
type PermissionError struct { *ApiError Reason *PermissionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type PermissionError_Reason ¶
type PermissionError_Reason string
const ( // // User does not have the required permission for the request. // PermissionError_ReasonPERMISSION_DENIED PermissionError_Reason = "PERMISSION_DENIED" // // The value returned if the actual value is not exposed by the requested API version. // PermissionError_ReasonUNKNOWN PermissionError_Reason = "UNKNOWN" )
type PrecisionError ¶
type PrecisionError struct { *ApiError Reason *PrecisionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type PrecisionError_Reason ¶
type PrecisionError_Reason string
const ( // // The lowest N digits of the number must be zero. // PrecisionError_ReasonWRONG_PRECISION PrecisionError_Reason = "WRONG_PRECISION" // // The value returned if the actual value is not exposed by the requested API version. // PrecisionError_ReasonUNKNOWN PrecisionError_Reason = "UNKNOWN" )
type ProgrammaticCreativeSource ¶
type ProgrammaticCreativeSource string
const ( // // Indicates that the programmatic line item is associated with creatives provided by // the publisher. // ProgrammaticCreativeSourcePUBLISHER ProgrammaticCreativeSource = "PUBLISHER" // // Indicates that the programmatic line item is associated with creatives provided by // the advertiser. // ProgrammaticCreativeSourceADVERTISER ProgrammaticCreativeSource = "ADVERTISER" // // The value returned if the actual value is not exposed by the requested API version. // ProgrammaticCreativeSourceUNKNOWN ProgrammaticCreativeSource = "UNKNOWN" )
type ProgrammaticError ¶
type ProgrammaticError struct { *ApiError // // The error reason represented by an enum. // Reason *ProgrammaticError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type ProgrammaticError_Reason ¶
type ProgrammaticError_Reason string
const ( // // Audience extension is not supported by programmatic line items. // ProgrammaticError_ReasonAUDIENCE_EXTENSION_NOT_SUPPORTED ProgrammaticError_Reason = "AUDIENCE_EXTENSION_NOT_SUPPORTED" // // Auto extension days is not supported by programmatic line items. // ProgrammaticError_ReasonAUTO_EXTENSION_DAYS_NOT_SUPPORTED ProgrammaticError_Reason = "AUTO_EXTENSION_DAYS_NOT_SUPPORTED" // // Video is currently not supported. // ProgrammaticError_ReasonVIDEO_NOT_SUPPORTED ProgrammaticError_Reason = "VIDEO_NOT_SUPPORTED" // // Roadblocking is not supported by programmatic line items. // ProgrammaticError_ReasonROADBLOCKING_NOT_SUPPORTED ProgrammaticError_Reason = "ROADBLOCKING_NOT_SUPPORTED" // // Programmatic line items do not support {@link CreativeRotationType#SEQUENTIAL}. // ProgrammaticError_ReasonINVALID_CREATIVE_ROTATION ProgrammaticError_Reason = "INVALID_CREATIVE_ROTATION" // // Programmatic line items only support {@link LineItemType#STANDARD} and // {@link LineItemType#SPONSORSHIP} if the relevant feature is on. // ProgrammaticError_ReasonINVALID_LINE_ITEM_TYPE ProgrammaticError_Reason = "INVALID_LINE_ITEM_TYPE" // // Programmatic line items only support {@link CostType#CPM}. // ProgrammaticError_ReasonINVALID_COST_TYPE ProgrammaticError_Reason = "INVALID_COST_TYPE" // // Programmatic line items only support a creative size that is supported by AdX. // The list of supported sizes is maintained based on the list published in the help docs: // <a href="https://support.google.com/adxseller/answer/1100453"> // https://support.google.com/adxseller/answer/1100453</a> // ProgrammaticError_ReasonSIZE_NOT_SUPPORTED ProgrammaticError_Reason = "SIZE_NOT_SUPPORTED" // // Zero cost per unit is not supported by programmatic line items. // ProgrammaticError_ReasonZERO_COST_PER_UNIT_NOT_SUPPORTED ProgrammaticError_Reason = "ZERO_COST_PER_UNIT_NOT_SUPPORTED" // // Some fields cannot be updated on approved line items. // ProgrammaticError_ReasonCANNOT_UPDATE_FIELD_FOR_APPROVED_LINE_ITEMS ProgrammaticError_Reason = "CANNOT_UPDATE_FIELD_FOR_APPROVED_LINE_ITEMS" // // Creating a new line item in an approved order is not allowed. // ProgrammaticError_ReasonCANNOT_CREATE_LINE_ITEM_FOR_APPROVED_ORDER ProgrammaticError_Reason = "CANNOT_CREATE_LINE_ITEM_FOR_APPROVED_ORDER" // // Cannot change backfill web property for a programmatic line item whose order has been // approved. // ProgrammaticError_ReasonCANNOT_UPDATE_BACKFILL_WEB_PROPERTY_FOR_APPROVED_LINE_ITEMS ProgrammaticError_Reason = "CANNOT_UPDATE_BACKFILL_WEB_PROPERTY_FOR_APPROVED_LINE_ITEMS" // // Cost per unit is too low. It has to be at least 0.005 USD. // ProgrammaticError_ReasonCOST_PER_UNIT_TOO_LOW ProgrammaticError_Reason = "COST_PER_UNIT_TOO_LOW" // // The value returned if the actual value is not exposed by the requested API version. // ProgrammaticError_ReasonUNKNOWN ProgrammaticError_Reason = "UNKNOWN" )
type ProposalLineItem ¶
type ProposalLineItem struct { // // The unique ID of the {@code ProposalLineItem}. // This attribute is read-only. // Id int64 `xml:"id,omitempty" json:"id,omitempty"` // // The unique ID of the {@link Proposal}, to which the {@code ProposalLineItem} belongs. This // attribute is required for creation and then is readonly. // <span class="constraint Required">This attribute is required.</span> // ProposalId int64 `xml:"proposalId,omitempty" json:"proposalId,omitempty"` // // The name of the {@code ProposalLineItem} which should be unique under the same {@link // Proposal}. This attribute has a maximum length of 255 characters. This attribute can be // configured as editable after the proposal has been submitted. Please check with your network // administrator for editable fields configuration. // <span class="constraint Required">This attribute is required.</span> // Name string `xml:"name,omitempty" json:"name,omitempty"` // // The date and time at which the line item associated with the {@code ProposalLineItem} is // enabled to begin serving. This attribute is optional during creation, but required and must be // in the future when it turns into a line item. The {@link DateTime#timeZoneID} is required if // start date time is not {@code null}. This attribute becomes readonly once the {@code // ProposalLineItem} has started delivering. // StartDateTime soap.XSDDateTime `xml:"startDateTime,omitempty" json:"startDateTime,omitempty"` // // The date and time at which the line item associated with the {@code ProposalLineItem} stops // beening served. This attribute is optional during creation, but required and must be after the // {@link #startDateTime}. The {@link DateTime#timeZoneID} is required if end date time is not // {@code null}. // EndDateTime soap.XSDDateTime `xml:"endDateTime,omitempty" json:"endDateTime,omitempty"` // // The time zone ID in tz database format (e.g. "America/Los_Angeles") for this {@code // ProposalLineItem}. The number of serving days is calculated in this time zone. So if {@link // #rateType} is {@link RateType#CPD}, it will affect the cost calculation. The {@link // #startDateTime} and {@link #endDateTime} will be returned in this time zone. This attribute is // optional and defaults to the network's time zone. // This attribute is read-only. // TimeZoneId string `xml:"timeZoneId,omitempty" json:"timeZoneId,omitempty"` // // Provides any additional notes that may annotate the {@code ProposalLineItem}. This attribute is // optional and has a maximum length of 65,535 characters. This attribute can be configured as // editable after the proposal has been submitted. Please check with your network administrator // for editable fields configuration. // InternalNotes string `xml:"internalNotes,omitempty" json:"internalNotes,omitempty"` // // The archival status of the {@code ProposalLineItem}. // This attribute is read-only. // IsArchived bool `xml:"isArchived,omitempty" json:"isArchived,omitempty"` // // The goal(i.e. contracted quantity, quantity or limit) that this {@code ProposalLineItem} is // associated with, which is used in its pacing and budgeting. {@link Goal#units} must be greater // than 0 when the proposal line item turns into a line item, {@link Goal#goalType} and {@link // Goal#unitType} are readonly. For a Preferred deal {@code ProposalLineItem}, the goal type can // only be {@link GoalType#NONE}. // <span class="constraint Required">This attribute is required.</span> // Goal *Goal `xml:"goal,omitempty" json:"goal,omitempty"` // // The secondary goals that this {@code ProposalLineItem} is associated with. For a programmatic // line item with the properties {@link RateType#CPM} and {@link LineItemType#SPONSORSHIP}, this // field will have one goal which describes the impressions cap. For other cases, this field is an // empty list. // SecondaryGoals []*Goal `xml:"secondaryGoals,omitempty" json:"secondaryGoals,omitempty"` // // The contracted number of daily minimum impressions used for {@link LineItemType#SPONSORSHIP} // {@code ProposalLineItem} deals with a rate type of {@link RateType#CPD}. // // <p>This attribute is required for percentage-based-goal {@link ProposalLineItem proposal line // items}. It does not impact ad-serving and is for reporting purposes only. // ContractedUnitsBought int64 `xml:"contractedUnitsBought,omitempty" json:"contractedUnitsBought,omitempty"` // // The strategy for delivering ads over the course of the {@code ProposalLineItem}'s duration. // This attribute is required. For a Preferred deal {@code ProposalLineItem}, the value can only // be {@link DeliveryRateType#FRONTLOADED}. // DeliveryRateType *DeliveryRateType `xml:"deliveryRateType,omitempty" json:"deliveryRateType,omitempty"` // // The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be // served together on a single web page. This attribute is optional during creation and defaults // to the {@link Product#roadblockingType product's roadblocking type}, or {@link // RoadblockingType#ONE_OR_MORE} if not specified by the product. // RoadblockingType *RoadblockingType `xml:"roadblockingType,omitempty" json:"roadblockingType,omitempty"` // // The delivery option for companions. This is only valid if the roadblocking type is {@link // RoadblockingType#CREATIVE_SET}. The default value for roadblocking creatives is {@link // CompanionDeliveryOption#OPTIONAL}. The default value in other cases is {@link // CompanionDeliveryOption#UNKNOWN}. Providing something other than {@link // CompanionDeliveryOption#UNKNOWN} will cause an error. // CompanionDeliveryOption *CompanionDeliveryOption `xml:"companionDeliveryOption,omitempty" json:"companionDeliveryOption,omitempty"` // // The max duration of a video creative associated with this {@code ProposalLineItem} in // milliseconds. This attribute is optional, defaults to the {@link Product#videoMaxDuration} on // the {@link Product} it was created with, and only meaningful if this is a video proposal line // item. // VideoMaxDuration int64 `xml:"videoMaxDuration,omitempty" json:"videoMaxDuration,omitempty"` // // The proposal line item's creatives' skippability. This attribute is optional, only applicable // for video proposal line items, and defaults to {@link SkippableAdType#NOT_SKIPPABLE}. // VideoCreativeSkippableAdType *SkippableAdType `xml:"videoCreativeSkippableAdType,omitempty" json:"videoCreativeSkippableAdType,omitempty"` // // The set of frequency capping units for this {@code ProposalLineItem}. This attribute is // optional during creation and defaults to the {@link Product#frequencyCaps product's frequency // caps} if {@link Product#allowFrequencyCapsCustomization} is {@code false}. // FrequencyCaps []*FrequencyCap `xml:"frequencyCaps,omitempty" json:"frequencyCaps,omitempty"` // // The unique ID of corresponding {@link LineItem}. This will be {@code null} if the {@link // Proposal} has not been pushed to Ad Manager. // This attribute is read-only. // DfpLineItemId int64 `xml:"dfpLineItemId,omitempty" json:"dfpLineItemId,omitempty"` // // The corresponding {@link LineItemType} of the {@code ProposalLineItem}. For a programmatic // {@code ProposalLineItem}, the value can only be one of: // // <ul> // <li>{@link LineItemType#SPONSORSHIP} // <li>{@link LineItemType#STANDARD} // <li>{@link LineItemType#PREFERRED_DEAL} // </ul> // <span class="constraint Required">This attribute is required.</span> // LineItemType *LineItemType `xml:"lineItemType,omitempty" json:"lineItemType,omitempty"` // // The priority for the corresponding {@link LineItem} of the {@code ProposalLineItem}. This // attribute is optional during creation and defaults to the default priority of the {@link // #lineItemType}. For forecasting, this attribute is optional and has a default value assigned by // Google. See {@link LineItem#priority} for more information. // LineItemPriority int32 `xml:"lineItemPriority,omitempty" json:"lineItemPriority,omitempty"` // // The method used for billing the {@code ProposalLineItem}. // This attribute is read-only. // <span class="constraint Required">This attribute is required.</span> // RateType *RateType `xml:"rateType,omitempty" json:"rateType,omitempty"` // // Details about the creatives that are expected to serve through the {@code ProposalLineItem}. // This attribute is optional during creation and defaults to the {@link // Product#creativePlaceholders product's creative placeholders}. // <span class="constraint Required">This attribute is required.</span> // CreativePlaceholders []*CreativePlaceholder `xml:"creativePlaceholders,omitempty" json:"creativePlaceholders,omitempty"` // // Contains the targeting criteria for the {@code ProposalLineItem}. // <span class="constraint Required">This attribute is required.</span> // Targeting *Targeting `xml:"targeting,omitempty" json:"targeting,omitempty"` // // The values of the custom fields associated with the {@code ProposalLineItem}. This attribute is // optional. This attribute can be configured as editable after the proposal has been submitted. // Please check with your network administrator for editable fields configuration. // CustomFieldValues []*BaseCustomFieldValue `xml:"customFieldValues,omitempty" json:"customFieldValues,omitempty"` // // The set of labels applied directly to the {@code ProposalLineItem}. This attribute is optional. // AppliedLabels []*AppliedLabel `xml:"appliedLabels,omitempty" json:"appliedLabels,omitempty"` // // Contains the set of labels applied directly to the proposal as well as those inherited ones. If // a label has been negated, only the negated label is returned. // This attribute is read-only. // EffectiveAppliedLabels []*AppliedLabel `xml:"effectiveAppliedLabels,omitempty" json:"effectiveAppliedLabels,omitempty"` // // If a line item has a series of competitive exclusions on it, it could be blocked from serving // with line items from the same advertiser. Setting this to {@code true} will allow line items // from the same advertiser to serve regardless of the other competitive exclusion labels being // applied. // // <p>This attribute is optional and defaults to false. // DisableSameAdvertiserCompetitiveExclusion bool `xml:"disableSameAdvertiserCompetitiveExclusion,omitempty" json:"disableSameAdvertiserCompetitiveExclusion,omitempty"` // // Indicates whether this {@code ProposalLineItem} has been sold. // This attribute is read-only. // IsSold bool `xml:"isSold,omitempty" json:"isSold,omitempty"` // // The amount of money to spend per impression or click in proposal currency. It supports // precision of 4 decimal places in terms of the fundamental currency unit, so the {@link // Money#getAmountInMicros} must be multiples of 100. It doesn't include agency commission. // // <p>For example, if {@link Proposal#currencyCode} is 'USD', then $123.4567 could be represented // as 123456700, but further precision is not supported. // // <p>At least one of the two fields {@link ProposalLineItem#netRate},and {@link // ProposalLineItem#netCost} is required. // NetRate *Money `xml:"netRate,omitempty" json:"netRate,omitempty"` // // The cost of the {@code ProposalLineItem} in proposal currency. It supports precision of 2 // decimal places in terms of the fundamental currency unit, so the {@link // Money#getAmountInMicros} must be multiples of 10000. It doesn't include agency commission. // // <p>For example, if {@link Proposal#currencyCode} is 'USD', then $123.45 could be represented as // 123450000, but further precision is not supported. // // <p>At least one of the two fields {@link ProposalLineItem#netRate} and {@link // ProposalLineItem#netCost} is required. // NetCost *Money `xml:"netCost,omitempty" json:"netCost,omitempty"` // // Indicates how well the line item generated from this proposal line item has been performing. // This will be {@code null} if the delivery indicator information is not available due to one of // the following reasons: // // <ol> // <li>The proposal line item has not pushed to Ad Manager. // <li>The line item is not delivering. // <li>The line item has an unlimited goal or cap. // <li>The line item has a percentage based goal or cap. // </ol> // This attribute is read-only. // DeliveryIndicator *DeliveryIndicator `xml:"deliveryIndicator,omitempty" json:"deliveryIndicator,omitempty"` // // Delivery data provides the number of clicks or impressions delivered for the {@link LineItem} // generated from this proposal line item in the last 7 days. This will be {@code null} if the // delivery data cannot be computed due to one of the following reasons: // // <ol> // <li>The proposal line item has not pushed to Ad Manager. // <li>The line item is not deliverable. // <li>The line item has completed delivering more than 7 days ago. // <li>The line item has an absolute-based goal. {@link ProposalLineItem#deliveryIndicator} // should be used to track its progress in this case. // This attribute is read-only. // DeliveryData *DeliveryData `xml:"deliveryData,omitempty" json:"deliveryData,omitempty"` // // The status of the {@link LineItem} generated from this proposal line item. This will be {@code // null} if the proposal line item has not pushed to Ad Manager. // This attribute is read-only. // ComputedStatus *ComputedStatus `xml:"computedStatus,omitempty" json:"computedStatus,omitempty"` // // The date and time this {@code ProposalLineItem} was last modified. // // <p>This attribute is assigned by Google when a {@code ProposalLineItem} is updated. // This attribute is read-only. // LastModifiedDateTime soap.XSDDateTime `xml:"lastModifiedDateTime,omitempty" json:"lastModifiedDateTime,omitempty"` // // The reservation status of the {@link ProposalLineItem}. // This attribute is read-only. // ReservationStatus *ReservationStatus `xml:"reservationStatus,omitempty" json:"reservationStatus,omitempty"` // // The last {@link DateTime} when the {@link ProposalLineItem} reserved inventory. // This attribute is read-only. // LastReservationDateTime soap.XSDDateTime `xml:"lastReservationDateTime,omitempty" json:"lastReservationDateTime,omitempty"` // // The environment that the {@code ProposalLineItem} is targeting. The default value is {@link // EnvironmentType#BROWSER}. If this value is {@link EnvironmentType#VIDEO_PLAYER}, then this // {@code ProposalLineItem} can only target {@link AdUnit ad units} that have {@link AdUnitSize // sizes} whose {@link AdUnitSize#environmentType} is also {@link EnvironmentType#VIDEO_PLAYER}. // // <p>This field is read-only and set to {@link Product#environmentType} of the product this // proposal line item was created from. // EnvironmentType *EnvironmentType `xml:"environmentType,omitempty" json:"environmentType,omitempty"` // // The set of {@link AllowedFormats} that this proposal line item can have. If the set is empty, // this proposal line item allows all formats. // AllowedFormats []*AllowedFormats `xml:"allowedFormats,omitempty" json:"allowedFormats,omitempty"` // // Whether or not the {@link Proposal} for this {@code ProposalLineItem} is a programmatic deal. // This attribute is populated from {@link Proposal#isProgrammatic}. // This attribute is read-only. // IsProgrammatic bool `xml:"isProgrammatic,omitempty" json:"isProgrammatic,omitempty"` // // Additional terms shown to the buyer in Marketplace. // AdditionalTerms string `xml:"additionalTerms,omitempty" json:"additionalTerms,omitempty"` // // Indicates the {@link ProgrammaticCreativeSource} of the programmatic line item. // ProgrammaticCreativeSource *ProgrammaticCreativeSource `xml:"programmaticCreativeSource,omitempty" json:"programmaticCreativeSource,omitempty"` // // Contains the information for a proposal line item which has a target GRP demographic. // GrpSettings *GrpSettings `xml:"grpSettings,omitempty" json:"grpSettings,omitempty"` // // The estimated minimum impressions that should be delivered for a proposal line item. // EstimatedMinimumImpressions int64 `xml:"estimatedMinimumImpressions,omitempty" json:"estimatedMinimumImpressions,omitempty"` // // Contains third party measurement settings for cross-sell Partners // ThirdPartyMeasurementSettings *ThirdPartyMeasurementSettings `xml:"thirdPartyMeasurementSettings,omitempty" json:"thirdPartyMeasurementSettings,omitempty"` // // Makegood info for this proposal line item. Immutable once created. // // <p>Null if this proposal line item is not a makegood. // MakegoodInfo *ProposalLineItemMakegoodInfo `xml:"makegoodInfo,omitempty" json:"makegoodInfo,omitempty"` // // Whether this proposal line item has an associated makegood. // This attribute is read-only. // HasMakegood bool `xml:"hasMakegood,omitempty" json:"hasMakegood,omitempty"` // // Whether a new makegood associated with this line item can be created. // This attribute is read-only. // CanCreateMakegood bool `xml:"canCreateMakegood,omitempty" json:"canCreateMakegood,omitempty"` // // The {@link NegotiationRole} that paused the proposal line item, i.e. {@link // NegotiationRole#seller} or {@link NegotiationRole#buyer}, or {@code null} when the proposal is // not paused. // This attribute is read-only. // PauseRole *NegotiationRole `xml:"pauseRole,omitempty" json:"pauseRole,omitempty"` // // The reason for pausing the {@link ProposalLineItem}, provided by the {@link pauseRole}. It is // {@code null} when the {@link ProposalLineItem} is not paused. // This attribute is read-only. // PauseReason string `xml:"pauseReason,omitempty" json:"pauseReason,omitempty"` }
type ProposalLineItemMakegoodInfo ¶
type ProposalLineItemMakegoodInfo struct { // // The ID of the original proposal line item on which this makegood is based. // This attribute is read-only. // OriginalProposalLineItemId int64 `xml:"originalProposalLineItemId,omitempty" json:"originalProposalLineItemId,omitempty"` // // The publisher-provided reason why this makegood was initiated. This is free form text. // // <p>The following predefined values can be used to render predefined options in the UI. // // <p>UNDERDELIVERY: 'Impression underdelivery', SECONDARY_DELIVERY_TERMS: 'Did not meet secondary // delivery terms ', PERFORMANCE: 'Performance issues', // Reason string `xml:"reason,omitempty" json:"reason,omitempty"` }
type ProspectiveLineItem ¶
type ProspectiveLineItem struct { // // The target of the forecast. If {@link LineItem#id} is null or no line item exists with that ID, // then a forecast is computed for the subject, predicting what would happen if it were added to // the network. If a line item already exists with {@link LineItem#id}, the forecast is computed // for the subject, predicting what would happen if the existing line item's settings were // modified to match the subject. // LineItem *LineItem `xml:"lineItem,omitempty" json:"lineItem,omitempty"` // // The target of the forecast if this prospective line item is a proposal line item. // // <p>If {@link ProposalLineItem#id} is null or no proposal line item exists with that ID, then a // forecast is computed for the subject, predicting what would happen if it were added to the // network. If a proposal line item already exists with {@link ProposalLineItem#id}, the forecast // is computed for the subject, predicting what would happen if the existing proposal line item's // settings were modified to match the subject. // // <p>A proposal line item can optionally correspond to an order {@link LineItem}, in which case, // by forecasting a proposal line item, the corresponding line item is implicitly ignored in the // forecasting. // // <p>Either {@link #lineItem} or {@link #proposalLineItem} should be specified but not both. // ProposalLineItem *ProposalLineItem `xml:"proposalLineItem,omitempty" json:"proposalLineItem,omitempty"` // // When set, the line item is assumed to be from this advertiser, and unified blocking rules will // apply accordingly. If absent, line items without an existing order won't be subject to unified // blocking rules. // AdvertiserId int64 `xml:"advertiserId,omitempty" json:"advertiserId,omitempty"` }
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 RateType ¶
type RateType string
const ( // // The rate applies to cost per mille (CPM) revenue. // RateTypeCPM RateType = "CPM" // // The rate applies to cost per click (CPC) revenue. // RateTypeCPC RateType = "CPC" // // The rate applies to cost per day (CPD) revenue. // RateTypeCPD RateType = "CPD" // // The rate applies to cost per unit (CPU) revenue. // RateTypeCPU RateType = "CPU" // // The rate applies to flat fee revenue. // RateTypeFLAT_FEE RateType = "FLAT_FEE" // // The rate applies to Active View viewable cost per mille (vCPM) revenue. // RateTypeVCPM RateType = "VCPM" // // The rate applies to cost per mille in-target (CPM In-Target). // RateTypeCPM_IN_TARGET RateType = "CPM_IN_TARGET" // // The value returned if the actual value is not exposed by the requested API version. // RateTypeUNKNOWN RateType = "UNKNOWN" )
type RegExError ¶
type RegExError struct { *ApiError // // The error reason represented by an enum. // Reason *RegExError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RegExError_Reason ¶
type RegExError_Reason string
const ( // // Invalid value found. // RegExError_ReasonINVALID RegExError_Reason = "INVALID" // // Null value found. // RegExError_ReasonNULL RegExError_Reason = "NULL" // // The value returned if the actual value is not exposed by the requested API version. // RegExError_ReasonUNKNOWN RegExError_Reason = "UNKNOWN" )
type RequestHeader ¶
type RequestHeader SoapRequestHeader
type RequestPlatform ¶
type RequestPlatform string
const ( // // The value returned if the actual value is not exposed by the requested API version. // RequestPlatformUNKNOWN RequestPlatform = "UNKNOWN" // // Represents a request made from a web browser. This includes both desktop and mobile web. // RequestPlatformBROWSER RequestPlatform = "BROWSER" // // Represents a request made from a mobile application. This includes mobile app interstitial and // rewarded video requests. // RequestPlatformMOBILE_APP RequestPlatform = "MOBILE_APP" // // Represents a request made from a video player that is playing publisher content. This includes // video players embedded in web pages and mobile applications, and connected TV screens. // RequestPlatformVIDEO_PLAYER RequestPlatform = "VIDEO_PLAYER" )
type RequestPlatformTargeting ¶
type RequestPlatformTargeting struct {
TargetedRequestPlatforms []*RequestPlatform `xml:"targetedRequestPlatforms,omitempty" json:"targetedRequestPlatforms,omitempty"`
}
type RequestPlatformTargetingError ¶
type RequestPlatformTargetingError struct { *ApiError // // The error reason represented by an enum. // Reason *RequestPlatformTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RequestPlatformTargetingError_Reason ¶
type RequestPlatformTargetingError_Reason string
const ( // // The line item type does not support the targeted request platform type. // RequestPlatformTargetingError_ReasonREQUEST_PLATFORM_TYPE_NOT_SUPPORTED_BY_LINE_ITEM_TYPE RequestPlatformTargetingError_Reason = "REQUEST_PLATFORM_TYPE_NOT_SUPPORTED_BY_LINE_ITEM_TYPE" // // The line item environment type does not support the targeted request platform type. // RequestPlatformTargetingError_ReasonREQUEST_PLATFORM_TYPE_NOT_SUPPORTED_BY_ENVIRONMENT_TYPE RequestPlatformTargetingError_Reason = "REQUEST_PLATFORM_TYPE_NOT_SUPPORTED_BY_ENVIRONMENT_TYPE" // // The value returned if the actual value is not exposed by the requested API version. // RequestPlatformTargetingError_ReasonUNKNOWN RequestPlatformTargetingError_Reason = "UNKNOWN" )
type RequiredCollectionError ¶
type RequiredCollectionError struct { *ApiError Reason *RequiredCollectionError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RequiredCollectionError_Reason ¶
type RequiredCollectionError_Reason string
const ( // // A required collection is missing. // RequiredCollectionError_ReasonREQUIRED RequiredCollectionError_Reason = "REQUIRED" // // Collection size is too large. // RequiredCollectionError_ReasonTOO_LARGE RequiredCollectionError_Reason = "TOO_LARGE" // // Collection size is too small. // RequiredCollectionError_ReasonTOO_SMALL RequiredCollectionError_Reason = "TOO_SMALL" // // The value returned if the actual value is not exposed by the requested API version. // RequiredCollectionError_ReasonUNKNOWN RequiredCollectionError_Reason = "UNKNOWN" )
type RequiredError ¶
type RequiredError struct { *ApiError // // The error reason represented by an enum. // Reason *RequiredError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RequiredError_Reason ¶
type RequiredError_Reason string
const ( // // Missing required field. // RequiredError_ReasonREQUIRED RequiredError_Reason = "REQUIRED" )
type RequiredNumberError ¶
type RequiredNumberError struct { *ApiError Reason *RequiredNumberError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RequiredNumberError_Reason ¶
type RequiredNumberError_Reason string
const ( RequiredNumberError_ReasonREQUIRED RequiredNumberError_Reason = "REQUIRED" RequiredNumberError_ReasonTOO_LARGE RequiredNumberError_Reason = "TOO_LARGE" RequiredNumberError_ReasonTOO_SMALL RequiredNumberError_Reason = "TOO_SMALL" RequiredNumberError_ReasonTOO_LARGE_WITH_DETAILS RequiredNumberError_Reason = "TOO_LARGE_WITH_DETAILS" RequiredNumberError_ReasonTOO_SMALL_WITH_DETAILS RequiredNumberError_Reason = "TOO_SMALL_WITH_DETAILS" // // The value returned if the actual value is not exposed by the requested API version. // RequiredNumberError_ReasonUNKNOWN RequiredNumberError_Reason = "UNKNOWN" )
type RequiredSizeError ¶
type RequiredSizeError struct { *ApiError Reason *RequiredSizeError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type RequiredSizeError_Reason ¶
type RequiredSizeError_Reason string
const ( // // {@link Creative#size} or {@link LineItem#creativePlaceholders} size is // missing. // RequiredSizeError_ReasonREQUIRED RequiredSizeError_Reason = "REQUIRED" // // {@link LineItemCreativeAssociation#sizes} must be a subset of // {@link LineItem#creativePlaceholders} sizes. // RequiredSizeError_ReasonNOT_ALLOWED RequiredSizeError_Reason = "NOT_ALLOWED" // // The value returned if the actual value is not exposed by the requested API version. // RequiredSizeError_ReasonUNKNOWN RequiredSizeError_Reason = "UNKNOWN" )
type ReservationDetailsError ¶
type ReservationDetailsError struct { *ApiError // // The error reason represented by an enum. // Reason *ReservationDetailsError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type ReservationDetailsError_Reason ¶
type ReservationDetailsError_Reason string
const ( // // There is no limit on the number of ads delivered for a line item when you // set {@link LineItem#duration} to be // {@link LineItemSummary.Duration#NONE}. This can only be set for line // items of type {@link LineItemType#PRICE_PRIORITY}. // ReservationDetailsError_ReasonUNLIMITED_UNITS_BOUGHT_NOT_ALLOWED ReservationDetailsError_Reason = "UNLIMITED_UNITS_BOUGHT_NOT_ALLOWED" // // {@link LineItem#unlimitedEndDateTime} can be set to true for only // line items of type {@link LineItemType#SPONSORSHIP}, // {@link LineItemType#NETWORK}, {@link LineItemType#PRICE_PRIORITY} and // {@link LineItemType#HOUSE}. // ReservationDetailsError_ReasonUNLIMITED_END_DATE_TIME_NOT_ALLOWED ReservationDetailsError_Reason = "UNLIMITED_END_DATE_TIME_NOT_ALLOWED" // // When {@link LineItem#lineItemType} is // {@link LineItemType#SPONSORSHIP}, then // {@link LineItem#unitsBought} represents the percentage of // available impressions reserved. That value cannot exceed 100. // ReservationDetailsError_ReasonPERCENTAGE_UNITS_BOUGHT_TOO_HIGH ReservationDetailsError_Reason = "PERCENTAGE_UNITS_BOUGHT_TOO_HIGH" // // The line item type does not support the specified duration. See // {@link LineItemSummary.Duration} for allowed values. // ReservationDetailsError_ReasonDURATION_NOT_ALLOWED ReservationDetailsError_Reason = "DURATION_NOT_ALLOWED" // // The {@link LineItem#unitType} is not allowed for the given // {@link LineItem#lineItemType}. See {@link UnitType} for allowed // values. // ReservationDetailsError_ReasonUNIT_TYPE_NOT_ALLOWED ReservationDetailsError_Reason = "UNIT_TYPE_NOT_ALLOWED" // // The {@link LineItem#costType} is not allowed for the // {@link LineItem#lineItemType}. See {@link CostType} for allowed // values. // ReservationDetailsError_ReasonCOST_TYPE_NOT_ALLOWED ReservationDetailsError_Reason = "COST_TYPE_NOT_ALLOWED" // // When {@link LineItem#costType} is {@link CostType#CPM}, // {@link LineItem#unitType} must be {@link UnitType#IMPRESSIONS} // and when {@link LineItem#costType} is {@link CostType#CPC}, // {@link LineItem#unitType} must be {@link UnitType#CLICKS}. // ReservationDetailsError_ReasonCOST_TYPE_UNIT_TYPE_MISMATCH_NOT_ALLOWED ReservationDetailsError_Reason = "COST_TYPE_UNIT_TYPE_MISMATCH_NOT_ALLOWED" // // Inventory cannot be reserved for line items which are not of type // {@link LineItemType#SPONSORSHIP} or {@link LineItemType#STANDARD}. // ReservationDetailsError_ReasonLINE_ITEM_TYPE_NOT_ALLOWED ReservationDetailsError_Reason = "LINE_ITEM_TYPE_NOT_ALLOWED" // // Network remnant line items cannot be changed to other line item types once delivery begins. // This restriction does not apply to any new line items created in Ad Manager. // ReservationDetailsError_ReasonNETWORK_REMNANT_ORDER_CANNOT_UPDATE_LINEITEM_TYPE ReservationDetailsError_Reason = "NETWORK_REMNANT_ORDER_CANNOT_UPDATE_LINEITEM_TYPE" // // A dynamic allocation web property can only be set on a line item of type // AdSense or Ad Exchange. // ReservationDetailsError_ReasonBACKFILL_WEBPROPERTY_CODE_NOT_ALLOWED ReservationDetailsError_Reason = "BACKFILL_WEBPROPERTY_CODE_NOT_ALLOWED" // // The value returned if the actual value is not exposed by the requested API version. // ReservationDetailsError_ReasonUNKNOWN ReservationDetailsError_Reason = "UNKNOWN" )
type ReservationStatus ¶
type ReservationStatus string
const ( // // The inventory is reserved. // ReservationStatusRESERVED ReservationStatus = "RESERVED" // // The proposal line item's inventory is never reserved. // ReservationStatusNOT_RESERVED ReservationStatus = "NOT_RESERVED" // // The inventory is once reserved and now released. // ReservationStatusRELEASED ReservationStatus = "RELEASED" // // The reservation status of the corresponding {@link LineItem} should be used // for this {@link ProposalLineItem}. // ReservationStatusCHECK_LINE_ITEM_RESERVATION_STATUS ReservationStatus = "CHECK_LINE_ITEM_RESERVATION_STATUS" // // The value returned if the actual value is not exposed by the requested API version. // ReservationStatusUNKNOWN ReservationStatus = "UNKNOWN" )
type ResponseHeader ¶
type ResponseHeader SoapResponseHeader
type RoadblockingType ¶
type RoadblockingType string
const ( // // Only one creative from a line item can serve at a time. // RoadblockingTypeONLY_ONE RoadblockingType = "ONLY_ONE" // // Any number of creatives from a line item can serve together at a time. // RoadblockingTypeONE_OR_MORE RoadblockingType = "ONE_OR_MORE" // // As many creatives from a line item as can fit on a page will serve. This // could mean anywhere from one to all of a line item's creatives given the // size constraints of ad slots on a page. // RoadblockingTypeAS_MANY_AS_POSSIBLE RoadblockingType = "AS_MANY_AS_POSSIBLE" // // All or none of the creatives from a line item will serve. This option will only work if // served to a GPT tag using SRA (single request architecture mode). // RoadblockingTypeALL_ROADBLOCK RoadblockingType = "ALL_ROADBLOCK" // // A master/companion {@link CreativeSet} roadblocking type. // A {@link LineItem#creativePlaceholders} must be set accordingly. // RoadblockingTypeCREATIVE_SET RoadblockingType = "CREATIVE_SET" )
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 SetTopBoxLineItemError ¶
type SetTopBoxLineItemError struct { *ApiError // // The error reason represented by an enum. // Reason *SetTopBoxLineItemError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type SetTopBoxLineItemError_Reason ¶
type SetTopBoxLineItemError_Reason string
const ( // // The set-top box line item cannot target an ad unit that doesn't have an external // set-top box channel ID. // SetTopBoxLineItemError_ReasonNON_SET_TOP_BOX_AD_UNIT_TARGETED SetTopBoxLineItemError_Reason = "NON_SET_TOP_BOX_AD_UNIT_TARGETED" // // The set-top box line item must target at least one ad unit. // SetTopBoxLineItemError_ReasonAT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED SetTopBoxLineItemError_Reason = "AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED" // // The set-top box line item cannot exclude ad units. // SetTopBoxLineItemError_ReasonCANNOT_EXCLUDE_AD_UNITS SetTopBoxLineItemError_Reason = "CANNOT_EXCLUDE_AD_UNITS" // // The set-top box line item can only target pod positions 1 - 15. // SetTopBoxLineItemError_ReasonPOD_POSITION_OUT_OF_RANGE SetTopBoxLineItemError_Reason = "POD_POSITION_OUT_OF_RANGE" // // The set-top box line item can only target midroll positions 4 - 100. // SetTopBoxLineItemError_ReasonMIDROLL_POSITION_OUT_OF_RANGE SetTopBoxLineItemError_Reason = "MIDROLL_POSITION_OUT_OF_RANGE" // // The set-top box feature is not enabled. // SetTopBoxLineItemError_ReasonFEATURE_NOT_ENABLED SetTopBoxLineItemError_Reason = "FEATURE_NOT_ENABLED" // // Only {@link EnvironmentType#VIDEO_PLAYER} is supported for set-top box line items. // SetTopBoxLineItemError_ReasonINVALID_ENVIRONMENT_TYPE SetTopBoxLineItemError_Reason = "INVALID_ENVIRONMENT_TYPE" // // Companions are not supported for set-top box line items. // SetTopBoxLineItemError_ReasonCOMPANIONS_NOT_SUPPORTED SetTopBoxLineItemError_Reason = "COMPANIONS_NOT_SUPPORTED" // // Set-top box line items only support sizes supported by Canoe. // SetTopBoxLineItemError_ReasonINVALID_CREATIVE_SIZE SetTopBoxLineItemError_Reason = "INVALID_CREATIVE_SIZE" // // Set-top box line items only support {@link LineItemType#STANDARD}, // {@link LineItemType#HOUSE}, and {@link LineItemType#SPONSORSHIP} line item types. // SetTopBoxLineItemError_ReasonINVALID_LINE_ITEM_TYPE SetTopBoxLineItemError_Reason = "INVALID_LINE_ITEM_TYPE" // // {@link Order orders} containing {@link LineItemType#STANDARD} set-top box line items cannot // contain set-top box line items of type {@link LineItemType#HOUSE} or // {@link LineItemType#SPONSORSHIP}. // SetTopBoxLineItemError_ReasonORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS SetTopBoxLineItemError_Reason = "ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS" // // Set-top box line items only support {@link CostType#CPM}. // SetTopBoxLineItemError_ReasonINVALID_COST_TYPE SetTopBoxLineItemError_Reason = "INVALID_COST_TYPE" // // Set-top box line items do not support a cost per unit. // SetTopBoxLineItemError_ReasonCOST_PER_UNIT_NOT_ALLOWED SetTopBoxLineItemError_Reason = "COST_PER_UNIT_NOT_ALLOWED" // // Set-top box line items do not support discounts. // SetTopBoxLineItemError_ReasonDISCOUNT_NOT_ALLOWED SetTopBoxLineItemError_Reason = "DISCOUNT_NOT_ALLOWED" // // Set-top box line items do not support {@link DeliveryRateType#FRONTLOADED}. // SetTopBoxLineItemError_ReasonFRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED SetTopBoxLineItemError_Reason = "FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED" // // Set-top box line items cannot go from a state that is ready to be synced to a // state that is not ready to be synced. // SetTopBoxLineItemError_ReasonINVALID_LINE_ITEM_STATUS_CHANGE SetTopBoxLineItemError_Reason = "INVALID_LINE_ITEM_STATUS_CHANGE" // // Set-top box line items can only have certain priorities for different // {@link ReservationType reservation types}: // <ul> // <li>{@link ReservationType#SPONSORSHIP} => 1</li> // <li>{@link ReservationType#HOUSE} => 16</li> // <li>{@link ReservationType#STANDARD} => Between 1 and 16 inclusive.</li> // </ul> // SetTopBoxLineItemError_ReasonINVALID_LINE_ITEM_PRIORITY SetTopBoxLineItemError_Reason = "INVALID_LINE_ITEM_PRIORITY" // // When a set-top box line item is pushed to Canoe, a revision number is used to keep track of // the last version of the line item that Ad Manager synced with Canoe. The only change // allowed on revisions within Ad Manager is increasing the revision number. // SetTopBoxLineItemError_ReasonSYNC_REVISION_NOT_INCREASING SetTopBoxLineItemError_Reason = "SYNC_REVISION_NOT_INCREASING" // // When a set-top box line item is pushed to Canoe, a revision number is used to keep track of // the last version of the line item that Ad Manager synced with Canoe. Sync revisions begin // at one and can only increase in value. // SetTopBoxLineItemError_ReasonSYNC_REVISION_MUST_BE_GREATER_THAN_ZERO SetTopBoxLineItemError_Reason = "SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO" // // Set Top box line items cannot be unarchived. // SetTopBoxLineItemError_ReasonCANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS SetTopBoxLineItemError_Reason = "CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS" // // Set-top box enabled line items cannot be copied for V0 of the video Canoe campaign push. // SetTopBoxLineItemError_ReasonCOPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED SetTopBoxLineItemError_Reason = "COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED" // // Standard set-top box line items cannot be updated to be {@link LineItemType#House} or // {@link LineItemType#Sponsorship} line items and vice versa. // SetTopBoxLineItemError_ReasonINVALID_LINE_ITEM_TYPE_CHANGE SetTopBoxLineItemError_Reason = "INVALID_LINE_ITEM_TYPE_CHANGE" // // Set-top box line items can only have a creative rotation type of // {@link CreativeRotationType.EVEN} or {@link CreativeRotationType#MANUAL}. // SetTopBoxLineItemError_ReasonCREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED SetTopBoxLineItemError_Reason = "CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED" // // Set-top box line items can only have frequency capping with time units of // {@link TimeUnit#DAY}, {@link TimeUnit#HOUR}, {@link TimeUnit#POD}, or // {@link TimeUnit#STREAM}. // SetTopBoxLineItemError_ReasonINVALID_FREQUENCY_CAP_TIME_UNIT SetTopBoxLineItemError_Reason = "INVALID_FREQUENCY_CAP_TIME_UNIT" // // Set-top box line items can only have specific time ranges for certain time units: // <ul> // <li>{@link TimeUnit#HOUR} => 1, 2, 6</li> // <li>{@link TimeUnit#DAY} => 1, 3</li> // </ul> // SetTopBoxLineItemError_ReasonINVALID_FREQUENCY_CAP_TIME_RANGE SetTopBoxLineItemError_Reason = "INVALID_FREQUENCY_CAP_TIME_RANGE" // // Set-top box line items can only have a unit type of {@link UnitType#IMPRESSIONS}. // SetTopBoxLineItemError_ReasonINVALID_PRIMARY_GOAL_UNIT_TYPE SetTopBoxLineItemError_Reason = "INVALID_PRIMARY_GOAL_UNIT_TYPE" // // The value returned if the actual value is not exposed by the requested API version. // SetTopBoxLineItemError_ReasonUNKNOWN SetTopBoxLineItemError_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 SkippableAdType ¶
type SkippableAdType string
const ( // // The value returned if the actual value is not exposed by the requested API version. // SkippableAdTypeUNKNOWN SkippableAdType = "UNKNOWN" // // Skippable ad type is disabled. // SkippableAdTypeDISABLED SkippableAdType = "DISABLED" // // Skippable ad type is enabled. // SkippableAdTypeENABLED SkippableAdType = "ENABLED" // // Skippable in-stream ad type. // SkippableAdTypeINSTREAM_SELECT SkippableAdType = "INSTREAM_SELECT" // // Any skippable or not skippable. This is only for programmatic case when the creative // skippability is decided by the buyside. // SkippableAdTypeANY SkippableAdType = "ANY" )
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 StartDateTimeType ¶
type StartDateTimeType string
const ( // // Use the value in {@link #startDateTime}. // StartDateTimeTypeUSE_START_DATE_TIME StartDateTimeType = "USE_START_DATE_TIME" // // The entity will start serving immediately. {@link #startDateTime} in the // request is ignored and will be set to the current time. Additionally, // {@link #startDateTimeType} will be set to // {@link StartDateTimeType#USE_START_DATE_TIME}. // StartDateTimeTypeIMMEDIATELY StartDateTimeType = "IMMEDIATELY" // // The entity will start serving one hour from now. {@link #startDateTime} // in the request is ignored and will be set to one hour from the current // time. Additionally, {@link #startDateTimeType} will be set to // {@link StartDateTimeType#USE_START_DATE_TIME}. // StartDateTimeTypeONE_HOUR_FROM_NOW StartDateTimeType = "ONE_HOUR_FROM_NOW" // // The value returned if the actual value is not exposed by the requested API version. // StartDateTimeTypeUNKNOWN StartDateTimeType = "UNKNOWN" )
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 Stats ¶
type Stats struct { // // The number of impressions delivered. // ImpressionsDelivered int64 `xml:"impressionsDelivered,omitempty" json:"impressionsDelivered,omitempty"` // // The number of clicks delivered. // ClicksDelivered int64 `xml:"clicksDelivered,omitempty" json:"clicksDelivered,omitempty"` // // The number of video completions delivered. // VideoCompletionsDelivered int64 `xml:"videoCompletionsDelivered,omitempty" json:"videoCompletionsDelivered,omitempty"` // // The number of video starts delivered. // VideoStartsDelivered int64 `xml:"videoStartsDelivered,omitempty" json:"videoStartsDelivered,omitempty"` // // The number of viewable impressions delivered. // ViewableImpressionsDelivered int64 `xml:"viewableImpressionsDelivered,omitempty" json:"viewableImpressionsDelivered,omitempty"` }
type StringFormatError ¶
type StringFormatError struct { *ApiError Reason *StringFormatError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type StringFormatError_Reason ¶
type StringFormatError_Reason string
const ( StringFormatError_ReasonUNKNOWN StringFormatError_Reason = "UNKNOWN" // // The input string value contains disallowed characters. // StringFormatError_ReasonILLEGAL_CHARS StringFormatError_Reason = "ILLEGAL_CHARS" // // The input string value is invalid for the associated field. // StringFormatError_ReasonINVALID_FORMAT StringFormatError_Reason = "INVALID_FORMAT" )
type StringLengthError ¶
type StringLengthError struct { *ApiError Reason *StringLengthError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type StringLengthError_Reason ¶
type StringLengthError_Reason string
const ( StringLengthError_ReasonTOO_LONG StringLengthError_Reason = "TOO_LONG" StringLengthError_ReasonTOO_SHORT StringLengthError_Reason = "TOO_SHORT" // // The value returned if the actual value is not exposed by the requested API version. // StringLengthError_ReasonUNKNOWN StringLengthError_Reason = "UNKNOWN" )
type TargetedSize ¶
type TargetedSize struct {
Size *Size `xml:"size,omitempty" json:"size,omitempty"`
}
type Targeting ¶
type Targeting struct { // // Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is // optional. // GeoTargeting *GeoTargeting `xml:"geoTargeting,omitempty" json:"geoTargeting,omitempty"` // // Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The // line item must target at least one ad unit or placement. // InventoryTargeting *InventoryTargeting `xml:"inventoryTargeting,omitempty" json:"inventoryTargeting,omitempty"` // // Specifies the days of the week and times that are targeted by the {@link LineItem}. This // attribute is optional. // DayPartTargeting *DayPartTargeting `xml:"dayPartTargeting,omitempty" json:"dayPartTargeting,omitempty"` // // Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute // is optional. // DateTimeRangeTargeting *DateTimeRangeTargeting `xml:"dateTimeRangeTargeting,omitempty" json:"dateTimeRangeTargeting,omitempty"` // // Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute // is optional. // TechnologyTargeting *TechnologyTargeting `xml:"technologyTargeting,omitempty" json:"technologyTargeting,omitempty"` // // Specifies the collection of custom criteria that is targeted by the {@link LineItem}. // // <p>Once the {@link LineItem} is updated or modified with custom targeting, the server may // return a normalized, but equivalent representation of the custom targeting expression. // // <p>{@code customTargeting} will have up to three levels of expressions including itself. // // <p>The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only // contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children. // // <p>The second level of {@code CustomCriteriaSet} objects can only contain {@link // CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is // placed on this level, the server will wrap it in a {@link CustomCriteriaSet}. // // <p>The third level can only comprise of {@link CustomCriteria} objects. // // <p>The resulting custom targeting tree would be of the form: <br> // <img // src="https://chart.apis.google.com/chart?cht=gv&chl=digraph{customTargeting_LogicalOperator_OR-%3ECustomCriteriaSet_LogicalOperator_AND_1-%3ECustomCriteria_1;CustomCriteriaSet_LogicalOperator_AND_1-%3Eellipsis1;customTargeting_LogicalOperator_OR-%3Eellipsis2;ellipsis1[label=%22...%22,shape=none,fontsize=32];ellipsis2[label=%22...%22,shape=none,fontsize=32]}&chs=450x200"/> // CustomTargeting *CustomCriteriaSet `xml:"customTargeting,omitempty" json:"customTargeting,omitempty"` // // Specifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. // Users visiting from an IP address associated with those domains will be targeted or excluded. // This attribute is optional. // UserDomainTargeting *UserDomainTargeting `xml:"userDomainTargeting,omitempty" json:"userDomainTargeting,omitempty"` // // Specifies the video categories and individual videos targeted by the {@link LineItem}. // ContentTargeting *ContentTargeting `xml:"contentTargeting,omitempty" json:"contentTargeting,omitempty"` // // Specifies targeting against video position types. // VideoPositionTargeting *VideoPositionTargeting `xml:"videoPositionTargeting,omitempty" json:"videoPositionTargeting,omitempty"` // // Specifies targeting against mobile applications. // MobileApplicationTargeting *MobileApplicationTargeting `xml:"mobileApplicationTargeting,omitempty" json:"mobileApplicationTargeting,omitempty"` // // Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link // ProposalLineItem}. This attribute is readonly and is populated by Google. // BuyerUserListTargeting *BuyerUserListTargeting `xml:"buyerUserListTargeting,omitempty" json:"buyerUserListTargeting,omitempty"` // // Specifies the URLs that are targeted by the entity. This is currently only supported by {@link // YieldGroup}. // InventoryUrlTargeting *InventoryUrlTargeting `xml:"inventoryUrlTargeting,omitempty" json:"inventoryUrlTargeting,omitempty"` // // Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is // required for video line items and for {@link ProposalLineItem}. // // <p>This value is modifiable for video line items, but read-only for non-video line items. // // <p>This value is read-only for video line items generated from proposal line items. // RequestPlatformTargeting *RequestPlatformTargeting `xml:"requestPlatformTargeting,omitempty" json:"requestPlatformTargeting,omitempty"` // // Specifies the sizes that are targeted by the entity. This is currently only supported on {@link // YieldGroup} and {@link TrafficDataRequest}. // InventorySizeTargeting *InventorySizeTargeting `xml:"inventorySizeTargeting,omitempty" json:"inventorySizeTargeting,omitempty"` }
type TargetingCriteriaBreakdown ¶
type TargetingCriteriaBreakdown struct { // // The dimension of this breakdown // TargetingDimension *TargetingDimension `xml:"targetingDimension,omitempty" json:"targetingDimension,omitempty"` // // The unique ID of the targeting criteria. // TargetingCriteriaId int64 `xml:"targetingCriteriaId,omitempty" json:"targetingCriteriaId,omitempty"` // // The name of the targeting criteria. // TargetingCriteriaName string `xml:"targetingCriteriaName,omitempty" json:"targetingCriteriaName,omitempty"` // // When true, the breakdown is negative. // Excluded bool `xml:"excluded,omitempty" json:"excluded,omitempty"` // // The available units for this breakdown. // AvailableUnits int64 `xml:"availableUnits,omitempty" json:"availableUnits,omitempty"` // // The matched units for this breakdown. // MatchedUnits int64 `xml:"matchedUnits,omitempty" json:"matchedUnits,omitempty"` }
type TargetingDimension ¶
type TargetingDimension string
const ( TargetingDimensionCUSTOM_CRITERIA TargetingDimension = "CUSTOM_CRITERIA" TargetingDimensionGEOGRAPHY TargetingDimension = "GEOGRAPHY" TargetingDimensionBROWSER TargetingDimension = "BROWSER" TargetingDimensionBROWSER_LANGUAGE TargetingDimension = "BROWSER_LANGUAGE" TargetingDimensionBANDWIDTH_GROUP TargetingDimension = "BANDWIDTH_GROUP" TargetingDimensionOPERATING_SYSTEM TargetingDimension = "OPERATING_SYSTEM" TargetingDimensionUSER_DOMAIN TargetingDimension = "USER_DOMAIN" TargetingDimensionCONTENT TargetingDimension = "CONTENT" TargetingDimensionVIDEO_POSITION TargetingDimension = "VIDEO_POSITION" TargetingDimensionAD_SIZE TargetingDimension = "AD_SIZE" TargetingDimensionAD_UNIT TargetingDimension = "AD_UNIT" TargetingDimensionPLACEMENT TargetingDimension = "PLACEMENT" TargetingDimensionMOBILE_CARRIER TargetingDimension = "MOBILE_CARRIER" TargetingDimensionDEVICE_CAPABILITY TargetingDimension = "DEVICE_CAPABILITY" TargetingDimensionDEVICE_CATEGORY TargetingDimension = "DEVICE_CATEGORY" TargetingDimensionDEVICE_MANUFACTURER TargetingDimension = "DEVICE_MANUFACTURER" TargetingDimensionMOBILE_APPLICATION TargetingDimension = "MOBILE_APPLICATION" TargetingDimensionFORECASTED_CREATIVE_RESTRICTION TargetingDimension = "FORECASTED_CREATIVE_RESTRICTION" // // The value returned if the actual value is not exposed by the requested API version. // TargetingDimensionUNKNOWN TargetingDimension = "UNKNOWN" )
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 Technology ¶
type Technology struct { // // The unique ID of the {@code Technology}. This value is required for all forms of {@code // TechnologyTargeting}. // Id int64 `xml:"id,omitempty" json:"id,omitempty"` // // The name of the technology being targeting. This value is read-only and is assigned by Google. // Name string `xml:"name,omitempty" json:"name,omitempty"` }
type TechnologyTargeting ¶
type TechnologyTargeting struct { // // The bandwidth groups being targeted by the {@link LineItem}. // BandwidthGroupTargeting *BandwidthGroupTargeting `xml:"bandwidthGroupTargeting,omitempty" json:"bandwidthGroupTargeting,omitempty"` // // The browsers being targeted by the {@link LineItem}. // BrowserTargeting *BrowserTargeting `xml:"browserTargeting,omitempty" json:"browserTargeting,omitempty"` // // The languages of browsers being targeted by the {@link LineItem}. // BrowserLanguageTargeting *BrowserLanguageTargeting `xml:"browserLanguageTargeting,omitempty" json:"browserLanguageTargeting,omitempty"` // // The device capabilities being targeted by the {@link LineItem}. // DeviceCapabilityTargeting *DeviceCapabilityTargeting `xml:"deviceCapabilityTargeting,omitempty" json:"deviceCapabilityTargeting,omitempty"` // // The device categories being targeted by the {@link LineItem}. // DeviceCategoryTargeting *DeviceCategoryTargeting `xml:"deviceCategoryTargeting,omitempty" json:"deviceCategoryTargeting,omitempty"` // // The device manufacturers being targeted by the {@link LineItem}. // DeviceManufacturerTargeting *DeviceManufacturerTargeting `xml:"deviceManufacturerTargeting,omitempty" json:"deviceManufacturerTargeting,omitempty"` // // The mobile carriers being targeted by the {@link LineItem}. // MobileCarrierTargeting *MobileCarrierTargeting `xml:"mobileCarrierTargeting,omitempty" json:"mobileCarrierTargeting,omitempty"` // // The mobile devices being targeted by the {@link LineItem}. // MobileDeviceTargeting *MobileDeviceTargeting `xml:"mobileDeviceTargeting,omitempty" json:"mobileDeviceTargeting,omitempty"` // // The mobile device submodels being targeted by the {@link LineItem}. // MobileDeviceSubmodelTargeting *MobileDeviceSubmodelTargeting `xml:"mobileDeviceSubmodelTargeting,omitempty" json:"mobileDeviceSubmodelTargeting,omitempty"` // // The operating systems being targeted by the {@link LineItem}. // OperatingSystemTargeting *OperatingSystemTargeting `xml:"operatingSystemTargeting,omitempty" json:"operatingSystemTargeting,omitempty"` // // The operating system versions being targeted by the {@link LineItem}. // OperatingSystemVersionTargeting *OperatingSystemVersionTargeting `xml:"operatingSystemVersionTargeting,omitempty" json:"operatingSystemVersionTargeting,omitempty"` }
type TechnologyTargetingError ¶
type TechnologyTargetingError struct { *ApiError Reason *TechnologyTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type TechnologyTargetingError_Reason ¶
type TechnologyTargetingError_Reason string
const ( // // Mobile line item cannot target web-only targeting criteria. // TechnologyTargetingError_ReasonMOBILE_LINE_ITEM_CONTAINS_WEB_TECH_CRITERIA TechnologyTargetingError_Reason = "MOBILE_LINE_ITEM_CONTAINS_WEB_TECH_CRITERIA" // // Web line item cannot target mobile-only targeting criteria. // TechnologyTargetingError_ReasonWEB_LINE_ITEM_CONTAINS_MOBILE_TECH_CRITERIA TechnologyTargetingError_Reason = "WEB_LINE_ITEM_CONTAINS_MOBILE_TECH_CRITERIA" // // The mobile carrier targeting feature is not enabled. // TechnologyTargetingError_ReasonMOBILE_CARRIER_TARGETING_FEATURE_NOT_ENABLED TechnologyTargetingError_Reason = "MOBILE_CARRIER_TARGETING_FEATURE_NOT_ENABLED" // // The device capability targeting feature is not enabled. // TechnologyTargetingError_ReasonDEVICE_CAPABILITY_TARGETING_FEATURE_NOT_ENABLED TechnologyTargetingError_Reason = "DEVICE_CAPABILITY_TARGETING_FEATURE_NOT_ENABLED" // // The value returned if the actual value is not exposed by the requested API version. // TechnologyTargetingError_ReasonUNKNOWN TechnologyTargetingError_Reason = "UNKNOWN" )
type TextValue ¶
type TextValue struct { // // The string value. // Value string `xml:"value,omitempty" json:"value,omitempty"` // contains filtered or unexported fields }
type ThirdPartyBrandLiftIntegrationPartner ¶
type ThirdPartyBrandLiftIntegrationPartner string
const ( // // The value returned if the actual value is not exposed by the requested API version. // ThirdPartyBrandLiftIntegrationPartnerUNKNOWN ThirdPartyBrandLiftIntegrationPartner = "UNKNOWN" // // Indicates there's no third-party brand lift integration partner. // ThirdPartyBrandLiftIntegrationPartnerNONE ThirdPartyBrandLiftIntegrationPartner = "NONE" // // Indicates third-party brand lift integration partner Kantar. // ThirdPartyBrandLiftIntegrationPartnerKANTAR_MILLWARD_BROWN ThirdPartyBrandLiftIntegrationPartner = "KANTAR_MILLWARD_BROWN" // // Indicates third-party brand lift integration partner Dynata. // ThirdPartyBrandLiftIntegrationPartnerDYNATA ThirdPartyBrandLiftIntegrationPartner = "DYNATA" // // Indicates third-party brand lift integration partner Intage. // ThirdPartyBrandLiftIntegrationPartnerINTAGE ThirdPartyBrandLiftIntegrationPartner = "INTAGE" // // Indicates third-party brand lift integration partner Macromill. // ThirdPartyBrandLiftIntegrationPartnerMACROMILL ThirdPartyBrandLiftIntegrationPartner = "MACROMILL" )
type ThirdPartyMeasurementSettings ¶
type ThirdPartyMeasurementSettings struct { // // A field to determine the type of ThirdPartyViewabilityIntegrationPartner. This field default is // NONE. // ViewabilityPartner *ThirdPartyViewabilityIntegrationPartner `xml:"viewabilityPartner,omitempty" json:"viewabilityPartner,omitempty"` // // The third party partner id for YouTube viewability verification. // ViewabilityClientId string `xml:"viewabilityClientId,omitempty" json:"viewabilityClientId,omitempty"` // // The reporting id that maps viewability partner data with a campaign (or a group of related // campaigns) specific data. // ViewabilityReportingId string `xml:"viewabilityReportingId,omitempty" json:"viewabilityReportingId,omitempty"` // // A field to determine the type of publisher's viewability partner. This field default is NONE. // PublisherViewabilityPartner *ThirdPartyViewabilityIntegrationPartner `xml:"publisherViewabilityPartner,omitempty" json:"publisherViewabilityPartner,omitempty"` // // The third party partner id for YouTube viewability verification for publisher. // PublisherViewabilityClientId string `xml:"publisherViewabilityClientId,omitempty" json:"publisherViewabilityClientId,omitempty"` // // The reporting id that maps viewability partner data with a campaign (or a group of related // campaigns) specific data for publisher. // PublisherViewabilityReportingId string `xml:"publisherViewabilityReportingId,omitempty" json:"publisherViewabilityReportingId,omitempty"` // // A field to determine the type of ThirdPartyBrandLiftIntegrationPartner. This field default is // NONE. // BrandLiftPartner *ThirdPartyBrandLiftIntegrationPartner `xml:"brandLiftPartner,omitempty" json:"brandLiftPartner,omitempty"` // // The third party partner id for YouTube brand lift verification. // BrandLiftClientId string `xml:"brandLiftClientId,omitempty" json:"brandLiftClientId,omitempty"` // // The reporting id that maps brand lift partner data with a campaign (or a group of related // campaigns) specific data. // BrandLiftReportingId string `xml:"brandLiftReportingId,omitempty" json:"brandLiftReportingId,omitempty"` // // A field to determine the type of advertiser's ThirdPartyReachIntegrationPartner. This field // default is UNKNOWN. // ReachPartner *ThirdPartyReachIntegrationPartner `xml:"reachPartner,omitempty" json:"reachPartner,omitempty"` // // The third party partner id for YouTube reach verification for advertiser. // ReachClientId string `xml:"reachClientId,omitempty" json:"reachClientId,omitempty"` // // The reporting id that maps reach partner data with a campaign (or a group of related campaigns) // specific data for advertiser. // ReachReportingId string `xml:"reachReportingId,omitempty" json:"reachReportingId,omitempty"` // // A field to determine the type of publisher's ThirdPartyReachIntegrationPartner. This field // default is UNKNOWN. // PublisherReachPartner *ThirdPartyReachIntegrationPartner `xml:"publisherReachPartner,omitempty" json:"publisherReachPartner,omitempty"` // // The third party partner id for YouTube reach verification for publisher. // PublisherReachClientId string `xml:"publisherReachClientId,omitempty" json:"publisherReachClientId,omitempty"` // // The reporting id that maps reach partner data with a campaign (or a group of related campaigns) // specific data for publisher. // PublisherReachReportingId string `xml:"publisherReachReportingId,omitempty" json:"publisherReachReportingId,omitempty"` }
type ThirdPartyReachIntegrationPartner ¶
type ThirdPartyReachIntegrationPartner string
const ( // // Indicates there's no third-party reach integration partner. // ThirdPartyReachIntegrationPartnerNONE ThirdPartyReachIntegrationPartner = "NONE" // // Indicates third-party reach integration partner Comscore. // ThirdPartyReachIntegrationPartnerCOMSCORE ThirdPartyReachIntegrationPartner = "COMSCORE" // // Indicates third-party reach integration partner Nielsen. // ThirdPartyReachIntegrationPartnerNIELSEN ThirdPartyReachIntegrationPartner = "NIELSEN" // // Indicates third-party reach integration partner Kantar. // ThirdPartyReachIntegrationPartnerKANTAR_MILLWARD_BROWN ThirdPartyReachIntegrationPartner = "KANTAR_MILLWARD_BROWN" // // Indicates third-party reach integration partner Video Research. // ThirdPartyReachIntegrationPartnerVIDEO_RESEARCH ThirdPartyReachIntegrationPartner = "VIDEO_RESEARCH" // // Indicates third-party reach integration partner Gemius. // ThirdPartyReachIntegrationPartnerGEMIUS ThirdPartyReachIntegrationPartner = "GEMIUS" // // Indicates third-party reach integration partner VideoAmp // ThirdPartyReachIntegrationPartnerVIDEO_AMP ThirdPartyReachIntegrationPartner = "VIDEO_AMP" // // Indicates third-party reach integration partner iSpot.TV // ThirdPartyReachIntegrationPartnerISPOT_TV ThirdPartyReachIntegrationPartner = "ISPOT_TV" // // Indicates third-party reach integration partner Audience Project // ThirdPartyReachIntegrationPartnerAUDIENCE_PROJECT ThirdPartyReachIntegrationPartner = "AUDIENCE_PROJECT" // // The value returned if the actual value is not exposed by the requested API version. // ThirdPartyReachIntegrationPartnerUNKNOWN ThirdPartyReachIntegrationPartner = "UNKNOWN" )
type ThirdPartyViewabilityIntegrationPartner ¶
type ThirdPartyViewabilityIntegrationPartner string
const ( // // Indicates there's no third-party viewability integration partner. // ThirdPartyViewabilityIntegrationPartnerNONE ThirdPartyViewabilityIntegrationPartner = "NONE" // // Indicates third-party viewability integration partner Oracle Moat. // ThirdPartyViewabilityIntegrationPartnerMOAT ThirdPartyViewabilityIntegrationPartner = "MOAT" // // Indicates third-party viewability integration partner Double Verify. // ThirdPartyViewabilityIntegrationPartnerDOUBLE_VERIFY ThirdPartyViewabilityIntegrationPartner = "DOUBLE_VERIFY" // // Indicates third-party viewability integration partner Integral Ad Science. // ThirdPartyViewabilityIntegrationPartnerINTEGRAL_AD_SCIENCE ThirdPartyViewabilityIntegrationPartner = "INTEGRAL_AD_SCIENCE" // // Indicates third-party viewability integration partner Comscore. // ThirdPartyViewabilityIntegrationPartnerCOMSCORE ThirdPartyViewabilityIntegrationPartner = "COMSCORE" // // Indicates third-party viewability integration partner Telemetry. // ThirdPartyViewabilityIntegrationPartnerTELEMETRY ThirdPartyViewabilityIntegrationPartner = "TELEMETRY" // // The value returned if the actual value is not exposed by the requested API version. // ThirdPartyViewabilityIntegrationPartnerUNKNOWN ThirdPartyViewabilityIntegrationPartner = "UNKNOWN" )
type TimeOfDay ¶
type TimeOfDay struct { // // Hour in 24 hour time (0..24). This field must be between 0 and 24, // inclusive. This field is required. // Hour int32 `xml:"hour,omitempty" json:"hour,omitempty"` // // Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This // field is required. // Minute *MinuteOfHour `xml:"minute,omitempty" json:"minute,omitempty"` }
type TimeSeries ¶
type TimeSeries struct { // // The date range of the time series. // TimeSeriesDateRange *DateRange `xml:"timeSeriesDateRange,omitempty" json:"timeSeriesDateRange,omitempty"` // // The daily values constituting the time series. // // <p>The number of time series values must equal the number of days spanned by the time series // date range, inclusive. E.g.: {@code timeSeriesDateRange} of 2001-08-15 to 2001-08-17 should // contain one value for the 15th, one value for the 16th, and one value for the 17th. // Values []int64 `xml:"values,omitempty" json:"values,omitempty"` }
type TimeUnit ¶
type TimeUnit string
const ( TimeUnitMINUTE TimeUnit = "MINUTE" TimeUnitHOUR TimeUnit = "HOUR" TimeUnitDAY TimeUnit = "DAY" TimeUnitWEEK TimeUnit = "WEEK" TimeUnitMONTH TimeUnit = "MONTH" TimeUnitLIFETIME TimeUnit = "LIFETIME" // // Per pod of ads in a video stream. Only valid for entities in a // {@link EnvironmentType#VIDEO_PLAYER} environment. // TimeUnitPOD TimeUnit = "POD" // // Per video stream. Only valid for entities in a // {@link EnvironmentType#VIDEO_PLAYER} environment. // TimeUnitSTREAM TimeUnit = "STREAM" // // The value returned if the actual value is not exposed by the requested API version. // TimeUnitUNKNOWN TimeUnit = "UNKNOWN" )
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 TrafficDataRequest ¶
type TrafficDataRequest struct { // // The {@link TargetingDto} that defines a segment of traffic. // <span class="constraint Required">This attribute is required.</span> // Targeting *Targeting `xml:"targeting,omitempty" json:"targeting,omitempty"` // // The date range for which traffic data are requested. This range may cover historical dates, // future dates, or both. // // <p>The data returned are not guaranteed to cover the entire requested date range. If sufficient // data are not available to cover the entire requested date range, a response may be returned // with a later start date, earlier end date, or both. // <span class="constraint Required">This attribute is required.</span> // RequestedDateRange *DateRange `xml:"requestedDateRange,omitempty" json:"requestedDateRange,omitempty"` }
type TrafficDataResponse ¶
type TrafficDataResponse struct { // // Time series of historical traffic ad opportunity counts. // // <p>This may be null if the requested date range did not contain any historical dates, or if no // historical data are available for the requested traffic segment. // This attribute is read-only. // HistoricalTimeSeries *TimeSeries `xml:"historicalTimeSeries,omitempty" json:"historicalTimeSeries,omitempty"` // // Time series of forecasted traffic ad opportunity counts. // // <p>This may be null if the requested date range did not contain any future dates, or if no // forecasted data are available for the requested traffic segment. // This attribute is read-only. // ForecastedTimeSeries *TimeSeries `xml:"forecastedTimeSeries,omitempty" json:"forecastedTimeSeries,omitempty"` // // Time series of future traffic volumes forecasted to be sold. // // <p>This may be null if the requested date range did not contain any future dates, or if no // sell-through data are available for the requested traffic segment. // This attribute is read-only. // ForecastedAssignedTimeSeries *TimeSeries `xml:"forecastedAssignedTimeSeries,omitempty" json:"forecastedAssignedTimeSeries,omitempty"` // // The overall date range spanned by the union of all time series in the response. // // <p>This is a summary field for convenience. The value will be set such that the start date is // equal to the earliest start date of all time series included, and the end date is equal to the // latest end date of all time series included. // // <p>If all time series fields are null, this field will also be null. // This attribute is read-only. // OverallDateRange *DateRange `xml:"overallDateRange,omitempty" json:"overallDateRange,omitempty"` }
type TranscodingError ¶
type TranscodingError struct { *ApiError Reason *TranscodingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type TranscodingError_Reason ¶
type TranscodingError_Reason string
const ( // // The request to copy the creative(s) was rejected because the source is not transcoded. // TranscodingError_ReasonCANNOT_COPY_CREATIVE_PENDING_TRANSCODE TranscodingError_Reason = "CANNOT_COPY_CREATIVE_PENDING_TRANSCODE" // // The request to copy the creative(s) was rejected because the source is invalid. // TranscodingError_ReasonCANNOT_COPY_INVALID_CREATIVE TranscodingError_Reason = "CANNOT_COPY_INVALID_CREATIVE" // // The creative is still being transcoded or processed. Please try again later. // TranscodingError_ReasonTRANSCODING_IS_IN_PROGRESS TranscodingError_Reason = "TRANSCODING_IS_IN_PROGRESS" // // The value returned if the actual value is not exposed by the requested API version. // TranscodingError_ReasonUNKNOWN TranscodingError_Reason = "UNKNOWN" )
type UniqueError ¶
type UniqueError struct {
*ApiError
}
type UnitType ¶
type UnitType string
const ( // // The number of impressions served by creatives associated with the line // item. Line items of all {@link LineItemType} support this {@code UnitType}. // UnitTypeIMPRESSIONS UnitType = "IMPRESSIONS" // // The number of clicks reported by creatives associated with the line item. // The {@link LineItem#lineItemType} must be // {@link LineItemType#STANDARD}, {@link LineItemType#BULK} or // {@link LineItemType#PRICE_PRIORITY}. // UnitTypeCLICKS UnitType = "CLICKS" // // The number of click-through Cost-Per-Action (CPA) conversions from creatives // associated with the line item. This is only supported as secondary goal and the // {@link LineItem#costType} must be {@link CostType#CPA}. // UnitTypeCLICK_THROUGH_CPA_CONVERSIONS UnitType = "CLICK_THROUGH_CPA_CONVERSIONS" // // The number of view-through Cost-Per-Action (CPA) conversions from creatives // associated with the line item. This is only supported as secondary goal and the // {@link LineItem#costType} must be {@link CostType#CPA}. // UnitTypeVIEW_THROUGH_CPA_CONVERSIONS UnitType = "VIEW_THROUGH_CPA_CONVERSIONS" // // The number of total Cost-Per-Action (CPA) conversions from creatives // associated with the line item. This is only supported as secondary goal and the // {@link LineItem#costType} must be {@link CostType#CPA}. // UnitTypeTOTAL_CPA_CONVERSIONS UnitType = "TOTAL_CPA_CONVERSIONS" // // The number of viewable impressions reported by creatives associated with the line item. // The {@link LineItem#lineItemType} must be {@link LineItemType#STANDARD}. // UnitTypeVIEWABLE_IMPRESSIONS UnitType = "VIEWABLE_IMPRESSIONS" // // The number of in-target impressions reported by third party measurements. // The {@link LineItem#lineItemType} must be {@link LineItemType#STANDARD}. // UnitTypeIN_TARGET_IMPRESSIONS UnitType = "IN_TARGET_IMPRESSIONS" // // The value returned if the actual value is not exposed by the requested API version. // UnitTypeUNKNOWN UnitType = "UNKNOWN" )
type UserDomainTargeting ¶
type UserDomainTargeting struct { // // The domains or subdomains that are being targeted or excluded by the {@link LineItem}. This // attribute is required and the maximum length of each domain is 67 characters. // Domains []string `xml:"domains,omitempty" json:"domains,omitempty"` // // Indicates whether domains should be targeted or excluded. This attribute is optional and // defaults to {@code true}. // Targeted bool `xml:"targeted,omitempty" json:"targeted,omitempty"` }
type UserDomainTargetingError ¶
type UserDomainTargetingError struct { *ApiError Reason *UserDomainTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type UserDomainTargetingError_Reason ¶
type UserDomainTargetingError_Reason string
const ( // // Invalid domain names. Domain names must be at most 67 characters long. // And must contain only alphanumeric characters and hyphens. // UserDomainTargetingError_ReasonINVALID_DOMAIN_NAMES UserDomainTargetingError_Reason = "INVALID_DOMAIN_NAMES" // // The value returned if the actual value is not exposed by the requested API version. // UserDomainTargetingError_ReasonUNKNOWN UserDomainTargetingError_Reason = "UNKNOWN" )
type VideoBumperType ¶
type VideoBumperType string
const ( // // Represents the bumper position before the ad pod. // VideoBumperTypeBEFORE VideoBumperType = "BEFORE" // // Represents the bumper position after the ad pod. // VideoBumperTypeAFTER VideoBumperType = "AFTER" )
type VideoPosition ¶
type VideoPosition struct { // // The type of video position (pre-roll, mid-roll, or post-roll). // PositionType *VideoPosition_Type `xml:"positionType,omitempty" json:"positionType,omitempty"` // // The index of the mid-roll to target. Only valid if the {@link positionType} is // {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored. // MidrollIndex int32 `xml:"midrollIndex,omitempty" json:"midrollIndex,omitempty"` }
type VideoPositionTarget ¶
type VideoPositionTarget struct { // // The video position to target. This attribute is required. // VideoPosition *VideoPosition `xml:"videoPosition,omitempty" json:"videoPosition,omitempty"` // // The video bumper type to target. To target a video position or a pod position, this value must // be null. To target a bumper position this value must be populated and the line item must have a // bumper type. To target a custom ad spot, this value must be null. // VideoBumperType *VideoBumperType `xml:"videoBumperType,omitempty" json:"videoBumperType,omitempty"` // // The video position within a pod to target. To target a video position or a bumper position, // this value must be null. To target a position within a pod this value must be populated. To // target a custom ad spot, this value must be null. // VideoPositionWithinPod *VideoPositionWithinPod `xml:"videoPositionWithinPod,omitempty" json:"videoPositionWithinPod,omitempty"` // // A custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video // position within a pod this value must be null. // AdSpotId int64 `xml:"adSpotId,omitempty" json:"adSpotId,omitempty"` }
type VideoPositionTargeting ¶
type VideoPositionTargeting struct { // // The {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}. // TargetedPositions []*VideoPositionTarget `xml:"targetedPositions,omitempty" json:"targetedPositions,omitempty"` }
type VideoPositionTargetingError ¶
type VideoPositionTargetingError struct { *ApiError Reason *VideoPositionTargetingError_Reason `xml:"reason,omitempty" json:"reason,omitempty"` }
type VideoPositionTargetingError_Reason ¶
type VideoPositionTargetingError_Reason string
const ( // // Video position targeting cannot contain both bumper and non-bumper targeting values. // VideoPositionTargetingError_ReasonCANNOT_MIX_BUMPER_AND_NON_BUMPER_TARGETING VideoPositionTargetingError_Reason = "CANNOT_MIX_BUMPER_AND_NON_BUMPER_TARGETING" // // The bumper video position targeting is invalid. // VideoPositionTargetingError_ReasonINVALID_BUMPER_TARGETING VideoPositionTargetingError_Reason = "INVALID_BUMPER_TARGETING" // // Only custom spot {@link AdSpot} objects can be targeted. // VideoPositionTargetingError_ReasonCAN_ONLY_TARGET_CUSTOM_AD_SPOTS VideoPositionTargetingError_Reason = "CAN_ONLY_TARGET_CUSTOM_AD_SPOTS" // // The value returned if the actual value is not exposed by the requested API version. // VideoPositionTargetingError_ReasonUNKNOWN VideoPositionTargetingError_Reason = "UNKNOWN" )
type VideoPositionWithinPod ¶
type VideoPositionWithinPod struct { // // The specific index of the pod. The index is defined as: // <ul><li>1 = first</li> // <li>2 = second</li> // <li>3 = third</li> // <li>....</li> // <li>100 = last</li></ul> // 100 will always be the last position. For example, for a pod with 5 positions, 100 would // target position 5. Multiple targets against the index 100 can exist.<br> // Positions over 100 are not supported. // Index int32 `xml:"index,omitempty" json:"index,omitempty"` }
type VideoPosition_Type ¶
type VideoPosition_Type string
const ( // // The value returned if the actual value is not exposed by the requested API version. // VideoPosition_TypeUNKNOWN VideoPosition_Type = "UNKNOWN" // // This position targets all of the above video positions. // VideoPosition_TypeALL VideoPosition_Type = "ALL" // // The position defined as showing before the video starts playing. // VideoPosition_TypePREROLL VideoPosition_Type = "PREROLL" // // The position defined as showing within the middle of the playing video. // VideoPosition_TypeMIDROLL VideoPosition_Type = "MIDROLL" // // The position defined as showing after the video is completed. // VideoPosition_TypePOSTROLL VideoPosition_Type = "POSTROLL" )
Click to show internal directories.
Click to hide internal directories.