criteo-api-retailmedia-sdk 2024.1.0.240808__py3-none-any.whl → 2024.1.0.250129__py3-none-any.whl

criteo_api_retailmedia_v2024_01/api/campaign_api.py

@@ -64,7 +64,6 @@ from criteo_api_retailmedia_v2024_01.model.preferred_line_item_create_model20211
 from criteo_api_retailmedia_v2024_01.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request
 from criteo_api_retailmedia_v2024_01.model.promoted_product202110_list_request import PromotedProduct202110ListRequest
 from criteo_api_retailmedia_v2024_01.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse
-from criteo_api_retailmedia_v2024_01.model.proposal_status_model_response import ProposalStatusModelResponse
 from criteo_api_retailmedia_v2024_01.model.put_campaign_v202301 import PutCampaignV202301
 from criteo_api_retailmedia_v2024_01.model.resource_outcome import ResourceOutcome
 from criteo_api_retailmedia_v2024_01.model.set_bids_model_request import SetBidsModelRequest
@@ -256,58 +255,6 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
-        self.fetch_proposal_endpoint = _Endpoint(
-            settings={
-                'response_type': (ProposalStatusModelResponse,),
-                'auth': [
-                    'oauth',
-                    'oauth'
-                ],
-                'endpoint_path': '/2024-01/retail-media/preferred-deal-line-items/{id}/proposal',
-                'operation_id': 'fetch_proposal',
-                'http_method': 'GET',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'id',
-                ],
-                'required': [
-                    'id',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'id':
-                        (str,),
-                },
-                'attribute_map': {
-                    'id': 'id',
-                },
-                'location_map': {
-                    'id': 'path',
-                },
-                'collection_format_map': {
-                }
-            },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [],
-            },
-            api_client=api_client
-        )
         self.get_api202110_external_account_creatives_by_account_id_endpoint = _Endpoint(
             settings={
                 'response_type': (Creative202110ListResponse,),
@@ -354,7 +301,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
@@ -989,7 +938,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
@@ -1041,7 +992,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
@@ -1099,7 +1052,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
@@ -2802,7 +2757,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [
                     'application/json'
@@ -2862,7 +2819,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
@@ -3330,7 +3289,9 @@ class CampaignApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [
                     'application/json'
@@ -3572,58 +3533,6 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
-        self.submit_proposal_endpoint = _Endpoint(
-            settings={
-                'response_type': (ProposalStatusModelResponse,),
-                'auth': [
-                    'oauth',
-                    'oauth'
-                ],
-                'endpoint_path': '/2024-01/retail-media/preferred-deal-line-items/{id}/proposal/submit',
-                'operation_id': 'submit_proposal',
-                'http_method': 'POST',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'id',
-                ],
-                'required': [
-                    'id',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'id':
-                        (str,),
-                },
-                'attribute_map': {
-                    'id': 'id',
-                },
-                'location_map': {
-                    'id': 'path',
-                },
-                'collection_format_map': {
-                }
-            },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [],
-            },
-            api_client=api_client
-        )
         self.update_campaign_budget_overrides_endpoint = _Endpoint(
             settings={
                 'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
@@ -3997,89 +3906,6 @@ class CampaignApi(object):
             id
         return self.fetch_keywords_endpoint.call_with_http_info(**kwargs)
 
-    def fetch_proposal(
-        self,
-        id,
-        **kwargs
-    ):
-        """fetch_proposal  # noqa: E501
-
-        Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.fetch_proposal(id, async_req=True)
-        >>> result = thread.get()
-
-        Args:
-            id (str): ID of the line item
-
-        Keyword Args:
-            _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
-                will be returned without reading/decoding response data.
-                Default is True.
-            _request_timeout (int/float/tuple): timeout setting for this request. If
-                one number provided, it will be total request timeout. It can also
-                be a pair (tuple) of (connection, read) timeouts.
-                Default is None.
-            _check_input_type (bool): specifies if type checking
-                should be done one the data sent to the server.
-                Default is True.
-            _check_return_type (bool): specifies if type checking
-                should be done one the data received from the server.
-                Default is True.
-            _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)
-            _content_type (str/None): force body content-type.
-                Default is None and content-type will be predicted by allowed
-                content-types and body.
-            _host_index (int/None): specifies the index of the server
-                that we want to use.
-                Default is read from the configuration.
-            _request_auths (list): set to override the auth_settings for an a single
-                request; this effectively ignores the authentication
-                in the spec for a single request.
-                Default is None
-            async_req (bool): execute request asynchronously
-
-        Returns:
-            ProposalStatusModelResponse
-                If the method is called asynchronously, returns the request
-                thread.
-        """
-        kwargs['async_req'] = kwargs.get(
-            'async_req', False
-        )
-        kwargs['_return_http_data_only'] = kwargs.get(
-            '_return_http_data_only', True
-        )
-        kwargs['_preload_content'] = kwargs.get(
-            '_preload_content', True
-        )
-        kwargs['_request_timeout'] = kwargs.get(
-            '_request_timeout', None
-        )
-        kwargs['_check_input_type'] = kwargs.get(
-            '_check_input_type', True
-        )
-        kwargs['_check_return_type'] = kwargs.get(
-            '_check_return_type', True
-        )
-        kwargs['_spec_property_naming'] = kwargs.get(
-            '_spec_property_naming', False
-        )
-        kwargs['_content_type'] = kwargs.get(
-            '_content_type')
-        kwargs['_host_index'] = kwargs.get('_host_index')
-        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        kwargs['id'] = \
-            id
-        return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
-
     def get_api202110_external_account_creatives_by_account_id(
         self,
         account_id,
@@ -8791,89 +8617,6 @@ class CampaignApi(object):
             id
         return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
 
-    def submit_proposal(
-        self,
-        id,
-        **kwargs
-    ):
-        """submit_proposal  # noqa: E501
-
-        Only the components of the Line Item that are in a valid state will be reviewed.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.submit_proposal(id, async_req=True)
-        >>> result = thread.get()
-
-        Args:
-            id (str): ID of the line item
-
-        Keyword Args:
-            _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
-                will be returned without reading/decoding response data.
-                Default is True.
-            _request_timeout (int/float/tuple): timeout setting for this request. If
-                one number provided, it will be total request timeout. It can also
-                be a pair (tuple) of (connection, read) timeouts.
-                Default is None.
-            _check_input_type (bool): specifies if type checking
-                should be done one the data sent to the server.
-                Default is True.
-            _check_return_type (bool): specifies if type checking
-                should be done one the data received from the server.
-                Default is True.
-            _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)
-            _content_type (str/None): force body content-type.
-                Default is None and content-type will be predicted by allowed
-                content-types and body.
-            _host_index (int/None): specifies the index of the server
-                that we want to use.
-                Default is read from the configuration.
-            _request_auths (list): set to override the auth_settings for an a single
-                request; this effectively ignores the authentication
-                in the spec for a single request.
-                Default is None
-            async_req (bool): execute request asynchronously
-
-        Returns:
-            ProposalStatusModelResponse
-                If the method is called asynchronously, returns the request
-                thread.
-        """
-        kwargs['async_req'] = kwargs.get(
-            'async_req', False
-        )
-        kwargs['_return_http_data_only'] = kwargs.get(
-            '_return_http_data_only', True
-        )
-        kwargs['_preload_content'] = kwargs.get(
-            '_preload_content', True
-        )
-        kwargs['_request_timeout'] = kwargs.get(
-            '_request_timeout', None
-        )
-        kwargs['_check_input_type'] = kwargs.get(
-            '_check_input_type', True
-        )
-        kwargs['_check_return_type'] = kwargs.get(
-            '_check_return_type', True
-        )
-        kwargs['_spec_property_naming'] = kwargs.get(
-            '_spec_property_naming', False
-        )
-        kwargs['_content_type'] = kwargs.get(
-            '_content_type')
-        kwargs['_host_index'] = kwargs.get('_host_index')
-        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        kwargs['id'] = \
-            id
-        return self.submit_proposal_endpoint.call_with_http_info(**kwargs)
-
     def update_campaign_budget_overrides(
         self,
         campaign_id,

criteo_api_retailmedia_v2024_01/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/2024.01.0.240808/python'
+        self.user_agent = 'OpenAPI-Generator/2024.01.0.250129/python'
 
     def __enter__(self):
         return self

criteo_api_retailmedia_v2024_01/configuration.py

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

criteo_api_retailmedia_v2024_01/model/async_campaigns_report.py

@@ -55,6 +55,18 @@ class AsyncCampaignsReport(ModelNormal):
     """
 
     allowed_values = {
+        ('search_term_types',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'SEARCHED': "searched",
+            'ENTERED': "entered",
+        },
+        ('search_term_targetings',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'AUTOMATIC': "automatic",
+            'MANUAL': "manual",
+        },
         ('campaign_type',): {
             'None': None,
             'ALL': "all",
@@ -84,6 +96,7 @@ class AsyncCampaignsReport(ModelNormal):
             'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
             'ENVIRONMENT': "environment",
             'SERVEDCATEGORY': "servedCategory",
+            'CAPOUT': "capout",
         },
         ('click_attribution_window',): {
             'None': None,
@@ -122,9 +135,18 @@ class AsyncCampaignsReport(ModelNormal):
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
             'PAGECATEGORY': "pageCategory",
+            'SERVEDCATEGORY': "servedCategory",
             'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
             'KEYWORD': "keyword",
             'SEARCHTERM': "searchTerm",
+            'SEARCHTERMTYPE': "searchTermType",
+            'SEARCHTERMTARGETING': "searchTermTargeting",
+            'CREATIVEID': "creativeId",
+            'CREATIVENAME': "creativeName",
+            'CREATIVETYPEID': "creativeTypeId",
+            'CREATIVETYPENAME': "creativeTypeName",
+            'CREATIVETEMPLATEID': "creativeTemplateId",
+            'CREATIVETEMPLATENAME': "creativeTemplateName",
         },
         ('metrics',): {
             'None': None,
@@ -149,6 +171,16 @@ class AsyncCampaignsReport(ModelNormal):
             'VIDEOSPLAYEDTO100': "videosPlayedTo100",
             'VIDEOPLAYINGRATE': "videoPlayingRate",
             'VIDEOCOMPLETIONRATE': "videoCompletionRate",
+            'VIDEOIMPRESSIONS': "videoImpressions",
+            'VIDEOMUTED': "videoMuted",
+            'VIDEOUNMUTED': "videoUnmuted",
+            'VIDEOPAUSED': "videoPaused",
+            'VIDEORESUMED': "videoResumed",
+            'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
+            'VIDEOVIEWABILITY': "videoViewability",
+            'VIDEOSTARTINGRATE': "videoStartingRate",
+            'VIDEOCPC': "videoCPC",
+            'VIDEOCPCV': "videoCPCV",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },
@@ -182,6 +214,8 @@ class AsyncCampaignsReport(ModelNormal):
             'end_date': (datetime,),  # noqa: E501
             'ids': ([str], none_type,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
+            'search_term_types': ([str], none_type,),  # noqa: E501
+            'search_term_targetings': ([str], none_type,),  # noqa: E501
             'campaign_type': (str, none_type,),  # noqa: E501
             'sales_channel': (str, none_type,),  # noqa: E501
             'format': (str, none_type,),  # noqa: E501
@@ -203,6 +237,8 @@ class AsyncCampaignsReport(ModelNormal):
         'end_date': 'endDate',  # noqa: E501
         'ids': 'ids',  # noqa: E501
         'id': 'id',  # noqa: E501
+        'search_term_types': 'searchTermTypes',  # noqa: E501
+        'search_term_targetings': 'searchTermTargetings',  # noqa: E501
         'campaign_type': 'campaignType',  # noqa: E501
         'sales_channel': 'salesChannel',  # noqa: E501
         'format': 'format',  # noqa: E501
@@ -261,6 +297,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
+            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
+            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [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
@@ -363,6 +401,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
+            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
+            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [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

criteo_api_retailmedia_v2024_01/model/async_line_items_report.py

@@ -55,6 +55,18 @@ class AsyncLineItemsReport(ModelNormal):
     """
 
     allowed_values = {
+        ('search_term_types',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'SEARCHED': "searched",
+            'ENTERED': "entered",
+        },
+        ('search_term_targetings',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'AUTOMATIC': "automatic",
+            'MANUAL': "manual",
+        },
         ('campaign_type',): {
             'None': None,
             'ALL': "all",
@@ -84,6 +96,7 @@ class AsyncLineItemsReport(ModelNormal):
             'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
             'ENVIRONMENT': "environment",
             'SERVEDCATEGORY': "servedCategory",
+            'CAPOUT': "capout",
         },
         ('click_attribution_window',): {
             'None': None,
@@ -122,9 +135,18 @@ class AsyncLineItemsReport(ModelNormal):
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
             'PAGECATEGORY': "pageCategory",
+            'SERVEDCATEGORY': "servedCategory",
             'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
             'KEYWORD': "keyword",
             'SEARCHTERM': "searchTerm",
+            'SEARCHTERMTYPE': "searchTermType",
+            'SEARCHTERMTARGETING': "searchTermTargeting",
+            'CREATIVEID': "creativeId",
+            'CREATIVENAME': "creativeName",
+            'CREATIVETYPEID': "creativeTypeId",
+            'CREATIVETYPENAME': "creativeTypeName",
+            'CREATIVETEMPLATEID': "creativeTemplateId",
+            'CREATIVETEMPLATENAME': "creativeTemplateName",
         },
         ('metrics',): {
             'None': None,
@@ -149,6 +171,16 @@ class AsyncLineItemsReport(ModelNormal):
             'VIDEOSPLAYEDTO100': "videosPlayedTo100",
             'VIDEOPLAYINGRATE': "videoPlayingRate",
             'VIDEOCOMPLETIONRATE': "videoCompletionRate",
+            'VIDEOIMPRESSIONS': "videoImpressions",
+            'VIDEOMUTED': "videoMuted",
+            'VIDEOUNMUTED': "videoUnmuted",
+            'VIDEOPAUSED': "videoPaused",
+            'VIDEORESUMED': "videoResumed",
+            'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
+            'VIDEOVIEWABILITY': "videoViewability",
+            'VIDEOSTARTINGRATE': "videoStartingRate",
+            'VIDEOCPC': "videoCPC",
+            'VIDEOCPCV': "videoCPCV",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },
@@ -182,6 +214,8 @@ class AsyncLineItemsReport(ModelNormal):
             'end_date': (datetime,),  # noqa: E501
             'ids': ([str], none_type,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
+            'search_term_types': ([str], none_type,),  # noqa: E501
+            'search_term_targetings': ([str], none_type,),  # noqa: E501
             'campaign_type': (str, none_type,),  # noqa: E501
             'sales_channel': (str, none_type,),  # noqa: E501
             'format': (str, none_type,),  # noqa: E501
@@ -203,6 +237,8 @@ class AsyncLineItemsReport(ModelNormal):
         'end_date': 'endDate',  # noqa: E501
         'ids': 'ids',  # noqa: E501
         'id': 'id',  # noqa: E501
+        'search_term_types': 'searchTermTypes',  # noqa: E501
+        'search_term_targetings': 'searchTermTargetings',  # noqa: E501
         'campaign_type': 'campaignType',  # noqa: E501
         'sales_channel': 'salesChannel',  # noqa: E501
         'format': 'format',  # noqa: E501
@@ -261,6 +297,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
+            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
+            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [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
@@ -363,6 +401,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
+            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
+            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [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