|
| 1 | +# criteo\api\retailmedia\preview\BillingApi |
| 2 | + |
| 3 | +All URIs are relative to https://api.criteo.com, except if the operation defines another base path. |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------------- | ------------- | ------------- | |
| 7 | +| [**previewRetailMediaBillingPartnerReportPost()**](BillingApi.md#previewRetailMediaBillingPartnerReportPost) | **POST** /preview/retail-media/billing/partner-report | | |
| 8 | +| [**previewRetailMediaBillingPartnerReportRequestIdOutputGet()**](BillingApi.md#previewRetailMediaBillingPartnerReportRequestIdOutputGet) | **GET** /preview/retail-media/billing/partner-report/{requestId}/output | | |
| 9 | +| [**previewRetailMediaBillingPartnerReportRequestIdStatusGet()**](BillingApi.md#previewRetailMediaBillingPartnerReportRequestIdStatusGet) | **GET** /preview/retail-media/billing/partner-report/{requestId}/status | | |
| 10 | + |
| 11 | + |
| 12 | +## `previewRetailMediaBillingPartnerReportPost()` |
| 13 | + |
| 14 | +```php |
| 15 | +previewRetailMediaBillingPartnerReportPost($value_resource_input_partner_billing_report_request_v1): \criteo\api\retailmedia\preview\Model\EntityResourceOutcomePartnerBillingReportStatusV1 |
| 16 | +``` |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +Create a Partner Billing Report request. |
| 21 | + |
| 22 | +### Example |
| 23 | + |
| 24 | +```php |
| 25 | +<?php |
| 26 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 27 | + |
| 28 | + |
| 29 | +// Configure OAuth2 access token for authorization: oauth |
| 30 | +$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 31 | + |
| 32 | +// Configure OAuth2 access token for authorization: oauth |
| 33 | +$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 34 | + |
| 35 | + |
| 36 | +$apiInstance = new criteo\api\retailmedia\preview\Api\BillingApi( |
| 37 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 38 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 39 | + new GuzzleHttp\Client(), |
| 40 | + $config |
| 41 | +); |
| 42 | +$value_resource_input_partner_billing_report_request_v1 = new \criteo\api\retailmedia\preview\Model\ValueResourceInputPartnerBillingReportRequestV1(); // \criteo\api\retailmedia\preview\Model\ValueResourceInputPartnerBillingReportRequestV1 | Partner Billing Report request object. |
| 43 | + |
| 44 | +try { |
| 45 | + $result = $apiInstance->previewRetailMediaBillingPartnerReportPost($value_resource_input_partner_billing_report_request_v1); |
| 46 | + print_r($result); |
| 47 | +} catch (Exception $e) { |
| 48 | + echo 'Exception when calling BillingApi->previewRetailMediaBillingPartnerReportPost: ', $e->getMessage(), PHP_EOL; |
| 49 | +} |
| 50 | +``` |
| 51 | + |
| 52 | +### Parameters |
| 53 | + |
| 54 | +| Name | Type | Description | Notes | |
| 55 | +| ------------- | ------------- | ------------- | ------------- | |
| 56 | +| **value_resource_input_partner_billing_report_request_v1** | [**\criteo\api\retailmedia\preview\Model\ValueResourceInputPartnerBillingReportRequestV1**](../Model/ValueResourceInputPartnerBillingReportRequestV1.md)| Partner Billing Report request object. | [optional] | |
| 57 | + |
| 58 | +### Return type |
| 59 | + |
| 60 | +[**\criteo\api\retailmedia\preview\Model\EntityResourceOutcomePartnerBillingReportStatusV1**](../Model/EntityResourceOutcomePartnerBillingReportStatusV1.md) |
| 61 | + |
| 62 | +### Authorization |
| 63 | + |
| 64 | +[oauth](../../README.md#oauth), [oauth](../../README.md#oauth) |
| 65 | + |
| 66 | +### HTTP request headers |
| 67 | + |
| 68 | +- **Content-Type**: `application/json` |
| 69 | +- **Accept**: `text/plain`, `application/json`, `text/json` |
| 70 | + |
| 71 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 72 | +[[Back to Model list]](../../README.md#models) |
| 73 | +[[Back to README]](../../README.md) |
| 74 | + |
| 75 | +## `previewRetailMediaBillingPartnerReportRequestIdOutputGet()` |
| 76 | + |
| 77 | +```php |
| 78 | +previewRetailMediaBillingPartnerReportRequestIdOutputGet($request_id): \SplFileObject |
| 79 | +``` |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +Get the output of an existing Partner Billing Report. |
| 84 | + |
| 85 | +### Example |
| 86 | + |
| 87 | +```php |
| 88 | +<?php |
| 89 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 90 | + |
| 91 | + |
| 92 | +// Configure OAuth2 access token for authorization: oauth |
| 93 | +$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 94 | + |
| 95 | +// Configure OAuth2 access token for authorization: oauth |
| 96 | +$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 97 | + |
| 98 | + |
| 99 | +$apiInstance = new criteo\api\retailmedia\preview\Api\BillingApi( |
| 100 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 101 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 102 | + new GuzzleHttp\Client(), |
| 103 | + $config |
| 104 | +); |
| 105 | +$request_id = 'request_id_example'; // string | The id of a Partner Billing Report request. |
| 106 | + |
| 107 | +try { |
| 108 | + $result = $apiInstance->previewRetailMediaBillingPartnerReportRequestIdOutputGet($request_id); |
| 109 | + print_r($result); |
| 110 | +} catch (Exception $e) { |
| 111 | + echo 'Exception when calling BillingApi->previewRetailMediaBillingPartnerReportRequestIdOutputGet: ', $e->getMessage(), PHP_EOL; |
| 112 | +} |
| 113 | +``` |
| 114 | + |
| 115 | +### Parameters |
| 116 | + |
| 117 | +| Name | Type | Description | Notes | |
| 118 | +| ------------- | ------------- | ------------- | ------------- | |
| 119 | +| **request_id** | **string**| The id of a Partner Billing Report request. | | |
| 120 | + |
| 121 | +### Return type |
| 122 | + |
| 123 | +**\SplFileObject** |
| 124 | + |
| 125 | +### Authorization |
| 126 | + |
| 127 | +[oauth](../../README.md#oauth), [oauth](../../README.md#oauth) |
| 128 | + |
| 129 | +### HTTP request headers |
| 130 | + |
| 131 | +- **Content-Type**: Not defined |
| 132 | +- **Accept**: `application/csv`, `application/json` |
| 133 | + |
| 134 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 135 | +[[Back to Model list]](../../README.md#models) |
| 136 | +[[Back to README]](../../README.md) |
| 137 | + |
| 138 | +## `previewRetailMediaBillingPartnerReportRequestIdStatusGet()` |
| 139 | + |
| 140 | +```php |
| 141 | +previewRetailMediaBillingPartnerReportRequestIdStatusGet($request_id): \criteo\api\retailmedia\preview\Model\EntityResourceOutcomePartnerBillingReportStatusV1 |
| 142 | +``` |
| 143 | + |
| 144 | + |
| 145 | + |
| 146 | +Get the status of an existing Partner Billing Report. |
| 147 | + |
| 148 | +### Example |
| 149 | + |
| 150 | +```php |
| 151 | +<?php |
| 152 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 153 | + |
| 154 | + |
| 155 | +// Configure OAuth2 access token for authorization: oauth |
| 156 | +$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 157 | + |
| 158 | +// Configure OAuth2 access token for authorization: oauth |
| 159 | +$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 160 | + |
| 161 | + |
| 162 | +$apiInstance = new criteo\api\retailmedia\preview\Api\BillingApi( |
| 163 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 164 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 165 | + new GuzzleHttp\Client(), |
| 166 | + $config |
| 167 | +); |
| 168 | +$request_id = 'request_id_example'; // string | The id of a Partner Billing Report request. |
| 169 | + |
| 170 | +try { |
| 171 | + $result = $apiInstance->previewRetailMediaBillingPartnerReportRequestIdStatusGet($request_id); |
| 172 | + print_r($result); |
| 173 | +} catch (Exception $e) { |
| 174 | + echo 'Exception when calling BillingApi->previewRetailMediaBillingPartnerReportRequestIdStatusGet: ', $e->getMessage(), PHP_EOL; |
| 175 | +} |
| 176 | +``` |
| 177 | + |
| 178 | +### Parameters |
| 179 | + |
| 180 | +| Name | Type | Description | Notes | |
| 181 | +| ------------- | ------------- | ------------- | ------------- | |
| 182 | +| **request_id** | **string**| The id of a Partner Billing Report request. | | |
| 183 | + |
| 184 | +### Return type |
| 185 | + |
| 186 | +[**\criteo\api\retailmedia\preview\Model\EntityResourceOutcomePartnerBillingReportStatusV1**](../Model/EntityResourceOutcomePartnerBillingReportStatusV1.md) |
| 187 | + |
| 188 | +### Authorization |
| 189 | + |
| 190 | +[oauth](../../README.md#oauth), [oauth](../../README.md#oauth) |
| 191 | + |
| 192 | +### HTTP request headers |
| 193 | + |
| 194 | +- **Content-Type**: Not defined |
| 195 | +- **Accept**: `text/plain`, `application/json`, `text/json` |
| 196 | + |
| 197 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 198 | +[[Back to Model list]](../../README.md#models) |
| 199 | +[[Back to README]](../../README.md) |
0 commit comments