type FrequencyCapError (v202411)

    • The FrequencyCapError is associated with errors related to frequency caps in services like ForecastService, InventoryService, and others.

    • It inherits properties from ApiError, including fieldPath, fieldPathElements, trigger, and errorString to provide details about the error.

    • The FrequencyCapError has a specific reason field which uses an enumeration to indicate the cause of the error, such as impression limits, range issues, duplicates, or too many frequency caps.
    Service
    ForecastService InventoryService LineItemService LineItemTemplateService OrderService ProposalLineItemService
    Inheritance
    ApiError
    ▼
    AdSenseAccountError AdUnitCodeError AdUnitHierarchyError ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyError CreativeWrapperError CrossSellError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FrequencyCapError InternalApiError InvalidColorError InvalidUrlError InventoryUnitError InventoryUnitRefreshRateError InventoryUnitSizesError LabelEntityAssociationError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

    Lists all errors associated with frequency caps.

    Namespace
    https://www.google.com/apis/ads/publisher/v202411

    Field

    ApiError (inherited)

    fieldPath

    xsd: string

    The OGNL field path to identify cause of error.

    fieldPathElements

    FieldPathElement []

    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)}.

    trigger

    xsd: string

    The data that caused the error.

    errorString

    xsd: string

    A simple string representation of the error and reason.

    FrequencyCapError

    reason

    FrequencyCapError.Reason

    The error reason represented by an enum.

    Enumerations
    IMPRESSION_LIMIT_EXCEEDED
    IMPRESSIONS_TOO_LOW
    RANGE_LIMIT_EXCEEDED
    RANGE_TOO_LOW
    DUPLICATE_TIME_RANGE
    DUPLICATE_TIME_UNIT
    TOO_MANY_FREQUENCY_CAPS
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: