criteo-api-marketingsolutions-sdk 2025.1.0.250606__py3-none-any.whl → 2025.4.0.250606__py3-none-any.whl

{criteo_api_marketingsolutions_v2025_01 → criteo_api_marketingsolutions_v2025_04}/api/campaign_api.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: 2025-01
+    The version of the OpenAPI document: 2025-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,8 +11,8 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_marketingsolutions_v2025_01.api_client import ApiClient, Endpoint as _Endpoint
-from criteo_api_marketingsolutions_v2025_01.model_utils import (  # noqa: F401
+from criteo_api_marketingsolutions_v2025_04.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_marketingsolutions_v2025_04.model_utils import (  # noqa: F401
     check_allowed_values,
     check_validations,
     date,
@@ -21,28 +21,28 @@ from criteo_api_marketingsolutions_v2025_01.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
-from criteo_api_marketingsolutions_v2025_01.model.ad_set_audience_link_entity_v1_response import AdSetAudienceLinkEntityV1Response
-from criteo_api_marketingsolutions_v2025_01.model.ad_set_audience_link_input_entity_v1 import AdSetAudienceLinkInputEntityV1
-from criteo_api_marketingsolutions_v2025_01.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse
-from criteo_api_marketingsolutions_v2025_01.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse
-from criteo_api_marketingsolutions_v2025_01.model.ad_set_search_request_v24_q1 import AdSetSearchRequestV24Q1
-from criteo_api_marketingsolutions_v2025_01.model.campaign_search_request_v23_q1 import CampaignSearchRequestV23Q1
-from criteo_api_marketingsolutions_v2025_01.model.campaign_v23_q1_list_response import CampaignV23Q1ListResponse
-from criteo_api_marketingsolutions_v2025_01.model.campaign_v23_q1_response import CampaignV23Q1Response
-from criteo_api_marketingsolutions_v2025_01.model.create_ad_set_v24_q1_request import CreateAdSetV24Q1Request
-from criteo_api_marketingsolutions_v2025_01.model.create_campaign_request import CreateCampaignRequest
-from criteo_api_marketingsolutions_v2025_01.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest
-from criteo_api_marketingsolutions_v2025_01.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse
-from criteo_api_marketingsolutions_v2025_01.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest
-from criteo_api_marketingsolutions_v2025_01.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse
-from criteo_api_marketingsolutions_v2025_01.model.patch_campaign_list_request import PatchCampaignListRequest
-from criteo_api_marketingsolutions_v2025_01.model.patch_result_campaign_list_response import PatchResultCampaignListResponse
-from criteo_api_marketingsolutions_v2025_01.model.requests_ad_set_id import RequestsAdSetId
-from criteo_api_marketingsolutions_v2025_01.model.requests_patch_ad_set_v24_q1 import RequestsPatchAdSetV24Q1
-from criteo_api_marketingsolutions_v2025_01.model.response_read_ad_set_v24_q1 import ResponseReadAdSetV24Q1
-from criteo_api_marketingsolutions_v2025_01.model.responses_ad_set_id import ResponsesAdSetId
-from criteo_api_marketingsolutions_v2025_01.model.responses_ad_set_id_v24_q1 import ResponsesAdSetIdV24Q1
-from criteo_api_marketingsolutions_v2025_01.model.responses_read_ad_set_v24_q1 import ResponsesReadAdSetV24Q1
+from criteo_api_marketingsolutions_v2025_04.model.ad_set_audience_link_entity_v1_response import AdSetAudienceLinkEntityV1Response
+from criteo_api_marketingsolutions_v2025_04.model.ad_set_audience_link_input_entity_v1 import AdSetAudienceLinkInputEntityV1
+from criteo_api_marketingsolutions_v2025_04.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse
+from criteo_api_marketingsolutions_v2025_04.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse
+from criteo_api_marketingsolutions_v2025_04.model.ad_set_search_request_v24_q3 import AdSetSearchRequestV24Q3
+from criteo_api_marketingsolutions_v2025_04.model.campaign_search_request_v23_q1 import CampaignSearchRequestV23Q1
+from criteo_api_marketingsolutions_v2025_04.model.campaign_v23_q1_list_response import CampaignV23Q1ListResponse
+from criteo_api_marketingsolutions_v2025_04.model.campaign_v23_q1_response import CampaignV23Q1Response
+from criteo_api_marketingsolutions_v2025_04.model.create_ad_set_v24_q3_request import CreateAdSetV24Q3Request
+from criteo_api_marketingsolutions_v2025_04.model.create_campaign_request import CreateCampaignRequest
+from criteo_api_marketingsolutions_v2025_04.model.patch_ad_set_category_bid_list_request import PatchAdSetCategoryBidListRequest
+from criteo_api_marketingsolutions_v2025_04.model.patch_ad_set_category_bid_result_list_response import PatchAdSetCategoryBidResultListResponse
+from criteo_api_marketingsolutions_v2025_04.model.patch_ad_set_display_multiplier_list_request import PatchAdSetDisplayMultiplierListRequest
+from criteo_api_marketingsolutions_v2025_04.model.patch_ad_set_display_multiplier_result_list_response import PatchAdSetDisplayMultiplierResultListResponse
+from criteo_api_marketingsolutions_v2025_04.model.patch_campaign_list_request import PatchCampaignListRequest
+from criteo_api_marketingsolutions_v2025_04.model.patch_result_campaign_list_response import PatchResultCampaignListResponse
+from criteo_api_marketingsolutions_v2025_04.model.requests_ad_set_id import RequestsAdSetId
+from criteo_api_marketingsolutions_v2025_04.model.requests_patch_ad_set_v24_q3 import RequestsPatchAdSetV24Q3
+from criteo_api_marketingsolutions_v2025_04.model.response_read_ad_set_v24_q3 import ResponseReadAdSetV24Q3
+from criteo_api_marketingsolutions_v2025_04.model.responses_ad_set_id import ResponsesAdSetId
+from criteo_api_marketingsolutions_v2025_04.model.responses_ad_set_id_v24_q3 import ResponsesAdSetIdV24Q3
+from criteo_api_marketingsolutions_v2025_04.model.responses_read_ad_set_v24_q3 import ResponsesReadAdSetV24Q3
 
 
 class CampaignApi(object):
@@ -56,24 +56,24 @@ class CampaignApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.create_ad_set_v24_q1_endpoint = _Endpoint(
+        self.create_ad_set_v24_q3_endpoint = _Endpoint(
             settings={
-                'response_type': (ResponseReadAdSetV24Q1,),
+                'response_type': (ResponseReadAdSetV24Q3,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets',
-                'operation_id': 'create_ad_set_v24_q1',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets',
+                'operation_id': 'create_ad_set_v24_q3',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
-                    'create_ad_set_v24_q1_request',
+                    'create_ad_set_v24_q3_request',
                 ],
                 'required': [
-                    'create_ad_set_v24_q1_request',
+                    'create_ad_set_v24_q3_request',
                 ],
                 'nullable': [
                 ],
@@ -88,13 +88,13 @@ class CampaignApi(object):
                 'allowed_values': {
                 },
                 'openapi_types': {
-                    'create_ad_set_v24_q1_request':
-                        (CreateAdSetV24Q1Request,),
+                    'create_ad_set_v24_q3_request':
+                        (CreateAdSetV24Q3Request,),
                 },
                 'attribute_map': {
                 },
                 'location_map': {
-                    'create_ad_set_v24_q1_request': 'body',
+                    'create_ad_set_v24_q3_request': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -121,7 +121,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/campaigns',
+                'endpoint_path': '/2025-04/marketing-solutions/campaigns',
                 'operation_id': 'create_campaign',
                 'http_method': 'POST',
                 'servers': None,
@@ -172,15 +172,15 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
-        self.get_ad_set_v24_q1_endpoint = _Endpoint(
+        self.get_ad_set_v24_q3_endpoint = _Endpoint(
             settings={
-                'response_type': (ResponseReadAdSetV24Q1,),
+                'response_type': (ResponseReadAdSetV24Q3,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/{ad-set-id}',
-                'operation_id': 'get_ad_set_v24_q1',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/{ad-set-id}',
+                'operation_id': 'get_ad_set_v24_q3',
                 'http_method': 'GET',
                 'servers': None,
             },
@@ -233,7 +233,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/campaigns/{campaign-id}',
+                'endpoint_path': '/2025-04/marketing-solutions/campaigns/{campaign-id}',
                 'operation_id': 'get_campaign_v23_q1',
                 'http_method': 'GET',
                 'servers': None,
@@ -287,7 +287,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
                 'operation_id': 'get_category_bid_list',
                 'http_method': 'GET',
                 'servers': None,
@@ -341,7 +341,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
                 'operation_id': 'get_display_multipliers',
                 'http_method': 'GET',
                 'servers': None,
@@ -388,21 +388,21 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
-        self.patch_ad_sets_v24_q1_endpoint = _Endpoint(
+        self.patch_ad_sets_v24_q3_endpoint = _Endpoint(
             settings={
-                'response_type': (ResponsesAdSetIdV24Q1,),
+                'response_type': (ResponsesAdSetIdV24Q3,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets',
-                'operation_id': 'patch_ad_sets_v24_q1',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets',
+                'operation_id': 'patch_ad_sets_v24_q3',
                 'http_method': 'PATCH',
                 'servers': None,
             },
             params_map={
                 'all': [
-                    'requests_patch_ad_set_v24_q1',
+                    'requests_patch_ad_set_v24_q3',
                 ],
                 'required': [],
                 'nullable': [
@@ -418,13 +418,13 @@ class CampaignApi(object):
                 'allowed_values': {
                 },
                 'openapi_types': {
-                    'requests_patch_ad_set_v24_q1':
-                        (RequestsPatchAdSetV24Q1,),
+                    'requests_patch_ad_set_v24_q3':
+                        (RequestsPatchAdSetV24Q3,),
                 },
                 'attribute_map': {
                 },
                 'location_map': {
-                    'requests_patch_ad_set_v24_q1': 'body',
+                    'requests_patch_ad_set_v24_q3': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -451,7 +451,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/campaigns',
+                'endpoint_path': '/2025-04/marketing-solutions/campaigns',
                 'operation_id': 'patch_campaigns',
                 'http_method': 'PATCH',
                 'servers': None,
@@ -507,7 +507,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
                 'operation_id': 'patch_category_bid_list',
                 'http_method': 'PATCH',
                 'servers': None,
@@ -570,7 +570,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
                 'operation_id': 'patch_display_multipliers',
                 'http_method': 'PATCH',
                 'servers': None,
@@ -626,21 +626,21 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
-        self.search_ad_sets_v24_q1_endpoint = _Endpoint(
+        self.search_ad_sets_v24_q3_endpoint = _Endpoint(
             settings={
-                'response_type': (ResponsesReadAdSetV24Q1,),
+                'response_type': (ResponsesReadAdSetV24Q3,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/search',
-                'operation_id': 'search_ad_sets_v24_q1',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/search',
+                'operation_id': 'search_ad_sets_v24_q3',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
-                    'ad_set_search_request_v24_q1',
+                    'ad_set_search_request_v24_q3',
                 ],
                 'required': [],
                 'nullable': [
@@ -656,13 +656,13 @@ class CampaignApi(object):
                 'allowed_values': {
                 },
                 'openapi_types': {
-                    'ad_set_search_request_v24_q1':
-                        (AdSetSearchRequestV24Q1,),
+                    'ad_set_search_request_v24_q3':
+                        (AdSetSearchRequestV24Q3,),
                 },
                 'attribute_map': {
                 },
                 'location_map': {
-                    'ad_set_search_request_v24_q1': 'body',
+                    'ad_set_search_request_v24_q3': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -689,7 +689,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/campaigns/search',
+                'endpoint_path': '/2025-04/marketing-solutions/campaigns/search',
                 'operation_id': 'search_campaigns_v23_q1',
                 'http_method': 'POST',
                 'servers': None,
@@ -745,7 +745,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/start',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/start',
                 'operation_id': 'start_ad_sets',
                 'http_method': 'POST',
                 'servers': None,
@@ -801,7 +801,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/stop',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/stop',
                 'operation_id': 'stop_ad_sets',
                 'http_method': 'POST',
                 'servers': None,
@@ -857,7 +857,7 @@ class CampaignApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2025-01/marketing-solutions/ad-sets/{ad-set-id}/audience',
+                'endpoint_path': '/2025-04/marketing-solutions/ad-sets/{ad-set-id}/audience',
                 'operation_id': 'update_ad_set_audience',
                 'http_method': 'PUT',
                 'servers': None,
@@ -915,22 +915,22 @@ class CampaignApi(object):
             api_client=api_client
         )
 
-    def create_ad_set_v24_q1(
+    def create_ad_set_v24_q3(
         self,
-        create_ad_set_v24_q1_request,
+        create_ad_set_v24_q3_request,
         **kwargs
     ):
-        """create_ad_set_v24_q1  # noqa: E501
+        """create_ad_set_v24_q3  # noqa: E501
 
         Create the specified ad set  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.create_ad_set_v24_q1(create_ad_set_v24_q1_request, async_req=True)
+        >>> thread = api.create_ad_set_v24_q3(create_ad_set_v24_q3_request, async_req=True)
         >>> result = thread.get()
 
         Args:
-            create_ad_set_v24_q1_request (CreateAdSetV24Q1Request): the ad sets to create
+            create_ad_set_v24_q3_request (CreateAdSetV24Q3Request): the ad sets to create
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -965,7 +965,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResponseReadAdSetV24Q1
+            ResponseReadAdSetV24Q3
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -994,9 +994,9 @@ class CampaignApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        kwargs['create_ad_set_v24_q1_request'] = \
-            create_ad_set_v24_q1_request
-        return self.create_ad_set_v24_q1_endpoint.call_with_http_info(**kwargs)
+        kwargs['create_ad_set_v24_q3_request'] = \
+            create_ad_set_v24_q3_request
+        return self.create_ad_set_v24_q3_endpoint.call_with_http_info(**kwargs)
 
     def create_campaign(
         self,
@@ -1081,18 +1081,18 @@ class CampaignApi(object):
             create_campaign_request
         return self.create_campaign_endpoint.call_with_http_info(**kwargs)
 
-    def get_ad_set_v24_q1(
+    def get_ad_set_v24_q3(
         self,
         ad_set_id,
         **kwargs
     ):
-        """get_ad_set_v24_q1  # noqa: E501
+        """get_ad_set_v24_q3  # noqa: E501
 
         Get the data for the specified ad set  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_ad_set_v24_q1(ad_set_id, async_req=True)
+        >>> thread = api.get_ad_set_v24_q3(ad_set_id, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -1131,7 +1131,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResponseReadAdSetV24Q1
+            ResponseReadAdSetV24Q3
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -1162,7 +1162,7 @@ class CampaignApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['ad_set_id'] = \
             ad_set_id
-        return self.get_ad_set_v24_q1_endpoint.call_with_http_info(**kwargs)
+        return self.get_ad_set_v24_q3_endpoint.call_with_http_info(**kwargs)
 
     def get_campaign_v23_q1(
         self,
@@ -1413,22 +1413,22 @@ class CampaignApi(object):
             ad_set_id
         return self.get_display_multipliers_endpoint.call_with_http_info(**kwargs)
 
-    def patch_ad_sets_v24_q1(
+    def patch_ad_sets_v24_q3(
         self,
         **kwargs
     ):
-        """patch_ad_sets_v24_q1  # noqa: E501
+        """patch_ad_sets_v24_q3  # noqa: E501
 
         Patch a list of AdSets.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.patch_ad_sets_v24_q1(async_req=True)
+        >>> thread = api.patch_ad_sets_v24_q3(async_req=True)
         >>> result = thread.get()
 
 
         Keyword Args:
-            requests_patch_ad_set_v24_q1 (RequestsPatchAdSetV24Q1): List of adsets to patch.. [optional]
+            requests_patch_ad_set_v24_q3 (RequestsPatchAdSetV24Q3): List of adsets to patch.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1461,7 +1461,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResponsesAdSetIdV24Q1
+            ResponsesAdSetIdV24Q3
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -1490,7 +1490,7 @@ class CampaignApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        return self.patch_ad_sets_v24_q1_endpoint.call_with_http_info(**kwargs)
+        return self.patch_ad_sets_v24_q3_endpoint.call_with_http_info(**kwargs)
 
     def patch_campaigns(
         self,
@@ -1739,22 +1739,22 @@ class CampaignApi(object):
             ad_set_id
         return self.patch_display_multipliers_endpoint.call_with_http_info(**kwargs)
 
-    def search_ad_sets_v24_q1(
+    def search_ad_sets_v24_q3(
         self,
         **kwargs
     ):
-        """search_ad_sets_v24_q1  # noqa: E501
+        """search_ad_sets_v24_q3  # noqa: E501
 
         Search for ad sets  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.search_ad_sets_v24_q1(async_req=True)
+        >>> thread = api.search_ad_sets_v24_q3(async_req=True)
         >>> result = thread.get()
 
 
         Keyword Args:
-            ad_set_search_request_v24_q1 (AdSetSearchRequestV24Q1): [optional]
+            ad_set_search_request_v24_q3 (AdSetSearchRequestV24Q3): [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1787,7 +1787,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResponsesReadAdSetV24Q1
+            ResponsesReadAdSetV24Q3
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -1816,7 +1816,7 @@ class CampaignApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        return self.search_ad_sets_v24_q1_endpoint.call_with_http_info(**kwargs)
+        return self.search_ad_sets_v24_q3_endpoint.call_with_http_info(**kwargs)
 
     def search_campaigns_v23_q1(
         self,