Skip to content

Commit da9e709

Browse files
author
scrapebadger-bot
committed
chore: regenerate SDK from OpenAPI spec
1 parent 7c50efe commit da9e709

6 files changed

Lines changed: 727 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,7 @@ Class | Method | HTTP request | Description
469469
*TikTokApi* | [**TiktokGetOembedMetadata**](docs/TikTokApi.md#tiktokgetoembedmetadata) | **GET** /v1/tiktok/oembed | Get oEmbed metadata
470470
*TikTokApi* | [**TiktokGetRelatedVideos**](docs/TikTokApi.md#tiktokgetrelatedvideos) | **GET** /v1/tiktok/videos/{video_id}/related | Get related videos
471471
*TikTokApi* | [**TiktokGetReposts**](docs/TikTokApi.md#tiktokgetreposts) | **GET** /v1/tiktok/users/{username}/reposts | Get reposts
472+
*TikTokApi* | [**TiktokGetTiktokAdDetail**](docs/TikTokApi.md#tiktokgettiktokaddetail) | **GET** /v1/tiktok/ads/{ad_id} | Get TikTok ad detail
472473
*TikTokApi* | [**TiktokGetTranscript**](docs/TikTokApi.md#tiktokgettranscript) | **GET** /v1/tiktok/videos/{video_id}/transcript | Get transcript
473474
*TikTokApi* | [**TiktokGetUserProfile**](docs/TikTokApi.md#tiktokgetuserprofile) | **GET** /v1/tiktok/users/{username} | Get user profile
474475
*TikTokApi* | [**TiktokGetUserVideos**](docs/TikTokApi.md#tiktokgetuservideos) | **GET** /v1/tiktok/users/{username}/videos | Get user videos
@@ -478,6 +479,7 @@ Class | Method | HTTP request | Description
478479
*TikTokApi* | [**TiktokListRegions**](docs/TikTokApi.md#tiktoklistregions) | **GET** /v1/tiktok/regions | List regions
479480
*TikTokApi* | [**TiktokSearchHashtags**](docs/TikTokApi.md#tiktoksearchhashtags) | **GET** /v1/tiktok/search/hashtags | Search hashtags
480481
*TikTokApi* | [**TiktokSearchTheTiktokAdLibrary**](docs/TikTokApi.md#tiktoksearchthetiktokadlibrary) | **GET** /v1/tiktok/ads/search | Search the TikTok Ad Library
482+
*TikTokApi* | [**TiktokSearchTiktokAdvertisers**](docs/TikTokApi.md#tiktoksearchtiktokadvertisers) | **GET** /v1/tiktok/ads/advertisers | Search TikTok advertisers
481483
*TikTokApi* | [**TiktokSearchUsers**](docs/TikTokApi.md#tiktoksearchusers) | **GET** /v1/tiktok/search/users | Search users
482484
*TikTokApi* | [**TiktokSearchVideos**](docs/TikTokApi.md#tiktoksearchvideos) | **GET** /v1/tiktok/search/videos | Search videos
483485
*TikTokApi* | [**TiktokTrendingHashtags**](docs/TikTokApi.md#tiktoktrendinghashtags) | **GET** /v1/tiktok/trending/hashtags | Trending hashtags

‎ScrapeBadger.sln‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
22
# Visual Studio 14
33
VisualStudioVersion = 14.0.25420.1
44
MinimumVisualStudioVersion = 10.0.40219.1
5-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScrapeBadger", "src\ScrapeBadger\ScrapeBadger.csproj", "{083014A1-F50F-451B-9D95-C95C4CB9A877}"
5+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScrapeBadger", "src\ScrapeBadger\ScrapeBadger.csproj", "{5871ABE8-7234-4061-A5B7-708AEF90F6A1}"
66
EndProject
77
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScrapeBadger.Test", "src\ScrapeBadger.Test\ScrapeBadger.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
88
EndProject
@@ -12,10 +12,10 @@ Global
1212
Release|Any CPU = Release|Any CPU
1313
EndGlobalSection
1414
GlobalSection(ProjectConfigurationPlatforms) = postSolution
15-
{083014A1-F50F-451B-9D95-C95C4CB9A877}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16-
{083014A1-F50F-451B-9D95-C95C4CB9A877}.Debug|Any CPU.Build.0 = Debug|Any CPU
17-
{083014A1-F50F-451B-9D95-C95C4CB9A877}.Release|Any CPU.ActiveCfg = Release|Any CPU
18-
{083014A1-F50F-451B-9D95-C95C4CB9A877}.Release|Any CPU.Build.0 = Release|Any CPU
15+
{5871ABE8-7234-4061-A5B7-708AEF90F6A1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16+
{5871ABE8-7234-4061-A5B7-708AEF90F6A1}.Debug|Any CPU.Build.0 = Debug|Any CPU
17+
{5871ABE8-7234-4061-A5B7-708AEF90F6A1}.Release|Any CPU.ActiveCfg = Release|Any CPU
18+
{5871ABE8-7234-4061-A5B7-708AEF90F6A1}.Release|Any CPU.Build.0 = Release|Any CPU
1919
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
2020
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
2121
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

‎api/openapi.yaml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13308,6 +13308,61 @@ paths:
1330813308
summary: Search properties
1330913309
tags:
1331013310
- Redfin
13311+
/v1/tiktok/ads/advertisers:
13312+
get:
13313+
description: Look up TikTok advertiser business ids by name (feeds ads/search?advertiser_id=).
13314+
operationId: tiktok_search_tiktok_advertisers
13315+
parameters:
13316+
- description: Advertiser name (or partial) to look up
13317+
explode: true
13318+
in: query
13319+
name: query
13320+
required: true
13321+
schema:
13322+
description: Advertiser name (or partial) to look up
13323+
minLength: 1
13324+
title: Query
13325+
type: string
13326+
style: form
13327+
- description: EU region code (the Ad Library is EU-only)
13328+
explode: true
13329+
in: query
13330+
name: region
13331+
required: false
13332+
schema:
13333+
default: DE
13334+
description: EU region code (the Ad Library is EU-only)
13335+
title: Region
13336+
type: string
13337+
style: form
13338+
- explode: true
13339+
in: query
13340+
name: count
13341+
required: false
13342+
schema:
13343+
default: 10
13344+
maximum: 50
13345+
minimum: 1
13346+
title: Count
13347+
type: integer
13348+
style: form
13349+
responses:
13350+
"200":
13351+
content:
13352+
application/json:
13353+
schema: {}
13354+
description: Successful Response
13355+
"422":
13356+
content:
13357+
application/json:
13358+
schema:
13359+
$ref: '#/components/schemas/HTTPValidationError'
13360+
description: Validation Error
13361+
security:
13362+
- ApiKeyAuth: []
13363+
summary: Search TikTok advertisers
13364+
tags:
13365+
- TikTok
1331113366
/v1/tiktok/ads/search:
1331213367
get:
1331313368
description: Search TikTok's Commercial Content Library (ad transparency) by
@@ -13414,6 +13469,48 @@ paths:
1341413469
summary: Search the TikTok Ad Library
1341513470
tags:
1341613471
- TikTok
13472+
/v1/tiktok/ads/{ad_id}:
13473+
get:
13474+
description: "Get a single ad's advertiser, creatives, and targeting/impression\
13475+
\ breakdown."
13476+
operationId: tiktok_get_tiktok_ad_detail
13477+
parameters:
13478+
- explode: false
13479+
in: path
13480+
name: ad_id
13481+
required: true
13482+
schema:
13483+
title: Ad Id
13484+
type: string
13485+
style: simple
13486+
- description: EU region code (the Ad Library is EU-only)
13487+
explode: true
13488+
in: query
13489+
name: region
13490+
required: false
13491+
schema:
13492+
default: DE
13493+
description: EU region code (the Ad Library is EU-only)
13494+
title: Region
13495+
type: string
13496+
style: form
13497+
responses:
13498+
"200":
13499+
content:
13500+
application/json:
13501+
schema: {}
13502+
description: Successful Response
13503+
"422":
13504+
content:
13505+
application/json:
13506+
schema:
13507+
$ref: '#/components/schemas/HTTPValidationError'
13508+
description: Validation Error
13509+
security:
13510+
- ApiKeyAuth: []
13511+
summary: Get TikTok ad detail
13512+
tags:
13513+
- TikTok
1341713514
/v1/tiktok/comments/{comment_id}/replies:
1341813515
get:
1341913516
description: Get replies to a TikTok comment (best-effort).

‎docs/TikTokApi.md‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ All URIs are relative to *https://scrapebadger.com*
1717
| [**TiktokGetOembedMetadata**](TikTokApi.md#tiktokgetoembedmetadata) | **GET** /v1/tiktok/oembed | Get oEmbed metadata |
1818
| [**TiktokGetRelatedVideos**](TikTokApi.md#tiktokgetrelatedvideos) | **GET** /v1/tiktok/videos/{video_id}/related | Get related videos |
1919
| [**TiktokGetReposts**](TikTokApi.md#tiktokgetreposts) | **GET** /v1/tiktok/users/{username}/reposts | Get reposts |
20+
| [**TiktokGetTiktokAdDetail**](TikTokApi.md#tiktokgettiktokaddetail) | **GET** /v1/tiktok/ads/{ad_id} | Get TikTok ad detail |
2021
| [**TiktokGetTranscript**](TikTokApi.md#tiktokgettranscript) | **GET** /v1/tiktok/videos/{video_id}/transcript | Get transcript |
2122
| [**TiktokGetUserProfile**](TikTokApi.md#tiktokgetuserprofile) | **GET** /v1/tiktok/users/{username} | Get user profile |
2223
| [**TiktokGetUserVideos**](TikTokApi.md#tiktokgetuservideos) | **GET** /v1/tiktok/users/{username}/videos | Get user videos |
@@ -26,6 +27,7 @@ All URIs are relative to *https://scrapebadger.com*
2627
| [**TiktokListRegions**](TikTokApi.md#tiktoklistregions) | **GET** /v1/tiktok/regions | List regions |
2728
| [**TiktokSearchHashtags**](TikTokApi.md#tiktoksearchhashtags) | **GET** /v1/tiktok/search/hashtags | Search hashtags |
2829
| [**TiktokSearchTheTiktokAdLibrary**](TikTokApi.md#tiktoksearchthetiktokadlibrary) | **GET** /v1/tiktok/ads/search | Search the TikTok Ad Library |
30+
| [**TiktokSearchTiktokAdvertisers**](TikTokApi.md#tiktoksearchtiktokadvertisers) | **GET** /v1/tiktok/ads/advertisers | Search TikTok advertisers |
2931
| [**TiktokSearchUsers**](TikTokApi.md#tiktoksearchusers) | **GET** /v1/tiktok/search/users | Search users |
3032
| [**TiktokSearchVideos**](TikTokApi.md#tiktoksearchvideos) | **GET** /v1/tiktok/search/videos | Search videos |
3133
| [**TiktokTrendingHashtags**](TikTokApi.md#tiktoktrendinghashtags) | **GET** /v1/tiktok/trending/hashtags | Trending hashtags |
@@ -1395,6 +1397,109 @@ catch (ApiException e)
13951397
- **Accept**: application/json
13961398

13971399

1400+
### HTTP response details
1401+
| Status code | Description | Response headers |
1402+
|-------------|-------------|------------------|
1403+
| **200** | Successful Response | - |
1404+
| **422** | Validation Error | - |
1405+
1406+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1407+
1408+
<a id="tiktokgettiktokaddetail"></a>
1409+
# **TiktokGetTiktokAdDetail**
1410+
> Object TiktokGetTiktokAdDetail (string adId, string region = null)
1411+
1412+
Get TikTok ad detail
1413+
1414+
Get a single ad's advertiser, creatives, and targeting/impression breakdown.
1415+
1416+
### Example
1417+
```csharp
1418+
using System.Collections.Generic;
1419+
using System.Diagnostics;
1420+
using System.Net.Http;
1421+
using ScrapeBadger.Api;
1422+
using ScrapeBadger.Client;
1423+
using ScrapeBadger.Model;
1424+
1425+
namespace Example
1426+
{
1427+
public class TiktokGetTiktokAdDetailExample
1428+
{
1429+
public static void Main()
1430+
{
1431+
Configuration config = new Configuration();
1432+
config.BasePath = "https://scrapebadger.com";
1433+
// Configure API key authorization: ApiKeyAuth
1434+
config.AddApiKey("X-API-Key", "YOUR_API_KEY");
1435+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1436+
// config.AddApiKeyPrefix("X-API-Key", "Bearer");
1437+
1438+
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
1439+
HttpClient httpClient = new HttpClient();
1440+
HttpClientHandler httpClientHandler = new HttpClientHandler();
1441+
var apiInstance = new TikTokApi(httpClient, config, httpClientHandler);
1442+
var adId = "adId_example"; // string |
1443+
var region = "\"DE\""; // string | EU region code (the Ad Library is EU-only) (optional) (default to "DE")
1444+
1445+
try
1446+
{
1447+
// Get TikTok ad detail
1448+
Object result = apiInstance.TiktokGetTiktokAdDetail(adId, region);
1449+
Debug.WriteLine(result);
1450+
}
1451+
catch (ApiException e)
1452+
{
1453+
Debug.Print("Exception when calling TikTokApi.TiktokGetTiktokAdDetail: " + e.Message);
1454+
Debug.Print("Status Code: " + e.ErrorCode);
1455+
Debug.Print(e.StackTrace);
1456+
}
1457+
}
1458+
}
1459+
}
1460+
```
1461+
1462+
#### Using the TiktokGetTiktokAdDetailWithHttpInfo variant
1463+
This returns an ApiResponse object which contains the response data, status code and headers.
1464+
1465+
```csharp
1466+
try
1467+
{
1468+
// Get TikTok ad detail
1469+
ApiResponse<Object> response = apiInstance.TiktokGetTiktokAdDetailWithHttpInfo(adId, region);
1470+
Debug.Write("Status Code: " + response.StatusCode);
1471+
Debug.Write("Response Headers: " + response.Headers);
1472+
Debug.Write("Response Body: " + response.Data);
1473+
}
1474+
catch (ApiException e)
1475+
{
1476+
Debug.Print("Exception when calling TikTokApi.TiktokGetTiktokAdDetailWithHttpInfo: " + e.Message);
1477+
Debug.Print("Status Code: " + e.ErrorCode);
1478+
Debug.Print(e.StackTrace);
1479+
}
1480+
```
1481+
1482+
### Parameters
1483+
1484+
| Name | Type | Description | Notes |
1485+
|------|------|-------------|-------|
1486+
| **adId** | **string** | | |
1487+
| **region** | **string** | EU region code (the Ad Library is EU-only) | [optional] [default to &quot;DE&quot;] |
1488+
1489+
### Return type
1490+
1491+
**Object**
1492+
1493+
### Authorization
1494+
1495+
[ApiKeyAuth](../README.md#ApiKeyAuth)
1496+
1497+
### HTTP request headers
1498+
1499+
- **Content-Type**: Not defined
1500+
- **Accept**: application/json
1501+
1502+
13981503
### HTTP response details
13991504
| Status code | Description | Response headers |
14001505
|-------------|-------------|------------------|
@@ -2320,6 +2425,111 @@ catch (ApiException e)
23202425
- **Accept**: application/json
23212426

23222427

2428+
### HTTP response details
2429+
| Status code | Description | Response headers |
2430+
|-------------|-------------|------------------|
2431+
| **200** | Successful Response | - |
2432+
| **422** | Validation Error | - |
2433+
2434+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2435+
2436+
<a id="tiktoksearchtiktokadvertisers"></a>
2437+
# **TiktokSearchTiktokAdvertisers**
2438+
> Object TiktokSearchTiktokAdvertisers (string query, string region = null, int? count = null)
2439+
2440+
Search TikTok advertisers
2441+
2442+
Look up TikTok advertiser business ids by name (feeds ads/search?advertiser_id=).
2443+
2444+
### Example
2445+
```csharp
2446+
using System.Collections.Generic;
2447+
using System.Diagnostics;
2448+
using System.Net.Http;
2449+
using ScrapeBadger.Api;
2450+
using ScrapeBadger.Client;
2451+
using ScrapeBadger.Model;
2452+
2453+
namespace Example
2454+
{
2455+
public class TiktokSearchTiktokAdvertisersExample
2456+
{
2457+
public static void Main()
2458+
{
2459+
Configuration config = new Configuration();
2460+
config.BasePath = "https://scrapebadger.com";
2461+
// Configure API key authorization: ApiKeyAuth
2462+
config.AddApiKey("X-API-Key", "YOUR_API_KEY");
2463+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
2464+
// config.AddApiKeyPrefix("X-API-Key", "Bearer");
2465+
2466+
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
2467+
HttpClient httpClient = new HttpClient();
2468+
HttpClientHandler httpClientHandler = new HttpClientHandler();
2469+
var apiInstance = new TikTokApi(httpClient, config, httpClientHandler);
2470+
var query = "query_example"; // string | Advertiser name (or partial) to look up
2471+
var region = "\"DE\""; // string | EU region code (the Ad Library is EU-only) (optional) (default to "DE")
2472+
var count = 10; // int? | (optional) (default to 10)
2473+
2474+
try
2475+
{
2476+
// Search TikTok advertisers
2477+
Object result = apiInstance.TiktokSearchTiktokAdvertisers(query, region, count);
2478+
Debug.WriteLine(result);
2479+
}
2480+
catch (ApiException e)
2481+
{
2482+
Debug.Print("Exception when calling TikTokApi.TiktokSearchTiktokAdvertisers: " + e.Message);
2483+
Debug.Print("Status Code: " + e.ErrorCode);
2484+
Debug.Print(e.StackTrace);
2485+
}
2486+
}
2487+
}
2488+
}
2489+
```
2490+
2491+
#### Using the TiktokSearchTiktokAdvertisersWithHttpInfo variant
2492+
This returns an ApiResponse object which contains the response data, status code and headers.
2493+
2494+
```csharp
2495+
try
2496+
{
2497+
// Search TikTok advertisers
2498+
ApiResponse<Object> response = apiInstance.TiktokSearchTiktokAdvertisersWithHttpInfo(query, region, count);
2499+
Debug.Write("Status Code: " + response.StatusCode);
2500+
Debug.Write("Response Headers: " + response.Headers);
2501+
Debug.Write("Response Body: " + response.Data);
2502+
}
2503+
catch (ApiException e)
2504+
{
2505+
Debug.Print("Exception when calling TikTokApi.TiktokSearchTiktokAdvertisersWithHttpInfo: " + e.Message);
2506+
Debug.Print("Status Code: " + e.ErrorCode);
2507+
Debug.Print(e.StackTrace);
2508+
}
2509+
```
2510+
2511+
### Parameters
2512+
2513+
| Name | Type | Description | Notes |
2514+
|------|------|-------------|-------|
2515+
| **query** | **string** | Advertiser name (or partial) to look up | |
2516+
| **region** | **string** | EU region code (the Ad Library is EU-only) | [optional] [default to &quot;DE&quot;] |
2517+
| **count** | **int?** | | [optional] [default to 10] |
2518+
2519+
### Return type
2520+
2521+
**Object**
2522+
2523+
### Authorization
2524+
2525+
[ApiKeyAuth](../README.md#ApiKeyAuth)
2526+
2527+
### HTTP request headers
2528+
2529+
- **Content-Type**: Not defined
2530+
- **Accept**: application/json
2531+
2532+
23232533
### HTTP response details
23242534
| Status code | Description | Response headers |
23252535
|-------------|-------------|------------------|

0 commit comments

Comments
 (0)