criteo-api-retailmedia-sdk 2023.10.0.241029__py3-none-any.whl → 2024.1.0.240404__py3-none-any.whl

{criteo_api_retailmedia_v2023_10 → criteo_api_retailmedia_v2024_01}/model/async_campaigns_report.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,7 +26,7 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 
@@ -57,13 +57,11 @@ 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",
         },
@@ -87,18 +85,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,
@@ -109,22 +107,19 @@ 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",
-            'BRANDID': "brandId",
-            'BRANDNAME': "brandName",
-            'ADVPRODUCTCATEGORY': "advProductCategory",
-            'ADVPRODUCTID': "advProductId",
-            'ADVPRODUCTNAME': "advProductName",
+            'KEYWORD': "keyword",
+            'PAGETYPENAME': "pageTypeName",
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
-            'PAGETYPENAME': "pageTypeName",
-            'PAGECATEGORY': "pageCategory",
-            'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
-            'KEYWORD': "keyword",
-            'SEARCHTERM': "searchTerm",
         },
         ('metrics',): {
             'None': None,
@@ -141,14 +136,6 @@ 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",
         },
@@ -261,8 +248,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] 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
+            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
             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
@@ -363,8 +350,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] 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
+            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
             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_10 → criteo_api_retailmedia_v2024_01}/model/async_campaigns_report_request.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_10.model.async_campaigns_report_resource import AsyncCampaignsReportResource
+    from criteo_api_retailmedia_v2024_01.model.async_campaigns_report_resource import AsyncCampaignsReportResource
     globals()['AsyncCampaignsReportResource'] = AsyncCampaignsReportResource
 
 

{criteo_api_retailmedia_v2023_10 → criteo_api_retailmedia_v2024_01}/model/async_campaigns_report_resource.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_10.model.async_campaigns_report import AsyncCampaignsReport
+    from criteo_api_retailmedia_v2024_01.model.async_campaigns_report import AsyncCampaignsReport
     globals()['AsyncCampaignsReport'] = AsyncCampaignsReport
 
 

{criteo_api_retailmedia_v2023_10 → criteo_api_retailmedia_v2024_01}/model/async_line_items_report.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,7 +26,7 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 
@@ -57,13 +57,11 @@ 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",
         },
@@ -87,18 +85,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,
@@ -109,22 +107,19 @@ 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",
-            'BRANDID': "brandId",
-            'BRANDNAME': "brandName",
-            'ADVPRODUCTCATEGORY': "advProductCategory",
-            'ADVPRODUCTID': "advProductId",
-            'ADVPRODUCTNAME': "advProductName",
+            'KEYWORD': "keyword",
+            'PAGETYPENAME': "pageTypeName",
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
-            'PAGETYPENAME': "pageTypeName",
-            'PAGECATEGORY': "pageCategory",
-            'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
-            'KEYWORD': "keyword",
-            'SEARCHTERM': "searchTerm",
         },
         ('metrics',): {
             'None': None,
@@ -141,14 +136,6 @@ 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",
         },
@@ -261,8 +248,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] 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
+            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
             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
@@ -363,8 +350,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] 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
+            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
             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_10 → criteo_api_retailmedia_v2024_01}/model/async_line_items_report_request.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_10.model.async_line_items_report_resource import AsyncLineItemsReportResource
+    from criteo_api_retailmedia_v2024_01.model.async_line_items_report_resource import AsyncLineItemsReportResource
     globals()['AsyncLineItemsReportResource'] = AsyncLineItemsReportResource
 
 

{criteo_api_retailmedia_v2023_10 → criteo_api_retailmedia_v2024_01}/model/async_line_items_report_resource.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_10.model.async_line_items_report import AsyncLineItemsReport
+    from criteo_api_retailmedia_v2024_01.model.async_line_items_report import AsyncLineItemsReport
     globals()['AsyncLineItemsReport'] = AsyncLineItemsReport
 
 

{criteo_api_retailmedia_v2023_10 → criteo_api_retailmedia_v2024_01}/model/async_report_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,12 +26,12 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_10.model.common_problem import CommonProblem
-    from criteo_api_retailmedia_v2023_10.model.status_response_resource import StatusResponseResource
+    from criteo_api_retailmedia_v2024_01.model.common_problem import CommonProblem
+    from criteo_api_retailmedia_v2024_01.model.status_response_resource import StatusResponseResource
     globals()['CommonProblem'] = CommonProblem
     globals()['StatusResponseResource'] = StatusResponseResource