Module adcp.types.generated_poc.targeting

Classes

class GeoCountryAnyOfItem (root: RootModelRootType = PydanticUndefined, **data)

Expand source code

class GeoCountryAnyOfItem(RootModel[str]):
    root: Annotated[str, Field(pattern='^[A-Z]{2}$')]

Usage Documentation

RootModel and Custom Root Types

A Pydantic BaseModel for the root object of the model.

Attributes

root

The root object of the model.

__pydantic_root_model__

Whether the model is a RootModel.

__pydantic_private__

Private fields in the model.

__pydantic_extra__

Extra fields in the model.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• pydantic.root_model.RootModel[str]
• pydantic.root_model.RootModel
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

var root : str

class TargetingOverlay (**data: Any)

Expand source code

class TargetingOverlay(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    axe_exclude_segment: Annotated[
        str | None, Field(description='AXE segment ID to exclude from targeting')
    ] = None
    axe_include_segment: Annotated[
        str | None, Field(description='AXE segment ID to include for targeting')
    ] = None
    frequency_cap: frequency_cap_1.FrequencyCap | None = None
    geo_country_any_of: Annotated[
        list[GeoCountryAnyOfItem] | None,
        Field(
            description='Restrict delivery to specific countries (ISO codes). Use for regulatory compliance or RCT testing.'
        ),
    ] = None
    geo_metro_any_of: Annotated[
        list[str] | None,
        Field(
            description='Restrict delivery to specific metro areas (DMA codes). Use for regulatory compliance or RCT testing.'
        ),
    ] = None
    geo_postal_code_any_of: Annotated[
        list[str] | None,
        Field(
            description='Restrict delivery to specific postal/ZIP codes. Use for regulatory compliance or RCT testing.'
        ),
    ] = None
    geo_region_any_of: Annotated[
        list[str] | None,
        Field(
            description='Restrict delivery to specific regions/states. Use for regulatory compliance or RCT testing.'
        ),
    ] = None

Base model for AdCP types with spec-compliant serialization.

AdCP JSON schemas use additionalProperties: false and do not allow null for optional fields. Therefore, optional fields must be omitted entirely when not present (not sent as null).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• AdCPBaseModel
• pydantic.main.BaseModel

Class variables

var axe_exclude_segment : str | None

var axe_include_segment : str | None

var frequency_cap : FrequencyCap | None

var geo_country_any_of : list[GeoCountryAnyOfItem] | None

var geo_metro_any_of : list[str] | None

var geo_postal_code_any_of : list[str] | None

var geo_region_any_of : list[str] | None

var model_config

Inherited members

• AdCPBaseModel:
  • model_dump
  • model_dump_json