|
| 1 | +# AdAcoApi |
| 2 | + |
| 3 | +All URIs are relative to *https://business-api.tiktok.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**adAcoCreate**](AdAcoApi.md#adAcoCreate) | **POST** /open_api/v1.3/ad/aco/create/ | Create an ACO ad by uploading necessary ad creatives to the library. [Ad Aco Create](https://ads.tiktok.com/marketing_api/docs?id=1739473063234626) |
| 8 | +[**adAcoGet**](AdAcoApi.md#adAcoGet) | **GET** /open_api/v1.3/ad/aco/get/ | Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. [Ad Aco Get](https://ads.tiktok.com/marketing_api/docs?id=1739473020978177) |
| 9 | +[**adAcoMaterialStatusUpdate**](AdAcoApi.md#adAcoMaterialStatusUpdate) | **POST** /open_api/v1.3/ad/aco/material_status/update/ | Update the status of creative materials for an ACO ad, including ad texts, images, and video materials [Update materials](https://ads.tiktok.com/marketing_api/docs?id=1739506701165570) |
| 10 | +[**adAcoUpdate**](AdAcoApi.md#adAcoUpdate) | **POST** /open_api/v1.3/ad/aco/update/ | Modify ACO ad creatives. [Update ACO](https://ads.tiktok.com/marketing_api/docs?id=1739473077112833) |
| 11 | + |
| 12 | +<a name="adAcoCreate"></a> |
| 13 | +# **adAcoCreate** |
| 14 | +> Response adAcoCreate(accessToken, body) |
| 15 | +
|
| 16 | +Create an ACO ad by uploading necessary ad creatives to the library. [Ad Aco Create](https://ads.tiktok.com/marketing_api/docs?id=1739473063234626) |
| 17 | + |
| 18 | +### Example |
| 19 | +```java |
| 20 | +// Import classes: |
| 21 | +//import business_api.ApiException; |
| 22 | +//import io.swagger.client.api.AdAcoApi; |
| 23 | + |
| 24 | + |
| 25 | +AdAcoApi apiInstance = new AdAcoApi(); |
| 26 | +String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |
| 27 | +AdAcoBody body = new AdAcoBody(); // AdAcoBody | Ad Aco update parameters. |
| 28 | +try { |
| 29 | + Response result = apiInstance.adAcoCreate(accessToken, body); |
| 30 | + System.out.println(result); |
| 31 | +} catch (ApiException e) { |
| 32 | + System.err.println("Exception when calling AdAcoApi#adAcoCreate"); |
| 33 | + e.printStackTrace(); |
| 34 | +} |
| 35 | +``` |
| 36 | + |
| 37 | +### Parameters |
| 38 | + |
| 39 | +Name | Type | Description | Notes |
| 40 | +------------- | ------------- | ------------- | ------------- |
| 41 | + **accessToken** | **String**| Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |[required] |
| 42 | + **body** | [**AdAcoBody**](AdAcoBody.md)| Ad Aco update parameters. | [optional] |
| 43 | + |
| 44 | +### Return type |
| 45 | + |
| 46 | +[**Response**](Response.md) |
| 47 | + |
| 48 | +### Authorization |
| 49 | + |
| 50 | +No authorization required |
| 51 | + |
| 52 | +### HTTP request headers |
| 53 | + |
| 54 | + - **Content-Type**: application/json |
| 55 | + - **Accept**: application/json |
| 56 | + |
| 57 | +<a name="adAcoGet"></a> |
| 58 | +# **adAcoGet** |
| 59 | +> Response adAcoGet(advertiserId, adgroupIds, accessToken, excludeFieldTypesInResponse) |
| 60 | +
|
| 61 | +Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. [Ad Aco Get](https://ads.tiktok.com/marketing_api/docs?id=1739473020978177) |
| 62 | + |
| 63 | +### Example |
| 64 | +```java |
| 65 | +// Import classes: |
| 66 | +//import business_api.ApiException; |
| 67 | +//import io.swagger.client.api.AdAcoApi; |
| 68 | + |
| 69 | + |
| 70 | +AdAcoApi apiInstance = new AdAcoApi(); |
| 71 | +String advertiserId = "advertiserId_example"; // String | Advertiser ID. |
| 72 | +List<String> adgroupIds = Arrays.asList("adgroupIds_example"); // List<String> | A list of ad group IDs. Quantity- 1-100. |
| 73 | +String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |
| 74 | +List<String> excludeFieldTypesInResponse = Arrays.asList("excludeFieldTypesInResponse_example"); // List<String> | The type of fields that you want to remove from the response. |
| 75 | +try { |
| 76 | + Response result = apiInstance.adAcoGet(advertiserId, adgroupIds, accessToken, excludeFieldTypesInResponse); |
| 77 | + System.out.println(result); |
| 78 | +} catch (ApiException e) { |
| 79 | + System.err.println("Exception when calling AdAcoApi#adAcoGet"); |
| 80 | + e.printStackTrace(); |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +### Parameters |
| 85 | + |
| 86 | +Name | Type | Description | Notes |
| 87 | +------------- | ------------- | ------------- | ------------- |
| 88 | + **advertiserId** | **String**| Advertiser ID. |[required] |
| 89 | + **adgroupIds** | [**List<String>**](String.md)| A list of ad group IDs. Quantity- 1-100. |[required] |
| 90 | + **accessToken** | **String**| Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |[required] |
| 91 | + **excludeFieldTypesInResponse** | [**List<String>**](String.md)| The type of fields that you want to remove from the response. | [optional] |
| 92 | + |
| 93 | +### Return type |
| 94 | + |
| 95 | +[**Response**](Response.md) |
| 96 | + |
| 97 | +### Authorization |
| 98 | + |
| 99 | +No authorization required |
| 100 | + |
| 101 | +### HTTP request headers |
| 102 | + |
| 103 | + - **Content-Type**: Not defined |
| 104 | + - **Accept**: application/json |
| 105 | + |
| 106 | +<a name="adAcoMaterialStatusUpdate"></a> |
| 107 | +# **adAcoMaterialStatusUpdate** |
| 108 | +> Response adAcoMaterialStatusUpdate(accessToken, body) |
| 109 | +
|
| 110 | +Update the status of creative materials for an ACO ad, including ad texts, images, and video materials [Update materials](https://ads.tiktok.com/marketing_api/docs?id=1739506701165570) |
| 111 | + |
| 112 | +### Example |
| 113 | +```java |
| 114 | +// Import classes: |
| 115 | +//import business_api.ApiException; |
| 116 | +//import io.swagger.client.api.AdAcoApi; |
| 117 | + |
| 118 | + |
| 119 | +AdAcoApi apiInstance = new AdAcoApi(); |
| 120 | +String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |
| 121 | +MaterialStatusUpdateBody body = new MaterialStatusUpdateBody(); // MaterialStatusUpdateBody | Ad Aco material status body |
| 122 | +try { |
| 123 | + Response result = apiInstance.adAcoMaterialStatusUpdate(accessToken, body); |
| 124 | + System.out.println(result); |
| 125 | +} catch (ApiException e) { |
| 126 | + System.err.println("Exception when calling AdAcoApi#adAcoMaterialStatusUpdate"); |
| 127 | + e.printStackTrace(); |
| 128 | +} |
| 129 | +``` |
| 130 | + |
| 131 | +### Parameters |
| 132 | + |
| 133 | +Name | Type | Description | Notes |
| 134 | +------------- | ------------- | ------------- | ------------- |
| 135 | + **accessToken** | **String**| Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |[required] |
| 136 | + **body** | [**MaterialStatusUpdateBody**](MaterialStatusUpdateBody.md)| Ad Aco material status body | [optional] |
| 137 | + |
| 138 | +### Return type |
| 139 | + |
| 140 | +[**Response**](Response.md) |
| 141 | + |
| 142 | +### Authorization |
| 143 | + |
| 144 | +No authorization required |
| 145 | + |
| 146 | +### HTTP request headers |
| 147 | + |
| 148 | + - **Content-Type**: application/json |
| 149 | + - **Accept**: application/json |
| 150 | + |
| 151 | +<a name="adAcoUpdate"></a> |
| 152 | +# **adAcoUpdate** |
| 153 | +> Response adAcoUpdate(accessToken, body) |
| 154 | +
|
| 155 | +Modify ACO ad creatives. [Update ACO](https://ads.tiktok.com/marketing_api/docs?id=1739473077112833) |
| 156 | + |
| 157 | +### Example |
| 158 | +```java |
| 159 | +// Import classes: |
| 160 | +//import business_api.ApiException; |
| 161 | +//import io.swagger.client.api.AdAcoApi; |
| 162 | + |
| 163 | + |
| 164 | +AdAcoApi apiInstance = new AdAcoApi(); |
| 165 | +String accessToken = "accessToken_example"; // String | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |
| 166 | +AdAcoUpdateBody body = new AdAcoUpdateBody(); // AdAcoUpdateBody | Ad Aco update parameters |
| 167 | +try { |
| 168 | + Response result = apiInstance.adAcoUpdate(accessToken, body); |
| 169 | + System.out.println(result); |
| 170 | +} catch (ApiException e) { |
| 171 | + System.err.println("Exception when calling AdAcoApi#adAcoUpdate"); |
| 172 | + e.printStackTrace(); |
| 173 | +} |
| 174 | +``` |
| 175 | + |
| 176 | +### Parameters |
| 177 | + |
| 178 | +Name | Type | Description | Notes |
| 179 | +------------- | ------------- | ------------- | ------------- |
| 180 | + **accessToken** | **String**| Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). |[required] |
| 181 | + **body** | [**AdAcoUpdateBody**](AdAcoUpdateBody.md)| Ad Aco update parameters | [optional] |
| 182 | + |
| 183 | +### Return type |
| 184 | + |
| 185 | +[**Response**](Response.md) |
| 186 | + |
| 187 | +### Authorization |
| 188 | + |
| 189 | +No authorization required |
| 190 | + |
| 191 | +### HTTP request headers |
| 192 | + |
| 193 | + - **Content-Type**: application/json |
| 194 | + - **Accept**: application/json |
| 195 | + |
0 commit comments