@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Type Alias TargetingOverlayInput

    TargetingOverlayInput: TargetingUnknownAgeEligibilityConstraint & TargetingVerifiedAgeBasisConstraint & {
        geo_countries?: GeoCountries | null;
        geo_countries_exclude?: GeoCountriesExclude | null;
        geo_regions?: GeoRegions | null;
        geo_regions_exclude?: GeoRegionsExclude | null;
        geo_metros?: TargetingGeoMetrosInput;
        geo_metros_exclude?: GeoMetrosExclude | null;
        geo_postal_areas?: GeoPostalAreas | null;
        geo_postal_areas_exclude?: GeoPostalAreasExclude | null;
        geo_places?: GeoPlaces | null;
        geo_places_exclude?: GeoPlacesExclude | null;
        daypart_targets?: DaypartTargets | null;
        axe_include_segment?: string | null;
        axe_exclude_segment?: string | null;
        audience_include?: AudienceInclude | null;
        audience_exclude?: AudienceExclude | null;
        signal_targeting_groups?: TargetingSignalGroups | null;
        signal_targeting?: [SignalTargeting, ...SignalTargeting[]] | null;
        demographics?: DemographicTargetingIntent | null;
        frequency_cap?: TargetingFrequencyCap | null;
        property_list?: TargetingPropertyList | null;
        property_list_exclude?: PropertyListReference | null;
        collection_list?: TargetingCollectionList | null;
        collection_list_exclude?: CollectionListReference | null;
        placement_selection?: PlacementSelection | null;
        collection_selection?: TargetingCollectionSelection | null;
        age_restriction?: AgeRestriction | null;
        device_platform?: TargetingDevicePlatformsInput | null;
        device_platform_exclude?: DevicePlatformExclude | null;
        device_type?: TargetingDeviceTypesInput | null;
        device_type_exclude?: DeviceTypeExclude | null;
        browser?: Browser | null;
        browser_exclude?: BrowserExclude | null;
        store_catchments?: StoreCatchments | null;
        geo_proximity?: GeoProximity | null;
        language?: TargetingLanguagesInput;
        keyword_targets?: TargetingKeywordsInput;
        negative_keywords?: TargetingNegativeKeywordsInput;
    }

    Per-dimension targeting patch for this package. Omit targeting_overlay, or omit an individual dimension inside it, to leave the corresponding effective targeting unchanged. A non-null dimension replaces its current value; null clears it, including a value inherited from configured-product selection or a product default. Every resulting effective overlay must remain executable by the product. Sellers reject unsupported or partially applicable changes and use REQUOTE_REQUIRED when a change, including a broader inventory set, falls outside the priced envelope. placement_selection is purchased-inventory targeting; mode default restores the product default, null clears the dimension when the product permits it, and successful readback echoes the committed selected set when enumerable. If a patch removes a placement referenced by an existing creative assignment, the seller MUST reject the update unless the same atomic package mutation supplies a compatible complete creative_assignments replacement. Sellers MUST NOT silently delete assignments or retain orphan placement refs.

    Type Declaration

    • Optionalgeo_countries?: GeoCountries | null
    • Optionalgeo_countries_exclude?: GeoCountriesExclude | null
    • Optionalgeo_regions?: GeoRegions | null
    • Optionalgeo_regions_exclude?: GeoRegionsExclude | null
    • Optionalgeo_metros?: TargetingGeoMetrosInput
    • Optionalgeo_metros_exclude?: GeoMetrosExclude | null
    • Optionalgeo_postal_areas?: GeoPostalAreas | null
    • Optionalgeo_postal_areas_exclude?: GeoPostalAreasExclude | null
    • Optionalgeo_places?: GeoPlaces | null
    • Optionalgeo_places_exclude?: GeoPlacesExclude | null
    • Optionaldaypart_targets?: DaypartTargets | null
    • Optionalaxe_include_segment?: string | null
    • Optionalaxe_exclude_segment?: string | null
    • Optionalaudience_include?: AudienceInclude | null
    • Optionalaudience_exclude?: AudienceExclude | null
    • Optionalsignal_targeting_groups?: TargetingSignalGroups | null
    • Optionalsignal_targeting?: [SignalTargeting, ...SignalTargeting[]] | null

      DEPRECATED. Use signal_targeting_groups for package-level signal targeting. Legacy flat signal_targeting remains accepted during the SignalRef migration window but cannot express grouped include/exclude composition or product-scoped pricing.

      1

    • Optionaldemographics?: DemographicTargetingIntent | null
    • Optionalfrequency_cap?: TargetingFrequencyCap | null
    • Optionalproperty_list?: TargetingPropertyList | null
    • Optionalproperty_list_exclude?: PropertyListReference | null
    • Optionalcollection_list?: TargetingCollectionList | null
    • Optionalcollection_list_exclude?: CollectionListReference | null
    • Optionalplacement_selection?: PlacementSelection | null
    • Optionalcollection_selection?: TargetingCollectionSelection | null
    • Optionalage_restriction?: AgeRestriction | null
    • Optionaldevice_platform?: TargetingDevicePlatformsInput | null
    • Optionaldevice_platform_exclude?: DevicePlatformExclude | null
    • Optionaldevice_type?: TargetingDeviceTypesInput | null
    • Optionaldevice_type_exclude?: DeviceTypeExclude | null
    • Optionalbrowser?: Browser | null
    • Optionalbrowser_exclude?: BrowserExclude | null
    • Optionalstore_catchments?: StoreCatchments | null
    • Optionalgeo_proximity?: GeoProximity | null
    • Optionallanguage?: TargetingLanguagesInput
    • Optionalkeyword_targets?: TargetingKeywordsInput
    • Optionalnegative_keywords?: TargetingNegativeKeywordsInput

    Settings
    Member Visibility