late-sdk 0.0.97 → 0.0.99
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +53 -0
- data/docs/Ad.md +58 -0
- data/docs/AdAudiencesApi.md +365 -0
- data/docs/AdBudget.md +20 -0
- data/docs/AdCampaign.md +40 -0
- data/docs/AdCampaignsApi.md +165 -0
- data/docs/AdMetrics.md +34 -0
- data/docs/AdSchedule.md +20 -0
- data/docs/AddUsersToAdAudience200Response.md +22 -0
- data/docs/AddUsersToAdAudienceRequest.md +18 -0
- data/docs/AddUsersToAdAudienceRequestUsersInner.md +20 -0
- data/docs/AdsApi.md +726 -0
- data/docs/BoostPostRequest.md +36 -0
- data/docs/BoostPostRequestBudget.md +20 -0
- data/docs/BoostPostRequestSchedule.md +20 -0
- data/docs/BoostPostRequestTargeting.md +24 -0
- data/docs/CreateAdAudience201Response.md +20 -0
- data/docs/CreateAdAudienceRequest.md +36 -0
- data/docs/CreateStandaloneAdRequest.md +56 -0
- data/docs/GetAd200Response.md +18 -0
- data/docs/GetAdAnalytics200Response.md +20 -0
- data/docs/GetAdAnalytics200ResponseAd.md +24 -0
- data/docs/GetAdAnalytics200ResponseAnalytics.md +22 -0
- data/docs/GetAdAnalytics200ResponseAnalyticsDailyInner.md +36 -0
- data/docs/GetAdAudience200Response.md +20 -0
- data/docs/ListAdAccounts200Response.md +18 -0
- data/docs/ListAdAccounts200ResponseAccountsInner.md +24 -0
- data/docs/ListAdAudiences200Response.md +18 -0
- data/docs/ListAdAudiences200ResponseAudiencesInner.md +32 -0
- data/docs/ListAdCampaigns200Response.md +20 -0
- data/docs/ListAds200Response.md +20 -0
- data/docs/SearchAdInterests200Response.md +18 -0
- data/docs/SearchAdInterests200ResponseInterestsInner.md +22 -0
- data/docs/SyncExternalAds200Response.md +24 -0
- data/docs/UpdateAd200Response.md +20 -0
- data/docs/UpdateAdCampaignStatus200Response.md +22 -0
- data/docs/UpdateAdCampaignStatusRequest.md +20 -0
- data/docs/UpdateAdRequest.md +24 -0
- data/docs/UpdateAdRequestBudget.md +20 -0
- data/docs/UpdateAdRequestTargeting.md +24 -0
- data/docs/UpdatePostMetadataRequest.md +7 -1
- data/lib/late-sdk/api/ad_audiences_api.rb +368 -0
- data/lib/late-sdk/api/ad_campaigns_api.rb +201 -0
- data/lib/late-sdk/api/ads_api.rb +719 -0
- data/lib/late-sdk/models/ad.rb +399 -0
- data/lib/late-sdk/models/ad_budget.rb +190 -0
- data/lib/late-sdk/models/ad_campaign.rb +293 -0
- data/lib/late-sdk/models/ad_metrics.rb +222 -0
- data/lib/late-sdk/models/ad_schedule.rb +156 -0
- data/lib/late-sdk/models/add_users_to_ad_audience200_response.rb +165 -0
- data/lib/late-sdk/models/add_users_to_ad_audience_request.rb +175 -0
- data/lib/late-sdk/models/add_users_to_ad_audience_request_users_inner.rb +157 -0
- data/lib/late-sdk/models/boost_post_request.rb +350 -0
- data/lib/late-sdk/models/boost_post_request_budget.rb +215 -0
- data/lib/late-sdk/models/boost_post_request_schedule.rb +157 -0
- data/lib/late-sdk/models/boost_post_request_targeting.rb +234 -0
- data/lib/late-sdk/models/create_ad_audience201_response.rb +156 -0
- data/lib/late-sdk/models/create_ad_audience_request.rb +391 -0
- data/lib/late-sdk/models/create_standalone_ad_request.rb +585 -0
- data/lib/late-sdk/models/get_ad200_response.rb +147 -0
- data/lib/late-sdk/models/get_ad_analytics200_response.rb +156 -0
- data/lib/late-sdk/models/get_ad_analytics200_response_ad.rb +174 -0
- data/lib/late-sdk/models/get_ad_analytics200_response_analytics.rb +169 -0
- data/lib/late-sdk/models/get_ad_analytics200_response_analytics_daily_inner.rb +238 -0
- data/lib/late-sdk/models/get_ad_audience200_response.rb +157 -0
- data/lib/late-sdk/models/list_ad_accounts200_response.rb +149 -0
- data/lib/late-sdk/models/list_ad_accounts200_response_accounts_inner.rb +175 -0
- data/lib/late-sdk/models/list_ad_audiences200_response.rb +149 -0
- data/lib/late-sdk/models/list_ad_audiences200_response_audiences_inner.rb +244 -0
- data/lib/late-sdk/models/list_ad_campaigns200_response.rb +158 -0
- data/lib/late-sdk/models/list_ads200_response.rb +158 -0
- data/lib/late-sdk/models/search_ad_interests200_response.rb +149 -0
- data/lib/late-sdk/models/search_ad_interests200_response_interests_inner.rb +165 -0
- data/lib/late-sdk/models/sync_external_ads200_response.rb +177 -0
- data/lib/late-sdk/models/update_ad200_response.rb +156 -0
- data/lib/late-sdk/models/update_ad_campaign_status200_response.rb +169 -0
- data/lib/late-sdk/models/update_ad_campaign_status_request.rb +216 -0
- data/lib/late-sdk/models/update_ad_request.rb +208 -0
- data/lib/late-sdk/models/update_ad_request_budget.rb +191 -0
- data/lib/late-sdk/models/update_ad_request_targeting.rb +235 -0
- data/lib/late-sdk/models/update_post_metadata_request.rb +34 -4
- data/lib/late-sdk/version.rb +1 -1
- data/lib/late-sdk.rb +39 -0
- data/openapi.yaml +693 -0
- data/spec/api/ad_audiences_api_spec.rb +98 -0
- data/spec/api/ad_campaigns_api_spec.rb +67 -0
- data/spec/api/ads_api_spec.rb +163 -0
- data/spec/models/ad_budget_spec.rb +46 -0
- data/spec/models/ad_campaign_spec.rb +110 -0
- data/spec/models/ad_metrics_spec.rb +84 -0
- data/spec/models/ad_schedule_spec.rb +42 -0
- data/spec/models/ad_spec.rb +172 -0
- data/spec/models/add_users_to_ad_audience200_response_spec.rb +48 -0
- data/spec/models/add_users_to_ad_audience_request_spec.rb +36 -0
- data/spec/models/add_users_to_ad_audience_request_users_inner_spec.rb +42 -0
- data/spec/models/boost_post_request_budget_spec.rb +46 -0
- data/spec/models/boost_post_request_schedule_spec.rb +42 -0
- data/spec/models/boost_post_request_spec.rb +94 -0
- data/spec/models/boost_post_request_targeting_spec.rb +54 -0
- data/spec/models/create_ad_audience201_response_spec.rb +42 -0
- data/spec/models/create_ad_audience_request_spec.rb +94 -0
- data/spec/models/create_standalone_ad_request_spec.rb +166 -0
- data/spec/models/get_ad200_response_spec.rb +36 -0
- data/spec/models/get_ad_analytics200_response_ad_spec.rb +54 -0
- data/spec/models/get_ad_analytics200_response_analytics_daily_inner_spec.rb +90 -0
- data/spec/models/get_ad_analytics200_response_analytics_spec.rb +48 -0
- data/spec/models/get_ad_analytics200_response_spec.rb +42 -0
- data/spec/models/get_ad_audience200_response_spec.rb +42 -0
- data/spec/models/list_ad_accounts200_response_accounts_inner_spec.rb +54 -0
- data/spec/models/list_ad_accounts200_response_spec.rb +36 -0
- data/spec/models/list_ad_audiences200_response_audiences_inner_spec.rb +82 -0
- data/spec/models/list_ad_audiences200_response_spec.rb +36 -0
- data/spec/models/list_ad_campaigns200_response_spec.rb +42 -0
- data/spec/models/list_ads200_response_spec.rb +42 -0
- data/spec/models/search_ad_interests200_response_interests_inner_spec.rb +48 -0
- data/spec/models/search_ad_interests200_response_spec.rb +36 -0
- data/spec/models/sync_external_ads200_response_spec.rb +54 -0
- data/spec/models/update_ad200_response_spec.rb +42 -0
- data/spec/models/update_ad_campaign_status200_response_spec.rb +48 -0
- data/spec/models/update_ad_campaign_status_request_spec.rb +50 -0
- data/spec/models/update_ad_request_budget_spec.rb +46 -0
- data/spec/models/update_ad_request_spec.rb +58 -0
- data/spec/models/update_ad_request_targeting_spec.rb +54 -0
- data/spec/models/update_post_metadata_request_spec.rb +18 -0
- data/zernio-sdk-0.0.99.gem +0 -0
- metadata +159 -3
- data/zernio-sdk-0.0.97.gem +0 -0
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Late::BoostPostRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **post_id** | **String** | Zernio post ID (provide this or platformPostId) | [optional] |
|
|
8
|
+
| **platform_post_id** | **String** | Platform post ID (alternative to postId) | [optional] |
|
|
9
|
+
| **account_id** | **String** | Social account ID | |
|
|
10
|
+
| **ad_account_id** | **String** | Platform ad account ID | |
|
|
11
|
+
| **name** | **String** | | |
|
|
12
|
+
| **goal** | **String** | | |
|
|
13
|
+
| **budget** | [**BoostPostRequestBudget**](BoostPostRequestBudget.md) | | |
|
|
14
|
+
| **currency** | **String** | | [optional] |
|
|
15
|
+
| **schedule** | [**BoostPostRequestSchedule**](BoostPostRequestSchedule.md) | | [optional] |
|
|
16
|
+
| **targeting** | [**BoostPostRequestTargeting**](BoostPostRequestTargeting.md) | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'late-sdk'
|
|
22
|
+
|
|
23
|
+
instance = Late::BoostPostRequest.new(
|
|
24
|
+
post_id: null,
|
|
25
|
+
platform_post_id: null,
|
|
26
|
+
account_id: null,
|
|
27
|
+
ad_account_id: null,
|
|
28
|
+
name: null,
|
|
29
|
+
goal: null,
|
|
30
|
+
budget: null,
|
|
31
|
+
currency: USD,
|
|
32
|
+
schedule: null,
|
|
33
|
+
targeting: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::BoostPostRequestBudget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **amount** | **Float** | Minimum varies: TikTok=$20, Pinterest=$5, others=$1 | |
|
|
8
|
+
| **type** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::BoostPostRequestBudget.new(
|
|
16
|
+
amount: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::BoostPostRequestSchedule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **start_date** | **Time** | | [optional] |
|
|
8
|
+
| **end_date** | **Time** | Required for lifetime budgets | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::BoostPostRequestSchedule.new(
|
|
16
|
+
start_date: null,
|
|
17
|
+
end_date: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::BoostPostRequestTargeting
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **age_min** | **Integer** | | [optional] |
|
|
8
|
+
| **age_max** | **Integer** | | [optional] |
|
|
9
|
+
| **countries** | **Array<String>** | | [optional] |
|
|
10
|
+
| **interests** | **Array<String>** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::BoostPostRequestTargeting.new(
|
|
18
|
+
age_min: null,
|
|
19
|
+
age_max: null,
|
|
20
|
+
countries: null,
|
|
21
|
+
interests: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::CreateAdAudience201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audience** | **Object** | | [optional] |
|
|
8
|
+
| **message** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::CreateAdAudience201Response.new(
|
|
16
|
+
audience: null,
|
|
17
|
+
message: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Late::CreateAdAudienceRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | | |
|
|
8
|
+
| **ad_account_id** | **String** | Must start with act_ | |
|
|
9
|
+
| **name** | **String** | | |
|
|
10
|
+
| **description** | **String** | | [optional] |
|
|
11
|
+
| **type** | **String** | | |
|
|
12
|
+
| **pixel_id** | **String** | Required for website audiences | [optional] |
|
|
13
|
+
| **retention_days** | **Integer** | Required for website audiences | [optional] |
|
|
14
|
+
| **source_audience_id** | **String** | Required for lookalike audiences | [optional] |
|
|
15
|
+
| **country** | **String** | 2-letter code, required for lookalike audiences | [optional] |
|
|
16
|
+
| **ratio** | **Float** | Required for lookalike audiences | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'late-sdk'
|
|
22
|
+
|
|
23
|
+
instance = Late::CreateAdAudienceRequest.new(
|
|
24
|
+
account_id: null,
|
|
25
|
+
ad_account_id: null,
|
|
26
|
+
name: null,
|
|
27
|
+
description: null,
|
|
28
|
+
type: null,
|
|
29
|
+
pixel_id: null,
|
|
30
|
+
retention_days: null,
|
|
31
|
+
source_audience_id: null,
|
|
32
|
+
country: null,
|
|
33
|
+
ratio: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Late::CreateStandaloneAdRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | | |
|
|
8
|
+
| **ad_account_id** | **String** | | |
|
|
9
|
+
| **name** | **String** | | |
|
|
10
|
+
| **goal** | **String** | | |
|
|
11
|
+
| **budget_amount** | **Float** | | |
|
|
12
|
+
| **budget_type** | **String** | | |
|
|
13
|
+
| **currency** | **String** | | [optional] |
|
|
14
|
+
| **headline** | **String** | Required for most platforms. Max: Meta=255, Google=30, Pinterest=100 | [optional] |
|
|
15
|
+
| **body** | **String** | Max: Google=90, Pinterest=500 | |
|
|
16
|
+
| **call_to_action** | **String** | Meta only | [optional] |
|
|
17
|
+
| **link_url** | **String** | | [optional] |
|
|
18
|
+
| **image_url** | **String** | Image URL (or video URL for TikTok) | |
|
|
19
|
+
| **countries** | **Array<String>** | | [optional] |
|
|
20
|
+
| **age_min** | **Integer** | | [optional] |
|
|
21
|
+
| **age_max** | **Integer** | | [optional] |
|
|
22
|
+
| **interests** | **Array<String>** | | [optional] |
|
|
23
|
+
| **end_date** | **Time** | Required for lifetime budgets | [optional] |
|
|
24
|
+
| **audience_id** | **String** | Custom audience ID for targeting | [optional] |
|
|
25
|
+
| **campaign_type** | **String** | Google only | [optional][default to 'display'] |
|
|
26
|
+
| **keywords** | **Array<String>** | Google Search only | [optional] |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'late-sdk'
|
|
32
|
+
|
|
33
|
+
instance = Late::CreateStandaloneAdRequest.new(
|
|
34
|
+
account_id: null,
|
|
35
|
+
ad_account_id: null,
|
|
36
|
+
name: null,
|
|
37
|
+
goal: null,
|
|
38
|
+
budget_amount: null,
|
|
39
|
+
budget_type: null,
|
|
40
|
+
currency: null,
|
|
41
|
+
headline: null,
|
|
42
|
+
body: null,
|
|
43
|
+
call_to_action: null,
|
|
44
|
+
link_url: null,
|
|
45
|
+
image_url: null,
|
|
46
|
+
countries: null,
|
|
47
|
+
age_min: null,
|
|
48
|
+
age_max: null,
|
|
49
|
+
interests: null,
|
|
50
|
+
end_date: null,
|
|
51
|
+
audience_id: null,
|
|
52
|
+
campaign_type: null,
|
|
53
|
+
keywords: null
|
|
54
|
+
)
|
|
55
|
+
```
|
|
56
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::GetAd200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad** | [**Ad**](Ad.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::GetAd200Response.new(
|
|
15
|
+
ad: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetAdAnalytics200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad** | [**GetAdAnalytics200ResponseAd**](GetAdAnalytics200ResponseAd.md) | | [optional] |
|
|
8
|
+
| **analytics** | [**GetAdAnalytics200ResponseAnalytics**](GetAdAnalytics200ResponseAnalytics.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetAdAnalytics200Response.new(
|
|
16
|
+
ad: null,
|
|
17
|
+
analytics: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::GetAdAnalytics200ResponseAd
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **platform** | **String** | | [optional] |
|
|
10
|
+
| **status** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::GetAdAnalytics200ResponseAd.new(
|
|
18
|
+
id: null,
|
|
19
|
+
name: null,
|
|
20
|
+
platform: null,
|
|
21
|
+
status: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Late::GetAdAnalytics200ResponseAnalytics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **summary** | [**AdMetrics**](AdMetrics.md) | | [optional] |
|
|
8
|
+
| **daily** | [**Array<GetAdAnalytics200ResponseAnalyticsDailyInner>**](GetAdAnalytics200ResponseAnalyticsDailyInner.md) | | [optional] |
|
|
9
|
+
| **breakdowns** | **Hash<String, Array<Object>>** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'late-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Late::GetAdAnalytics200ResponseAnalytics.new(
|
|
17
|
+
summary: null,
|
|
18
|
+
daily: null,
|
|
19
|
+
breakdowns: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Late::GetAdAnalytics200ResponseAnalyticsDailyInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **spend** | **Float** | | [optional] |
|
|
8
|
+
| **impressions** | **Integer** | | [optional] |
|
|
9
|
+
| **reach** | **Integer** | | [optional] |
|
|
10
|
+
| **clicks** | **Integer** | | [optional] |
|
|
11
|
+
| **ctr** | **Float** | Click-through rate (%) | [optional] |
|
|
12
|
+
| **cpc** | **Float** | Cost per click | [optional] |
|
|
13
|
+
| **cpm** | **Float** | Cost per 1000 impressions | [optional] |
|
|
14
|
+
| **engagement** | **Integer** | | [optional] |
|
|
15
|
+
| **last_synced_at** | **Time** | | [optional] |
|
|
16
|
+
| **date** | **Date** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'late-sdk'
|
|
22
|
+
|
|
23
|
+
instance = Late::GetAdAnalytics200ResponseAnalyticsDailyInner.new(
|
|
24
|
+
spend: null,
|
|
25
|
+
impressions: null,
|
|
26
|
+
reach: null,
|
|
27
|
+
clicks: null,
|
|
28
|
+
ctr: null,
|
|
29
|
+
cpc: null,
|
|
30
|
+
cpm: null,
|
|
31
|
+
engagement: null,
|
|
32
|
+
last_synced_at: null,
|
|
33
|
+
date: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::GetAdAudience200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audience** | **Object** | | [optional] |
|
|
8
|
+
| **meta_data** | **Object** | Fresh data from Meta API | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::GetAdAudience200Response.new(
|
|
16
|
+
audience: null,
|
|
17
|
+
meta_data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::ListAdAccounts200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **accounts** | [**Array<ListAdAccounts200ResponseAccountsInner>**](ListAdAccounts200ResponseAccountsInner.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::ListAdAccounts200Response.new(
|
|
15
|
+
accounts: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::ListAdAccounts200ResponseAccountsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Platform ad account ID (e.g. act_123) | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **currency** | **String** | | [optional] |
|
|
10
|
+
| **status** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::ListAdAccounts200ResponseAccountsInner.new(
|
|
18
|
+
id: null,
|
|
19
|
+
name: null,
|
|
20
|
+
currency: null,
|
|
21
|
+
status: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::ListAdAudiences200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audiences** | [**Array<ListAdAudiences200ResponseAudiencesInner>**](ListAdAudiences200ResponseAudiencesInner.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::ListAdAudiences200Response.new(
|
|
15
|
+
audiences: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Late::ListAdAudiences200ResponseAudiencesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **platform_audience_id** | **String** | | [optional] |
|
|
9
|
+
| **name** | **String** | | [optional] |
|
|
10
|
+
| **description** | **String** | | [optional] |
|
|
11
|
+
| **type** | **String** | | [optional] |
|
|
12
|
+
| **platform** | **String** | | [optional] |
|
|
13
|
+
| **size** | **Integer** | | [optional] |
|
|
14
|
+
| **status** | **String** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'late-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Late::ListAdAudiences200ResponseAudiencesInner.new(
|
|
22
|
+
id: null,
|
|
23
|
+
platform_audience_id: null,
|
|
24
|
+
name: null,
|
|
25
|
+
description: null,
|
|
26
|
+
type: null,
|
|
27
|
+
platform: null,
|
|
28
|
+
size: null,
|
|
29
|
+
status: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::ListAdCampaigns200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **campaigns** | [**Array<AdCampaign>**](AdCampaign.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**Pagination**](Pagination.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::ListAdCampaigns200Response.new(
|
|
16
|
+
campaigns: null,
|
|
17
|
+
pagination: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::ListAds200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ads** | [**Array<Ad>**](Ad.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**Pagination**](Pagination.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::ListAds200Response.new(
|
|
16
|
+
ads: null,
|
|
17
|
+
pagination: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Late::SearchAdInterests200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **interests** | [**Array<SearchAdInterests200ResponseInterestsInner>**](SearchAdInterests200ResponseInterestsInner.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'late-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Late::SearchAdInterests200Response.new(
|
|
15
|
+
interests: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Late::SearchAdInterests200ResponseInterestsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **category** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'late-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Late::SearchAdInterests200ResponseInterestsInner.new(
|
|
17
|
+
id: null,
|
|
18
|
+
name: null,
|
|
19
|
+
category: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::SyncExternalAds200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **synced** | **Integer** | New ads imported | [optional] |
|
|
9
|
+
| **skipped** | **Integer** | Already-synced ads updated | [optional] |
|
|
10
|
+
| **errors** | **Integer** | Failed ad imports | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::SyncExternalAds200Response.new(
|
|
18
|
+
success: null,
|
|
19
|
+
synced: null,
|
|
20
|
+
skipped: null,
|
|
21
|
+
errors: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::UpdateAd200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad** | [**Ad**](Ad.md) | | [optional] |
|
|
8
|
+
| **message** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::UpdateAd200Response.new(
|
|
16
|
+
ad: null,
|
|
17
|
+
message: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Late::UpdateAdCampaignStatus200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **updated** | **Integer** | Number of ads updated | [optional] |
|
|
8
|
+
| **skipped** | **Integer** | Number of ads skipped | [optional] |
|
|
9
|
+
| **skipped_reasons** | **Array<String>** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'late-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Late::UpdateAdCampaignStatus200Response.new(
|
|
17
|
+
updated: null,
|
|
18
|
+
skipped: null,
|
|
19
|
+
skipped_reasons: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::UpdateAdCampaignStatusRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | |
|
|
8
|
+
| **platform** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::UpdateAdCampaignStatusRequest.new(
|
|
16
|
+
status: null,
|
|
17
|
+
platform: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Late::UpdateAdRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional] |
|
|
8
|
+
| **budget** | [**UpdateAdRequestBudget**](UpdateAdRequestBudget.md) | | [optional] |
|
|
9
|
+
| **targeting** | [**UpdateAdRequestTargeting**](UpdateAdRequestTargeting.md) | | [optional] |
|
|
10
|
+
| **name** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'late-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Late::UpdateAdRequest.new(
|
|
18
|
+
status: null,
|
|
19
|
+
budget: null,
|
|
20
|
+
targeting: null,
|
|
21
|
+
name: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Late::UpdateAdRequestBudget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **amount** | **Float** | Minimum varies by platform: TikTok=$20, Pinterest=$5, others=$1 | [optional] |
|
|
8
|
+
| **type** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'late-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Late::UpdateAdRequestBudget.new(
|
|
16
|
+
amount: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|