criteo-api-retailmedia-sdk 0.0.250915__py3-none-any.whl → 0.0.251014__py3-none-any.whl

criteo_api_retailmedia_preview/api_client.py

@@ -76,7 +76,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.0.250915/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.251014/python'
 
     def __enter__(self):
         return self
@@ -804,10 +804,10 @@ class Endpoint(object):
         Example:
 
         api_instance = AccountsApi()
-        api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id  # this is an instance of the class Endpoint
-        api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id()  # this invokes api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id.__call__()
+        api_instance.account_fees_search  # this is an instance of the class Endpoint
+        api_instance.account_fees_search()  # this invokes api_instance.account_fees_search.__call__()
         which then invokes the callable functions stored in that endpoint at
-        api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id.callable or self.callable in this class
+        api_instance.account_fees_search.callable or self.callable in this class
 
         """
         return self.callable(self, *args, **kwargs)

criteo_api_retailmedia_preview/configuration.py

@@ -395,7 +395,7 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: Preview\n"\
-               "SDK Package Version: 0.0.250915".\
+               "SDK Package Version: 0.0.251014".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

criteo_api_retailmedia_preview/model/async_fill_rate_report.py

@@ -88,6 +88,11 @@ class AsyncFillRateReport(ModelNormal):
             'REVENUE': "revenue",
             'WORKINGMEDIA': "workingMedia",
             'NETREVENUE': "netRevenue",
+            'NONDELIVERABLEPLACEMENTS': "nonDeliverablePlacements",
+            'DELIVERABLEPLACEMENTS': "deliverablePlacements",
+            'PLACEMENTSWITHCANDIDATES': "placementsWithCandidates",
+            'COVEREDPLACEMENTS': "coveredPlacements",
+            'COVERAGERATE': "coverageRate",
         },
         ('ad_server_type',): {
             'ALL': "all",

criteo_api_retailmedia_preview/model/async_unfilled_placements_report.py

@@ -0,0 +1,392 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: Preview
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
+
+
+
+class AsyncUnfilledPlacementsReport(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+        ('dimensions',): {
+            'DATE': "date",
+            'RETAILERID': "retailerId",
+            'RETAILERNAME': "retailerName",
+            'PLACEMENTID': "placementId",
+            'PLACEMENTNAME': "placementName",
+            'PAGETYPENAME': "pageTypeName",
+            'SERVEDCATEGORY': "servedCategory",
+            'ENVIRONMENT': "environment",
+            'RETAILERCATEGORYID': "retailerCategoryId",
+            'RETAILERCATEGORYNAME': "retailerCategoryName",
+            'ADSERVERTYPE': "adServerType",
+            'CAMPAIGNTYPE': "campaignType",
+        },
+        ('metrics',): {
+            'TOTALUNFILLEDPLACEMENTS': "totalUnfilledPlacements",
+            'UNFILLEDUSEROPTOUT': "unfilledUserOptOut",
+            'UNFILLEDNOTENOUGHDEMAND': "unfilledNotEnoughDemand",
+            'UNFILLEDTOTALAUCTIONSETTINGS': "unfilledTotalAuctionSettings",
+            'UNFILLEDTOTALAUCTIONCONSIDERATIONS': "unfilledTotalAuctionConsiderations",
+            'UNFILLEDADVERTISERAUCTIONSETTINGS': "unfilledAdvertiserAuctionSettings",
+            'UNFILLEDRETAILERAUCTIONSETTINGS': "unfilledRetailerAuctionSettings",
+            'UNFILLEDCRITEOAUCTIONSETTINGS': "unfilledCriteoAuctionSettings",
+            'UNFILLEDRETURNEDBUTNOTPAINTED': "unfilledReturnedButNotPainted",
+            'NONDELIVERABLEUNMAPPEDCATEGORIES': "nonDeliverableUnmappedCategories",
+            'NONDELIVERABLEPAGESWITHUNKNOWNPRODUCTS': "nonDeliverablePagesWithUnknownProducts",
+            'NONDELIVERABLEBLOCKEDOPTOUT': "nonDeliverableBlockedOptOut",
+            'NONDELIVERABLEBLOCKEDPAGECATEGORY': "nonDeliverableBlockedPageCategory",
+            'NONDELIVERABLEINACTIVEPLACEMENT': "nonDeliverableInactivePlacement",
+            'NONDELIVERABLEINSUFFICIENTORGANICRESULTS': "nonDeliverableInsufficientOrganicResults",
+            'NONDELIVERABLEINVALIDTRAFFIC': "nonDeliverableInvalidTraffic",
+            'NONDELIVERABLETESTPLACEMENT': "nonDeliverableTestPlacement",
+            'UNCOVEREDUNUSEDFORMATS': "uncoveredUnusedFormats",
+            'UNCOVEREDSEARCHTERMWITHOUTCATEGORY': "uncoveredSearchTermWithoutCategory",
+            'UNCOVEREDNODEMANDBRANDEDKEYWORDCONQUESTINGENABLED': "uncoveredNoDemandBrandedKeywordConquestingEnabled",
+            'UNCOVEREDNODEMANDBRANDEDKEYWORDCONQUESTINGDISABLED': "uncoveredNoDemandBrandedKeywordConquestingDisabled",
+            'UNCOVEREDNODEMANDUNBRANDEDINVENTORY': "uncoveredNoDemandUnbrandedInventory",
+            'UNCOVEREDNODEMANDOPTOUT': "uncoveredNoDemandOptOut",
+            'UNCOVEREDFILTEREDOUTDEMAND': "uncoveredFilteredOutDemand",
+            'UNCOVEREDBROKENPLACEMENT': "uncoveredBrokenPlacement",
+            'UNCOVEREDNOTPAINTED': "uncoveredNotPainted",
+            'AVAILABLEPLACEMENTS': "availablePlacements",
+            'FILLRATE': "fillRate",
+            'PLACEMENTIMPRESSIONS': "placementImpressions",
+            'PRODUCTIMPRESSIONS': "productImpressions",
+            'PLACEMENTCLICKS': "placementClicks",
+            'PRODUCTCLICKS': "productClicks",
+            'CLICKS': "clicks",
+            'PLACEMENTIMPRESSIONSCTR': "placementImpressionsCTR",
+            'PRODUCTIMPRESSIONSCTR': "productImpressionsCTR",
+            'CPM': "cpm",
+            'CPC': "cpc",
+            'PLACEMENTIMPRESSIONSREVENUE': "placementImpressionsRevenue",
+            'PRODUCTCLICKSREVENUE': "productClicksRevenue",
+            'REVENUE': "revenue",
+            'NONDELIVERABLEPLACEMENTS': "nonDeliverablePlacements",
+            'DELIVERABLEPLACEMENTS': "deliverablePlacements",
+            'PLACEMENTSWITHCANDIDATES': "placementsWithCandidates",
+            'COVEREDPLACEMENTS': "coveredPlacements",
+            'COVERAGERATE': "coverageRate",
+        },
+        ('ad_server_type',): {
+            'ALL': "all",
+            'GAM': "gam",
+            'CRITEO': "criteo",
+        },
+        ('campaign_type',): {
+            'ALL': "all",
+            'SPONSOREDPRODUCTS': "sponsoredProducts",
+            'ONSITEDISPLAYS': "onSiteDisplays",
+        },
+        ('format',): {
+            'JSON': "json",
+            'JSON-COMPACT': "json-compact",
+            'JSON-NEWLINE': "json-newline",
+            'CSV': "csv",
+        },
+    }
+
+    validations = {
+        ('dimensions',): {
+            'min_items': 1,
+        },
+        ('metrics',): {
+            'min_items': 1,
+        },
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'dimensions': ([str],),  # noqa: E501
+            'end_date': (datetime,),  # noqa: E501
+            'metrics': ([str],),  # noqa: E501
+            'start_date': (datetime,),  # noqa: E501
+            'supply_account_ids': ([str],),  # noqa: E501
+            'ad_server_type': (str,),  # noqa: E501
+            'campaign_type': (str,),  # noqa: E501
+            'format': (str,),  # noqa: E501
+            'timezone': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'dimensions': 'dimensions',  # noqa: E501
+        'end_date': 'endDate',  # noqa: E501
+        'metrics': 'metrics',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'supply_account_ids': 'supplyAccountIds',  # noqa: E501
+        'ad_server_type': 'adServerType',  # noqa: E501
+        'campaign_type': 'campaignType',  # noqa: E501
+        'format': 'format',  # noqa: E501
+        'timezone': 'timezone',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, dimensions, end_date, metrics, start_date, supply_account_ids, *args, **kwargs):  # noqa: E501
+        """AsyncUnfilledPlacementsReport - a model defined in OpenAPI
+
+        Args:
+            dimensions ([str]): List of dimensions to report on
+            end_date (datetime): End date
+            metrics ([str]): List of metrics to report on
+            start_date (datetime): Start date
+            supply_account_ids ([str]): Supply account ids to report on
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            ad_server_type (str): Filter on the type of the ad server: criteo, gam, all. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            campaign_type (str): Filter on the type of the campaign: onsite display, onsite sponsored products, all. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            format (str): Format of the output. [optional] if omitted the server will use the default value of "json"  # noqa: E501
+            timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.dimensions = dimensions
+        self.end_date = end_date
+        self.metrics = metrics
+        self.start_date = start_date
+        self.supply_account_ids = supply_account_ids
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, dimensions, end_date, metrics, start_date, supply_account_ids, *args, **kwargs):  # noqa: E501
+        """AsyncUnfilledPlacementsReport - a model defined in OpenAPI
+
+        Args:
+            dimensions ([str]): List of dimensions to report on
+            end_date (datetime): End date
+            metrics ([str]): List of metrics to report on
+            start_date (datetime): Start date
+            supply_account_ids ([str]): Supply account ids to report on
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            ad_server_type (str): Filter on the type of the ad server: criteo, gam, all. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            campaign_type (str): Filter on the type of the campaign: onsite display, onsite sponsored products, all. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            format (str): Format of the output. [optional] if omitted the server will use the default value of "json"  # noqa: E501
+            timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.dimensions = dimensions
+        self.end_date = end_date
+        self.metrics = metrics
+        self.start_date = start_date
+        self.supply_account_ids = supply_account_ids
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")