criteo-api-retailmedia-sdk 2023.4.0.240404__py3-none-any.whl → 2023.4.0.240618__py3-none-any.whl

criteo_api_retailmedia_v2023_04/model/async_campaigns_report.py

@@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal):
     allowed_values = {
         ('campaign_type',): {
             'None': None,
+            'ALL': "all",
             'SPONSOREDPRODUCTS': "sponsoredProducts",
             'ONSITEDISPLAYS': "onSiteDisplays",
         },
         ('sales_channel',): {
             'None': None,
+            'ALL': "all",
             'OFFLINE': "offline",
             'ONLINE': "online",
         },
@@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal):
         },
         ('click_attribution_window',): {
             'None': None,
+            'NONE': "none",
             '7D': "7D",
             '14D': "14D",
             '30D': "30D",
-            'NONE': "none",
         },
         ('view_attribution_window',): {
             'None': None,
+            'NONE': "none",
             '1D': "1D",
             '7D': "7D",
             '14D': "14D",
             '30D': "30D",
-            'NONE': "none",
         },
         ('dimensions',): {
             'None': None,
@@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal):
             'CAMPAIGNID': "campaignId",
             'CAMPAIGNNAME': "campaignName",
             'CAMPAIGNTYPENAME': "campaignTypeName",
-            'ADVPRODUCTCATEGORY': "advProductCategory",
-            'ADVPRODUCTID': "advProductId",
-            'ADVPRODUCTNAME': "advProductName",
-            'BRANDID': "brandId",
-            'BRANDNAME': "brandName",
             'LINEITEMID': "lineItemId",
             'LINEITEMNAME': "lineItemName",
             'RETAILERID': "retailerId",
             'RETAILERNAME': "retailerName",
-            'KEYWORD': "keyword",
-            'PAGETYPENAME': "pageTypeName",
+            'BRANDID': "brandId",
+            'BRANDNAME': "brandName",
+            'ADVPRODUCTCATEGORY': "advProductCategory",
+            'ADVPRODUCTID': "advProductId",
+            'ADVPRODUCTNAME': "advProductName",
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
+            'PAGETYPENAME': "pageTypeName",
+            'KEYWORD': "keyword",
+            'SEARCHTERM': "searchTerm",
         },
         ('metrics',): {
             'None': None,
@@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal):
             'CPO': "cpo",
             'CPM': "cpm",
             'ROAS': "roas",
+            'VIDEOVIEWS': "videoViews",
+            'VIDEOSSTARTED': "videosStarted",
+            'VIDEOSPLAYEDTO25': "videosPlayedTo25",
+            'VIDEOSPLAYEDTO50': "videosPlayedTo50",
+            'VIDEOSPLAYEDTO75': "videosPlayedTo75",
+            'VIDEOSPLAYEDTO100': "videosPlayedTo100",
+            'VIDEOPLAYINGRATE': "videoPlayingRate",
+            'VIDEOCOMPLETIONRATE': "videoCompletionRate",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },
@@ -248,8 +259,8 @@ class AsyncCampaignsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Campaign ids to report on. [optional]  # noqa: E501
             id (str, none_type): Campaign id to report on. [optional]  # noqa: E501
-            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
-            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
             report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
@@ -350,8 +361,8 @@ class AsyncCampaignsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Campaign ids to report on. [optional]  # noqa: E501
             id (str, none_type): Campaign id to report on. [optional]  # noqa: E501
-            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
-            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
             report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501

criteo_api_retailmedia_v2023_04/model/async_line_items_report.py

@@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal):
     allowed_values = {
         ('campaign_type',): {
             'None': None,
+            'ALL': "all",
             'SPONSOREDPRODUCTS': "sponsoredProducts",
             'ONSITEDISPLAYS': "onSiteDisplays",
         },
         ('sales_channel',): {
             'None': None,
+            'ALL': "all",
             'OFFLINE': "offline",
             'ONLINE': "online",
         },
@@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal):
         },
         ('click_attribution_window',): {
             'None': None,
+            'NONE': "none",
             '7D': "7D",
             '14D': "14D",
             '30D': "30D",
-            'NONE': "none",
         },
         ('view_attribution_window',): {
             'None': None,
+            'NONE': "none",
             '1D': "1D",
             '7D': "7D",
             '14D': "14D",
             '30D': "30D",
-            'NONE': "none",
         },
         ('dimensions',): {
             'None': None,
@@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal):
             'CAMPAIGNID': "campaignId",
             'CAMPAIGNNAME': "campaignName",
             'CAMPAIGNTYPENAME': "campaignTypeName",
-            'ADVPRODUCTCATEGORY': "advProductCategory",
-            'ADVPRODUCTID': "advProductId",
-            'ADVPRODUCTNAME': "advProductName",
-            'BRANDID': "brandId",
-            'BRANDNAME': "brandName",
             'LINEITEMID': "lineItemId",
             'LINEITEMNAME': "lineItemName",
             'RETAILERID': "retailerId",
             'RETAILERNAME': "retailerName",
-            'KEYWORD': "keyword",
-            'PAGETYPENAME': "pageTypeName",
+            'BRANDID': "brandId",
+            'BRANDNAME': "brandName",
+            'ADVPRODUCTCATEGORY': "advProductCategory",
+            'ADVPRODUCTID': "advProductId",
+            'ADVPRODUCTNAME': "advProductName",
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
+            'PAGETYPENAME': "pageTypeName",
+            'KEYWORD': "keyword",
+            'SEARCHTERM': "searchTerm",
         },
         ('metrics',): {
             'None': None,
@@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal):
             'CPO': "cpo",
             'CPM': "cpm",
             'ROAS': "roas",
+            'VIDEOVIEWS': "videoViews",
+            'VIDEOSSTARTED': "videosStarted",
+            'VIDEOSPLAYEDTO25': "videosPlayedTo25",
+            'VIDEOSPLAYEDTO50': "videosPlayedTo50",
+            'VIDEOSPLAYEDTO75': "videosPlayedTo75",
+            'VIDEOSPLAYEDTO100': "videosPlayedTo100",
+            'VIDEOPLAYINGRATE': "videoPlayingRate",
+            'VIDEOCOMPLETIONRATE': "videoCompletionRate",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },
@@ -248,8 +259,8 @@ class AsyncLineItemsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Line Item ids to report on. [optional]  # noqa: E501
             id (str, none_type): Line Item id to report on. [optional]  # noqa: E501
-            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
-            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
             report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
@@ -350,8 +361,8 @@ class AsyncLineItemsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Line Item ids to report on. [optional]  # noqa: E501
             id (str, none_type): Line Item id to report on. [optional]  # noqa: E501
-            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
-            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
+            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
             report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501

criteo_api_retailmedia_v2023_04/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2023_04.exceptions import ApiAttributeError
 
 
 
-class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
+class InputKeywordsModel(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -58,21 +58,9 @@ class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
     }
 
     validations = {
-        ('negative_broad',): {
-        },
-        ('negative_exact',): {
-        },
-        ('positive_exact',): {
-        },
     }
 
-    @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
+    additional_properties_type = None
 
     _nullable = False
 
@@ -111,7 +99,7 @@ class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1InputKeywordsModel - a model defined in OpenAPI
+        """InputKeywordsModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -199,7 +187,7 @@ class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1InputKeywordsModel - a model defined in OpenAPI
+        """InputKeywordsModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types

criteo_api_retailmedia_v2023_04/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py}

@@ -30,11 +30,15 @@ from criteo_api_retailmedia_v2023_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel
-    globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel
+    from criteo_api_retailmedia_v2023_04.model.input_keywords_model import InputKeywordsModel
+    from criteo_api_retailmedia_v2023_04.model.match_type_model import MatchTypeModel
+    from criteo_api_retailmedia_v2023_04.model.review_state_model import ReviewStateModel
+    globals()['InputKeywordsModel'] = InputKeywordsModel
+    globals()['MatchTypeModel'] = MatchTypeModel
+    globals()['ReviewStateModel'] = ReviewStateModel
 
 
-class RetailMediaExternalv1KeywordDataModel(ModelNormal):
+class KeywordDataModel(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,34 +63,12 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
     """
 
     allowed_values = {
-        ('review_state',): {
-            'None': None,
-            'INREVIEW': "InReview",
-            'RECOMMENDED': "Recommended",
-            'APPROVED': "Approved",
-            'AUTOAPPROVED': "AutoApproved",
-            'REJECTED': "Rejected",
-            'AUTOREJECTED': "AutoRejected",
-        },
-        ('match_type',): {
-            'None': None,
-            'POSITIVEEXACTMATCH': "PositiveExactMatch",
-            'NEGATIVEEXACTMATCH': "NegativeExactMatch",
-            'NEGATIVEBROADMATCH': "NegativeBroadMatch",
-        },
     }
 
     validations = {
     }
 
-    @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
-        """
-        lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
     _nullable = False
 
@@ -102,10 +84,10 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
         """
         lazy_import()
         return {
-            'review_state': (str, none_type,),  # noqa: E501
-            'match_type': (str, none_type,),  # noqa: E501
+            'review_state': (ReviewStateModel,),  # noqa: E501
+            'match_type': (MatchTypeModel,),  # noqa: E501
             'bid': (float, none_type,),  # noqa: E501
-            'input_keywords': (RetailMediaExternalv1InputKeywordsModel,),  # noqa: E501
+            'input_keywords': (InputKeywordsModel,),  # noqa: E501
             'created_at': (datetime, none_type,),  # noqa: E501
             'updated_at': (datetime, none_type,),  # noqa: E501
         }
@@ -132,7 +114,7 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1KeywordDataModel - a model defined in OpenAPI
+        """KeywordDataModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -165,10 +147,10 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            review_state (str, none_type): [optional]  # noqa: E501
-            match_type (str, none_type): [optional]  # noqa: E501
+            review_state (ReviewStateModel): [optional]  # noqa: E501
+            match_type (MatchTypeModel): [optional]  # noqa: E501
             bid (float, none_type): [optional]  # noqa: E501
-            input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional]  # noqa: E501
+            input_keywords (InputKeywordsModel): [optional]  # noqa: E501
             created_at (datetime, none_type): [optional]  # noqa: E501
             updated_at (datetime, none_type): [optional]  # noqa: E501
         """
@@ -223,7 +205,7 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1KeywordDataModel - a model defined in OpenAPI
+        """KeywordDataModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -256,10 +238,10 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            review_state (str, none_type): [optional]  # noqa: E501
-            match_type (str, none_type): [optional]  # noqa: E501
+            review_state (ReviewStateModel): [optional]  # noqa: E501
+            match_type (MatchTypeModel): [optional]  # noqa: E501
             bid (float, none_type): [optional]  # noqa: E501
-            input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional]  # noqa: E501
+            input_keywords (InputKeywordsModel): [optional]  # noqa: E501
             created_at (datetime, none_type): [optional]  # noqa: E501
             updated_at (datetime, none_type): [optional]  # noqa: E501
         """

criteo_api_retailmedia_v2023_04/model/{retail_media_externalv1_keywords_model.py → keywords_model.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_v2023_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_04.model.retail_media_externalv1_keyword_data_model import RetailMediaExternalv1KeywordDataModel
-    globals()['RetailMediaExternalv1KeywordDataModel'] = RetailMediaExternalv1KeywordDataModel
+    from criteo_api_retailmedia_v2023_04.model.keyword_data_model import KeywordDataModel
+    globals()['KeywordDataModel'] = KeywordDataModel
 
 
-class RetailMediaExternalv1KeywordsModel(ModelNormal):
+class KeywordsModel(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -62,18 +62,9 @@ class RetailMediaExternalv1KeywordsModel(ModelNormal):
     }
 
     validations = {
-        ('rank',): {
-        },
     }
 
-    @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
-        """
-        lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
     _nullable = False
 
@@ -89,7 +80,7 @@ class RetailMediaExternalv1KeywordsModel(ModelNormal):
         """
         lazy_import()
         return {
-            'keywords': (RetailMediaExternalv1KeywordDataModel,),  # noqa: E501
+            'keywords': ({str: (KeywordDataModel,)}, none_type,),  # noqa: E501
             'rank': ([str], none_type,),  # noqa: E501
         }
 
@@ -111,7 +102,7 @@ class RetailMediaExternalv1KeywordsModel(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1KeywordsModel - a model defined in OpenAPI
+        """KeywordsModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -144,7 +135,7 @@ class RetailMediaExternalv1KeywordsModel(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            keywords (RetailMediaExternalv1KeywordDataModel): [optional]  # noqa: E501
+            keywords ({str: (KeywordDataModel,)}, none_type): [optional]  # noqa: E501
             rank ([str], none_type): [optional]  # noqa: E501
         """
 
@@ -198,7 +189,7 @@ class RetailMediaExternalv1KeywordsModel(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1KeywordsModel - a model defined in OpenAPI
+        """KeywordsModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -231,7 +222,7 @@ class RetailMediaExternalv1KeywordsModel(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            keywords (RetailMediaExternalv1KeywordDataModel): [optional]  # noqa: E501
+            keywords ({str: (KeywordDataModel,)}, none_type): [optional]  # noqa: E501
             rank ([str], none_type): [optional]  # noqa: E501
         """