late-sdk 0.0.714 → 0.0.716
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 +15 -10
- data/docs/AdAnalyticsResponse.md +22 -0
- data/docs/{GetAdAnalytics200ResponseAd.md → AdAnalyticsResponseAd.md} +2 -4
- data/docs/AdCampaignsApi.md +12 -12
- data/docs/AdDailyMetrics.md +14 -0
- data/docs/AdEngagementCounts.md +1 -1
- data/docs/AdInsightsApi.md +8 -8
- data/docs/AdMetrics.md +14 -0
- data/docs/AdTreeResponse.md +22 -0
- data/docs/AdsListResponse.md +22 -0
- data/docs/AdsTimelineResponse.md +20 -0
- data/docs/{GetAdsTimeline200ResponseRowsInner.md → AdsTimelineResponseRowsInner.md} +2 -2
- data/docs/CampaignAnalyticsResponse.md +22 -0
- data/docs/{GetCampaignAnalytics200ResponseAnalytics.md → CampaignAnalyticsResponseAnalytics.md} +3 -3
- data/docs/{GetCampaignAnalytics200ResponseAnalyticsDailyInner.md → CampaignAnalyticsResponseAnalyticsDailyInner.md} +16 -2
- data/docs/{GetCampaignAnalytics200ResponseCampaign.md → CampaignAnalyticsResponseCampaign.md} +2 -2
- data/docs/GetAdAnalytics202Response.md +22 -0
- data/docs/GetAdTree202Response.md +22 -0
- data/docs/GetAdsTimeline202Response.md +20 -0
- data/docs/GetCampaignAnalytics202Response.md +22 -0
- data/docs/ListAds202Response.md +22 -0
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +9 -9
- data/lib/zernio-sdk/api/ad_insights_api.rb +6 -6
- data/lib/zernio-sdk/models/{get_ad_analytics200_response.rb → ad_analytics_response.rb} +15 -15
- data/lib/zernio-sdk/models/{get_ad_analytics200_response_ad.rb → ad_analytics_response_ad.rb} +4 -47
- data/lib/zernio-sdk/models/ad_daily_metrics.rb +73 -1
- data/lib/zernio-sdk/models/ad_engagement_counts.rb +1 -1
- data/lib/zernio-sdk/models/ad_metrics.rb +73 -1
- data/lib/zernio-sdk/models/{get_ad_tree200_response.rb → ad_tree_response.rb} +17 -17
- data/lib/zernio-sdk/models/{list_ads200_response.rb → ads_list_response.rb} +17 -17
- data/lib/zernio-sdk/models/{get_ads_timeline200_response.rb → ads_timeline_response.rb} +17 -17
- data/lib/zernio-sdk/models/{get_ads_timeline200_response_rows_inner.rb → ads_timeline_response_rows_inner.rb} +3 -3
- data/lib/zernio-sdk/models/{get_campaign_analytics200_response.rb → campaign_analytics_response.rb} +15 -15
- data/lib/zernio-sdk/models/{get_campaign_analytics200_response_analytics.rb → campaign_analytics_response_analytics.rb} +4 -4
- data/lib/zernio-sdk/models/{get_campaign_analytics200_response_analytics_daily_inner.rb → campaign_analytics_response_analytics_daily_inner.rb} +76 -4
- data/lib/zernio-sdk/models/{get_campaign_analytics200_response_campaign.rb → campaign_analytics_response_campaign.rb} +3 -3
- data/lib/zernio-sdk/models/get_ad_analytics202_response.rb +213 -0
- data/lib/zernio-sdk/models/get_ad_tree202_response.rb +215 -0
- data/lib/zernio-sdk/models/get_ads_timeline202_response.rb +206 -0
- data/lib/zernio-sdk/models/get_campaign_analytics202_response.rb +213 -0
- data/lib/zernio-sdk/models/list_ads202_response.rb +215 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +15 -10
- data/openapi.yaml +205 -123
- data/spec/api/ad_campaigns_api_spec.rb +3 -3
- data/spec/api/ad_insights_api_spec.rb +2 -2
- data/spec/models/{get_campaign_analytics200_response_campaign_spec.rb → ad_analytics_response_ad_spec.rb} +6 -6
- data/spec/models/{get_ad_analytics200_response_spec.rb → ad_analytics_response_spec.rb} +8 -8
- data/spec/models/ad_daily_metrics_spec.rb +42 -0
- data/spec/models/ad_metrics_spec.rb +42 -0
- data/spec/models/{get_ad_tree200_response_spec.rb → ad_tree_response_spec.rb} +8 -8
- data/spec/models/{list_ads200_response_spec.rb → ads_list_response_spec.rb} +8 -8
- data/spec/models/{get_ads_timeline200_response_rows_inner_spec.rb → ads_timeline_response_rows_inner_spec.rb} +6 -6
- data/spec/models/{get_ads_timeline200_response_spec.rb → ads_timeline_response_spec.rb} +8 -8
- data/spec/models/{get_campaign_analytics200_response_analytics_daily_inner_spec.rb → campaign_analytics_response_analytics_daily_inner_spec.rb} +48 -6
- data/spec/models/{get_campaign_analytics200_response_analytics_spec.rb → campaign_analytics_response_analytics_spec.rb} +6 -6
- data/spec/models/{get_ad_analytics200_response_ad_spec.rb → campaign_analytics_response_campaign_spec.rb} +6 -16
- data/spec/models/{get_campaign_analytics200_response_spec.rb → campaign_analytics_response_spec.rb} +8 -8
- data/spec/models/get_ad_analytics202_response_spec.rb +52 -0
- data/spec/models/get_ad_tree202_response_spec.rb +52 -0
- data/spec/models/get_ads_timeline202_response_spec.rb +46 -0
- data/spec/models/get_campaign_analytics202_response_spec.rb +52 -0
- data/spec/models/list_ads202_response_spec.rb +52 -0
- data/zernio-sdk-0.0.716.gem +0 -0
- metadata +1654 -1634
- data/docs/GetAdAnalytics200Response.md +0 -22
- data/docs/GetAdTree200Response.md +0 -22
- data/docs/GetAdsTimeline200Response.md +0 -20
- data/docs/GetCampaignAnalytics200Response.md +0 -22
- data/docs/ListAds200Response.md +0 -22
- data/zernio-sdk-0.0.714.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0cdc5f2a2d89c8debf2ee794839e324647bc218e1778cc018a91230f6519b174
|
|
4
|
+
data.tar.gz: 90a70d2db5e2b7110afa21f731fdba1577467139528cc59bba67207081e1be7b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d14a40c90e55f82b1408a5c4e639aafe0b5c0fc832191b5a93e6a26a525914f937bc7b8c8b087a108a13a0434208317fed1983458337de7d7bde083a71c5c450
|
|
7
|
+
data.tar.gz: 52c82c1962f085fcc38e72ed6b81bdf5d5ce22c0150f37add9df742affb3c9d131ab7c3dfed6d6bde8b0fe465272487bc9942c41eee0e1577d9250d0385416e5
|
data/README.md
CHANGED
|
@@ -631,6 +631,8 @@ Class | Method | HTTP request | Description
|
|
|
631
631
|
- [Zernio::ActivateWorkflow200Response](docs/ActivateWorkflow200Response.md)
|
|
632
632
|
- [Zernio::ActivateWorkflow200ResponseWorkflow](docs/ActivateWorkflow200ResponseWorkflow.md)
|
|
633
633
|
- [Zernio::Ad](docs/Ad.md)
|
|
634
|
+
- [Zernio::AdAnalyticsResponse](docs/AdAnalyticsResponse.md)
|
|
635
|
+
- [Zernio::AdAnalyticsResponseAd](docs/AdAnalyticsResponseAd.md)
|
|
634
636
|
- [Zernio::AdBudget](docs/AdBudget.md)
|
|
635
637
|
- [Zernio::AdCampaign](docs/AdCampaign.md)
|
|
636
638
|
- [Zernio::AdCampaignBudget](docs/AdCampaignBudget.md)
|
|
@@ -652,6 +654,7 @@ Class | Method | HTTP request | Description
|
|
|
652
654
|
- [Zernio::AdTreeCampaignBudget](docs/AdTreeCampaignBudget.md)
|
|
653
655
|
- [Zernio::AdTreeCampaignCampaignBudget](docs/AdTreeCampaignCampaignBudget.md)
|
|
654
656
|
- [Zernio::AdTreeCampaignPromotedObject](docs/AdTreeCampaignPromotedObject.md)
|
|
657
|
+
- [Zernio::AdTreeResponse](docs/AdTreeResponse.md)
|
|
655
658
|
- [Zernio::AddBroadcastRecipients200Response](docs/AddBroadcastRecipients200Response.md)
|
|
656
659
|
- [Zernio::AddBroadcastRecipientsRequest](docs/AddBroadcastRecipientsRequest.md)
|
|
657
660
|
- [Zernio::AddConversionAssociations200Response](docs/AddConversionAssociations200Response.md)
|
|
@@ -670,6 +673,9 @@ Class | Method | HTTP request | Description
|
|
|
670
673
|
- [Zernio::AdjustConversionsRequest](docs/AdjustConversionsRequest.md)
|
|
671
674
|
- [Zernio::AdjustConversionsRequestAdjustmentsInner](docs/AdjustConversionsRequestAdjustmentsInner.md)
|
|
672
675
|
- [Zernio::AdjustConversionsRequestAdjustmentsInnerUser](docs/AdjustConversionsRequestAdjustmentsInnerUser.md)
|
|
676
|
+
- [Zernio::AdsListResponse](docs/AdsListResponse.md)
|
|
677
|
+
- [Zernio::AdsTimelineResponse](docs/AdsTimelineResponse.md)
|
|
678
|
+
- [Zernio::AdsTimelineResponseRowsInner](docs/AdsTimelineResponseRowsInner.md)
|
|
673
679
|
- [Zernio::AnalyticsListResponse](docs/AnalyticsListResponse.md)
|
|
674
680
|
- [Zernio::AnalyticsListResponsePostsInner](docs/AnalyticsListResponsePostsInner.md)
|
|
675
681
|
- [Zernio::AnalyticsOverview](docs/AnalyticsOverview.md)
|
|
@@ -730,6 +736,10 @@ Class | Method | HTTP request | Description
|
|
|
730
736
|
- [Zernio::CallRecordBilling](docs/CallRecordBilling.md)
|
|
731
737
|
- [Zernio::CallRecordCallErrorsInner](docs/CallRecordCallErrorsInner.md)
|
|
732
738
|
- [Zernio::CallRecordTranscriptInner](docs/CallRecordTranscriptInner.md)
|
|
739
|
+
- [Zernio::CampaignAnalyticsResponse](docs/CampaignAnalyticsResponse.md)
|
|
740
|
+
- [Zernio::CampaignAnalyticsResponseAnalytics](docs/CampaignAnalyticsResponseAnalytics.md)
|
|
741
|
+
- [Zernio::CampaignAnalyticsResponseAnalyticsDailyInner](docs/CampaignAnalyticsResponseAnalyticsDailyInner.md)
|
|
742
|
+
- [Zernio::CampaignAnalyticsResponseCampaign](docs/CampaignAnalyticsResponseCampaign.md)
|
|
733
743
|
- [Zernio::CancelBroadcast200Response](docs/CancelBroadcast200Response.md)
|
|
734
744
|
- [Zernio::CancelPhoneNumberPortIn200Response](docs/CancelPhoneNumberPortIn200Response.md)
|
|
735
745
|
- [Zernio::CheckPhoneNumberAvailability200Response](docs/CheckPhoneNumberAvailability200Response.md)
|
|
@@ -1055,8 +1065,7 @@ Class | Method | HTTP request | Description
|
|
|
1055
1065
|
- [Zernio::GetAd200Response](docs/GetAd200Response.md)
|
|
1056
1066
|
- [Zernio::GetAdAccountFinance200Response](docs/GetAdAccountFinance200Response.md)
|
|
1057
1067
|
- [Zernio::GetAdAccountFinance200ResponseFundingSource](docs/GetAdAccountFinance200ResponseFundingSource.md)
|
|
1058
|
-
- [Zernio::
|
|
1059
|
-
- [Zernio::GetAdAnalytics200ResponseAd](docs/GetAdAnalytics200ResponseAd.md)
|
|
1068
|
+
- [Zernio::GetAdAnalytics202Response](docs/GetAdAnalytics202Response.md)
|
|
1060
1069
|
- [Zernio::GetAdAudience200Response](docs/GetAdAudience200Response.md)
|
|
1061
1070
|
- [Zernio::GetAdComments200Response](docs/GetAdComments200Response.md)
|
|
1062
1071
|
- [Zernio::GetAdComments200ResponseMeta](docs/GetAdComments200ResponseMeta.md)
|
|
@@ -1067,14 +1076,13 @@ Class | Method | HTTP request | Description
|
|
|
1067
1076
|
- [Zernio::GetAdPreviews200Response](docs/GetAdPreviews200Response.md)
|
|
1068
1077
|
- [Zernio::GetAdSetDetails200Response](docs/GetAdSetDetails200Response.md)
|
|
1069
1078
|
- [Zernio::GetAdTrackingTags200Response](docs/GetAdTrackingTags200Response.md)
|
|
1070
|
-
- [Zernio::
|
|
1079
|
+
- [Zernio::GetAdTree202Response](docs/GetAdTree202Response.md)
|
|
1071
1080
|
- [Zernio::GetAdsActivityLog200Response](docs/GetAdsActivityLog200Response.md)
|
|
1072
1081
|
- [Zernio::GetAdsActivityLog200ResponsePaging](docs/GetAdsActivityLog200ResponsePaging.md)
|
|
1073
1082
|
- [Zernio::GetAdsSearchTerms200Response](docs/GetAdsSearchTerms200Response.md)
|
|
1074
1083
|
- [Zernio::GetAdsSearchTerms200ResponseDataInner](docs/GetAdsSearchTerms200ResponseDataInner.md)
|
|
1075
1084
|
- [Zernio::GetAdsSearchTerms200ResponsePaging](docs/GetAdsSearchTerms200ResponsePaging.md)
|
|
1076
|
-
- [Zernio::
|
|
1077
|
-
- [Zernio::GetAdsTimeline200ResponseRowsInner](docs/GetAdsTimeline200ResponseRowsInner.md)
|
|
1085
|
+
- [Zernio::GetAdsTimeline202Response](docs/GetAdsTimeline202Response.md)
|
|
1078
1086
|
- [Zernio::GetAllAccountsHealth200Response](docs/GetAllAccountsHealth200Response.md)
|
|
1079
1087
|
- [Zernio::GetAllAccountsHealth200ResponseAccountsInner](docs/GetAllAccountsHealth200ResponseAccountsInner.md)
|
|
1080
1088
|
- [Zernio::GetAllAccountsHealth200ResponseSummary](docs/GetAllAccountsHealth200ResponseSummary.md)
|
|
@@ -1092,10 +1100,7 @@ Class | Method | HTTP request | Description
|
|
|
1092
1100
|
- [Zernio::GetCallsUsage200Response](docs/GetCallsUsage200Response.md)
|
|
1093
1101
|
- [Zernio::GetCallsUsage200ResponseGroupsInner](docs/GetCallsUsage200ResponseGroupsInner.md)
|
|
1094
1102
|
- [Zernio::GetCallsUsage200ResponseTotals](docs/GetCallsUsage200ResponseTotals.md)
|
|
1095
|
-
- [Zernio::
|
|
1096
|
-
- [Zernio::GetCampaignAnalytics200ResponseAnalytics](docs/GetCampaignAnalytics200ResponseAnalytics.md)
|
|
1097
|
-
- [Zernio::GetCampaignAnalytics200ResponseAnalyticsDailyInner](docs/GetCampaignAnalytics200ResponseAnalyticsDailyInner.md)
|
|
1098
|
-
- [Zernio::GetCampaignAnalytics200ResponseCampaign](docs/GetCampaignAnalytics200ResponseCampaign.md)
|
|
1103
|
+
- [Zernio::GetCampaignAnalytics202Response](docs/GetCampaignAnalytics202Response.md)
|
|
1099
1104
|
- [Zernio::GetCommentAutomation200Response](docs/GetCommentAutomation200Response.md)
|
|
1100
1105
|
- [Zernio::GetCommentAutomation200ResponseAutomation](docs/GetCommentAutomation200ResponseAutomation.md)
|
|
1101
1106
|
- [Zernio::GetCommentAutomation200ResponseLogsInner](docs/GetCommentAutomation200ResponseLogsInner.md)
|
|
@@ -1460,7 +1465,7 @@ Class | Method | HTTP request | Description
|
|
|
1460
1465
|
- [Zernio::ListAdKeywords200ResponseKeywordsInner](docs/ListAdKeywords200ResponseKeywordsInner.md)
|
|
1461
1466
|
- [Zernio::ListAdLabels200Response](docs/ListAdLabels200Response.md)
|
|
1462
1467
|
- [Zernio::ListAdStudies200Response](docs/ListAdStudies200Response.md)
|
|
1463
|
-
- [Zernio::
|
|
1468
|
+
- [Zernio::ListAds202Response](docs/ListAds202Response.md)
|
|
1464
1469
|
- [Zernio::ListAdsBusinessCenters200Response](docs/ListAdsBusinessCenters200Response.md)
|
|
1465
1470
|
- [Zernio::ListApiKeys200Response](docs/ListApiKeys200Response.md)
|
|
1466
1471
|
- [Zernio::ListBroadcastRecipients200Response](docs/ListBroadcastRecipients200Response.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::AdAnalyticsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **backfill_pending** | **Boolean** | Present and true while historical data is being backfilled. | [optional] |
|
|
8
|
+
| **ad** | [**AdAnalyticsResponseAd**](AdAnalyticsResponseAd.md) | | [optional] |
|
|
9
|
+
| **analytics** | [**CampaignAnalyticsResponseAnalytics**](CampaignAnalyticsResponseAnalytics.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::AdAnalyticsResponse.new(
|
|
17
|
+
backfill_pending: null,
|
|
18
|
+
ad: null,
|
|
19
|
+
analytics: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::AdAnalyticsResponseAd
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
| **id** | **String** | | [optional] |
|
|
8
8
|
| **name** | **String** | | [optional] |
|
|
9
9
|
| **platform** | **String** | | [optional] |
|
|
10
|
-
| **trigger** | **String** | | [optional] |
|
|
11
10
|
| **status** | **String** | | [optional] |
|
|
12
11
|
| **currency** | **String** | ISO 4217 code of the ad account that owns this ad (e.g. USD, THB, INR). All money values in `summary` and `daily` are in this currency. Null only on legacy ads synced before currency was persisted. | [optional] |
|
|
13
12
|
|
|
@@ -16,11 +15,10 @@
|
|
|
16
15
|
```ruby
|
|
17
16
|
require 'zernio-sdk'
|
|
18
17
|
|
|
19
|
-
instance = Zernio::
|
|
18
|
+
instance = Zernio::AdAnalyticsResponseAd.new(
|
|
20
19
|
id: null,
|
|
21
20
|
name: null,
|
|
22
21
|
platform: null,
|
|
23
|
-
trigger: null,
|
|
24
22
|
status: null,
|
|
25
23
|
currency: null
|
|
26
24
|
)
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -823,7 +823,7 @@ end
|
|
|
823
823
|
|
|
824
824
|
## get_ad_tree
|
|
825
825
|
|
|
826
|
-
> <
|
|
826
|
+
> <AdTreeResponse> get_ad_tree(opts)
|
|
827
827
|
|
|
828
828
|
Get campaign tree
|
|
829
829
|
|
|
@@ -872,7 +872,7 @@ end
|
|
|
872
872
|
|
|
873
873
|
This returns an Array which contains the response data, status code and headers.
|
|
874
874
|
|
|
875
|
-
> <Array(<
|
|
875
|
+
> <Array(<AdTreeResponse>, Integer, Hash)> get_ad_tree_with_http_info(opts)
|
|
876
876
|
|
|
877
877
|
```ruby
|
|
878
878
|
begin
|
|
@@ -880,7 +880,7 @@ begin
|
|
|
880
880
|
data, status_code, headers = api_instance.get_ad_tree_with_http_info(opts)
|
|
881
881
|
p status_code # => 2xx
|
|
882
882
|
p headers # => { ... }
|
|
883
|
-
p data # => <
|
|
883
|
+
p data # => <AdTreeResponse>
|
|
884
884
|
rescue Zernio::ApiError => e
|
|
885
885
|
puts "Error when calling AdCampaignsApi->get_ad_tree_with_http_info: #{e}"
|
|
886
886
|
end
|
|
@@ -908,7 +908,7 @@ end
|
|
|
908
908
|
|
|
909
909
|
### Return type
|
|
910
910
|
|
|
911
|
-
[**
|
|
911
|
+
[**AdTreeResponse**](AdTreeResponse.md)
|
|
912
912
|
|
|
913
913
|
### Authorization
|
|
914
914
|
|
|
@@ -922,7 +922,7 @@ end
|
|
|
922
922
|
|
|
923
923
|
## get_ads_timeline
|
|
924
924
|
|
|
925
|
-
> <
|
|
925
|
+
> <AdsTimelineResponse> get_ads_timeline(account_id, opts)
|
|
926
926
|
|
|
927
927
|
Get daily account metrics
|
|
928
928
|
|
|
@@ -961,7 +961,7 @@ end
|
|
|
961
961
|
|
|
962
962
|
This returns an Array which contains the response data, status code and headers.
|
|
963
963
|
|
|
964
|
-
> <Array(<
|
|
964
|
+
> <Array(<AdsTimelineResponse>, Integer, Hash)> get_ads_timeline_with_http_info(account_id, opts)
|
|
965
965
|
|
|
966
966
|
```ruby
|
|
967
967
|
begin
|
|
@@ -969,7 +969,7 @@ begin
|
|
|
969
969
|
data, status_code, headers = api_instance.get_ads_timeline_with_http_info(account_id, opts)
|
|
970
970
|
p status_code # => 2xx
|
|
971
971
|
p headers # => { ... }
|
|
972
|
-
p data # => <
|
|
972
|
+
p data # => <AdsTimelineResponse>
|
|
973
973
|
rescue Zernio::ApiError => e
|
|
974
974
|
puts "Error when calling AdCampaignsApi->get_ads_timeline_with_http_info: #{e}"
|
|
975
975
|
end
|
|
@@ -987,7 +987,7 @@ end
|
|
|
987
987
|
|
|
988
988
|
### Return type
|
|
989
989
|
|
|
990
|
-
[**
|
|
990
|
+
[**AdsTimelineResponse**](AdsTimelineResponse.md)
|
|
991
991
|
|
|
992
992
|
### Authorization
|
|
993
993
|
|
|
@@ -1185,7 +1185,7 @@ end
|
|
|
1185
1185
|
|
|
1186
1186
|
## list_ads
|
|
1187
1187
|
|
|
1188
|
-
> <
|
|
1188
|
+
> <AdsListResponse> list_ads(opts)
|
|
1189
1189
|
|
|
1190
1190
|
List ads
|
|
1191
1191
|
|
|
@@ -1234,7 +1234,7 @@ end
|
|
|
1234
1234
|
|
|
1235
1235
|
This returns an Array which contains the response data, status code and headers.
|
|
1236
1236
|
|
|
1237
|
-
> <Array(<
|
|
1237
|
+
> <Array(<AdsListResponse>, Integer, Hash)> list_ads_with_http_info(opts)
|
|
1238
1238
|
|
|
1239
1239
|
```ruby
|
|
1240
1240
|
begin
|
|
@@ -1242,7 +1242,7 @@ begin
|
|
|
1242
1242
|
data, status_code, headers = api_instance.list_ads_with_http_info(opts)
|
|
1243
1243
|
p status_code # => 2xx
|
|
1244
1244
|
p headers # => { ... }
|
|
1245
|
-
p data # => <
|
|
1245
|
+
p data # => <AdsListResponse>
|
|
1246
1246
|
rescue Zernio::ApiError => e
|
|
1247
1247
|
puts "Error when calling AdCampaignsApi->list_ads_with_http_info: #{e}"
|
|
1248
1248
|
end
|
|
@@ -1270,7 +1270,7 @@ end
|
|
|
1270
1270
|
|
|
1271
1271
|
### Return type
|
|
1272
1272
|
|
|
1273
|
-
[**
|
|
1273
|
+
[**AdsListResponse**](AdsListResponse.md)
|
|
1274
1274
|
|
|
1275
1275
|
### Authorization
|
|
1276
1276
|
|
data/docs/AdDailyMetrics.md
CHANGED
|
@@ -18,6 +18,13 @@
|
|
|
18
18
|
| **action_values** | **Hash<String, Float>** | Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying — values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}. | [optional] |
|
|
19
19
|
| **purchase_value** | **Float** | Convenience sum of purchase-type action values — picked from `actionValues` via the same priority list as `conversions` so both fields describe the same events. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only. | [optional] |
|
|
20
20
|
| **roas** | **Float** | Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level. | [optional] |
|
|
21
|
+
| **cost_per_action** | **Hash<String, Float>** | Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported. | [optional] |
|
|
22
|
+
| **outbound_clicks** | **Integer** | Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0. | [optional] |
|
|
23
|
+
| **outbound_clicks_ctr** | **Float** | Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level. | [optional] |
|
|
24
|
+
| **inline_link_clicks** | **Integer** | In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only. | [optional] |
|
|
25
|
+
| **inline_link_click_ctr** | **Float** | Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level. | [optional] |
|
|
26
|
+
| **unique_clicks** | **Integer** | People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only. | [optional] |
|
|
27
|
+
| **unique_ctr** | **Float** | Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`. | [optional] |
|
|
21
28
|
| **video_play_actions** | **Integer** | Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`. | [optional] |
|
|
22
29
|
| **video30_sec_watched_actions** | **Integer** | Views of at least 30 seconds (or to the end, for shorter videos). Sources: Meta `video_30_sec_watched_actions` (Meta only). | [optional] |
|
|
23
30
|
| **video_thruplay_watched_actions** | **Integer** | ThruPlays (watched to completion, or at least 15 seconds). Sources: Meta `video_thruplay_watched_actions` (Meta only). | [optional] |
|
|
@@ -53,6 +60,13 @@ instance = Zernio::AdDailyMetrics.new(
|
|
|
53
60
|
action_values: {offsite_conversion.fb_pixel_purchase=2456.78, offsite_conversion.fb_pixel_add_to_cart=980.5},
|
|
54
61
|
purchase_value: null,
|
|
55
62
|
roas: null,
|
|
63
|
+
cost_per_action: {link_click=0.1052, offsite_conversion.fb_pixel_purchase=4.0114},
|
|
64
|
+
outbound_clicks: null,
|
|
65
|
+
outbound_clicks_ctr: null,
|
|
66
|
+
inline_link_clicks: null,
|
|
67
|
+
inline_link_click_ctr: null,
|
|
68
|
+
unique_clicks: null,
|
|
69
|
+
unique_ctr: null,
|
|
56
70
|
video_play_actions: null,
|
|
57
71
|
video30_sec_watched_actions: null,
|
|
58
72
|
video_thruplay_watched_actions: null,
|
data/docs/AdEngagementCounts.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **saves** | **Integer** | Saves of the ad's post (`onsite_conversion.post_save`). | [optional] |
|
|
13
13
|
| **page_likes** | **Integer** | New Page likes attributed to the ad (`like`). | [optional] |
|
|
14
14
|
| **video_views** | **Integer** | 3-second video views (`video_view`). For completion-based counts use `videoThruplayWatchedActions`. | [optional] |
|
|
15
|
-
| **link_clicks** | **Integer** | Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session
|
|
15
|
+
| **link_clicks** | **Integer** | Attributed link clicks (`link_click`). This is the attribution-window count, which differs from the in-session count in the sibling `inlineLinkClicks` field. | [optional] |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
data/docs/AdInsightsApi.md
CHANGED
|
@@ -223,7 +223,7 @@ end
|
|
|
223
223
|
|
|
224
224
|
## get_ad_analytics
|
|
225
225
|
|
|
226
|
-
> <
|
|
226
|
+
> <AdAnalyticsResponse> get_ad_analytics(ad_id, opts)
|
|
227
227
|
|
|
228
228
|
Get ad analytics
|
|
229
229
|
|
|
@@ -261,7 +261,7 @@ end
|
|
|
261
261
|
|
|
262
262
|
This returns an Array which contains the response data, status code and headers.
|
|
263
263
|
|
|
264
|
-
> <Array(<
|
|
264
|
+
> <Array(<AdAnalyticsResponse>, Integer, Hash)> get_ad_analytics_with_http_info(ad_id, opts)
|
|
265
265
|
|
|
266
266
|
```ruby
|
|
267
267
|
begin
|
|
@@ -269,7 +269,7 @@ begin
|
|
|
269
269
|
data, status_code, headers = api_instance.get_ad_analytics_with_http_info(ad_id, opts)
|
|
270
270
|
p status_code # => 2xx
|
|
271
271
|
p headers # => { ... }
|
|
272
|
-
p data # => <
|
|
272
|
+
p data # => <AdAnalyticsResponse>
|
|
273
273
|
rescue Zernio::ApiError => e
|
|
274
274
|
puts "Error when calling AdInsightsApi->get_ad_analytics_with_http_info: #{e}"
|
|
275
275
|
end
|
|
@@ -286,7 +286,7 @@ end
|
|
|
286
286
|
|
|
287
287
|
### Return type
|
|
288
288
|
|
|
289
|
-
[**
|
|
289
|
+
[**AdAnalyticsResponse**](AdAnalyticsResponse.md)
|
|
290
290
|
|
|
291
291
|
### Authorization
|
|
292
292
|
|
|
@@ -460,7 +460,7 @@ end
|
|
|
460
460
|
|
|
461
461
|
## get_campaign_analytics
|
|
462
462
|
|
|
463
|
-
> <
|
|
463
|
+
> <CampaignAnalyticsResponse> get_campaign_analytics(campaign_id, opts)
|
|
464
464
|
|
|
465
465
|
Get campaign analytics
|
|
466
466
|
|
|
@@ -499,7 +499,7 @@ end
|
|
|
499
499
|
|
|
500
500
|
This returns an Array which contains the response data, status code and headers.
|
|
501
501
|
|
|
502
|
-
> <Array(<
|
|
502
|
+
> <Array(<CampaignAnalyticsResponse>, Integer, Hash)> get_campaign_analytics_with_http_info(campaign_id, opts)
|
|
503
503
|
|
|
504
504
|
```ruby
|
|
505
505
|
begin
|
|
@@ -507,7 +507,7 @@ begin
|
|
|
507
507
|
data, status_code, headers = api_instance.get_campaign_analytics_with_http_info(campaign_id, opts)
|
|
508
508
|
p status_code # => 2xx
|
|
509
509
|
p headers # => { ... }
|
|
510
|
-
p data # => <
|
|
510
|
+
p data # => <CampaignAnalyticsResponse>
|
|
511
511
|
rescue Zernio::ApiError => e
|
|
512
512
|
puts "Error when calling AdInsightsApi->get_campaign_analytics_with_http_info: #{e}"
|
|
513
513
|
end
|
|
@@ -525,7 +525,7 @@ end
|
|
|
525
525
|
|
|
526
526
|
### Return type
|
|
527
527
|
|
|
528
|
-
[**
|
|
528
|
+
[**CampaignAnalyticsResponse**](CampaignAnalyticsResponse.md)
|
|
529
529
|
|
|
530
530
|
### Authorization
|
|
531
531
|
|
data/docs/AdMetrics.md
CHANGED
|
@@ -18,6 +18,13 @@
|
|
|
18
18
|
| **action_values** | **Hash<String, Float>** | Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying — values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}. | [optional] |
|
|
19
19
|
| **purchase_value** | **Float** | Convenience sum of purchase-type action values — picked from `actionValues` via the same priority list as `conversions` so both fields describe the same events. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only. | [optional] |
|
|
20
20
|
| **roas** | **Float** | Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level. | [optional] |
|
|
21
|
+
| **cost_per_action** | **Hash<String, Float>** | Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported. | [optional] |
|
|
22
|
+
| **outbound_clicks** | **Integer** | Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0. | [optional] |
|
|
23
|
+
| **outbound_clicks_ctr** | **Float** | Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level. | [optional] |
|
|
24
|
+
| **inline_link_clicks** | **Integer** | In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only. | [optional] |
|
|
25
|
+
| **inline_link_click_ctr** | **Float** | Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level. | [optional] |
|
|
26
|
+
| **unique_clicks** | **Integer** | People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only. | [optional] |
|
|
27
|
+
| **unique_ctr** | **Float** | Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`. | [optional] |
|
|
21
28
|
| **video_play_actions** | **Integer** | Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`. | [optional] |
|
|
22
29
|
| **video30_sec_watched_actions** | **Integer** | Views of at least 30 seconds (or to the end, for shorter videos). Sources: Meta `video_30_sec_watched_actions` (Meta only). | [optional] |
|
|
23
30
|
| **video_thruplay_watched_actions** | **Integer** | ThruPlays (watched to completion, or at least 15 seconds). Sources: Meta `video_thruplay_watched_actions` (Meta only). | [optional] |
|
|
@@ -52,6 +59,13 @@ instance = Zernio::AdMetrics.new(
|
|
|
52
59
|
action_values: {offsite_conversion.fb_pixel_purchase=2456.78, offsite_conversion.fb_pixel_add_to_cart=980.5},
|
|
53
60
|
purchase_value: null,
|
|
54
61
|
roas: null,
|
|
62
|
+
cost_per_action: {link_click=0.1052, offsite_conversion.fb_pixel_purchase=4.0114},
|
|
63
|
+
outbound_clicks: null,
|
|
64
|
+
outbound_clicks_ctr: null,
|
|
65
|
+
inline_link_clicks: null,
|
|
66
|
+
inline_link_click_ctr: null,
|
|
67
|
+
unique_clicks: null,
|
|
68
|
+
unique_ctr: null,
|
|
55
69
|
video_play_actions: null,
|
|
56
70
|
video30_sec_watched_actions: null,
|
|
57
71
|
video_thruplay_watched_actions: null,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::AdTreeResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **campaigns** | [**Array<AdTreeCampaign>**](AdTreeCampaign.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**Pagination**](Pagination.md) | | [optional] |
|
|
9
|
+
| **backfill_pending** | **Boolean** | Present and true while historical data is being backfilled. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::AdTreeResponse.new(
|
|
17
|
+
campaigns: null,
|
|
18
|
+
pagination: null,
|
|
19
|
+
backfill_pending: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::AdsListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ads** | [**Array<Ad>**](Ad.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**Pagination**](Pagination.md) | | [optional] |
|
|
9
|
+
| **backfill_pending** | **Boolean** | Present and true while historical data is being backfilled. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::AdsListResponse.new(
|
|
17
|
+
ads: null,
|
|
18
|
+
pagination: null,
|
|
19
|
+
backfill_pending: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::AdsTimelineResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **backfill_pending** | **Boolean** | Present and true while historical data is being backfilled. | [optional] |
|
|
8
|
+
| **rows** | [**Array<AdsTimelineResponseRowsInner>**](AdsTimelineResponseRowsInner.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::AdsTimelineResponse.new(
|
|
16
|
+
backfill_pending: null,
|
|
17
|
+
rows: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::AdsTimelineResponseRowsInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
```ruby
|
|
26
26
|
require 'zernio-sdk'
|
|
27
27
|
|
|
28
|
-
instance = Zernio::
|
|
28
|
+
instance = Zernio::AdsTimelineResponseRowsInner.new(
|
|
29
29
|
date: null,
|
|
30
30
|
spend: null,
|
|
31
31
|
impressions: null,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::CampaignAnalyticsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **backfill_pending** | **Boolean** | Present and true while historical data is being backfilled. | [optional] |
|
|
8
|
+
| **campaign** | [**CampaignAnalyticsResponseCampaign**](CampaignAnalyticsResponseCampaign.md) | | [optional] |
|
|
9
|
+
| **analytics** | [**CampaignAnalyticsResponseAnalytics**](CampaignAnalyticsResponseAnalytics.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::CampaignAnalyticsResponse.new(
|
|
17
|
+
backfill_pending: null,
|
|
18
|
+
campaign: null,
|
|
19
|
+
analytics: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/{GetCampaignAnalytics200ResponseAnalytics.md → CampaignAnalyticsResponseAnalytics.md}
RENAMED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CampaignAnalyticsResponseAnalytics
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **summary** | [**AdMetrics**](AdMetrics.md) | | [optional] |
|
|
8
|
-
| **daily** | [**Array<
|
|
8
|
+
| **daily** | [**Array<CampaignAnalyticsResponseAnalyticsDailyInner>**](CampaignAnalyticsResponseAnalyticsDailyInner.md) | | [optional] |
|
|
9
9
|
| **breakdowns** | **Hash<String, Array<Object>>** | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'zernio-sdk'
|
|
15
15
|
|
|
16
|
-
instance = Zernio::
|
|
16
|
+
instance = Zernio::CampaignAnalyticsResponseAnalytics.new(
|
|
17
17
|
summary: null,
|
|
18
18
|
daily: null,
|
|
19
19
|
breakdowns: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CampaignAnalyticsResponseAnalyticsDailyInner
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -18,6 +18,13 @@
|
|
|
18
18
|
| **action_values** | **Hash<String, Float>** | Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying — values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}. | [optional] |
|
|
19
19
|
| **purchase_value** | **Float** | Convenience sum of purchase-type action values — picked from `actionValues` via the same priority list as `conversions` so both fields describe the same events. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only. | [optional] |
|
|
20
20
|
| **roas** | **Float** | Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level. | [optional] |
|
|
21
|
+
| **cost_per_action** | **Hash<String, Float>** | Derived `spend / actions[type]` for every action type with a non-zero count, in ad-account native currency. Same keys as `actions`. Rounded to 4 decimals because cheap actions cost well under a cent. Recomputed from summed spend + counts at every rollup level. Empty object when spend is 0 or no actions are reported. | [optional] |
|
|
22
|
+
| **outbound_clicks** | **Integer** | Clicks leading off Meta's surfaces to the advertiser's destination. Meta-only; other platforms report 0. | [optional] |
|
|
23
|
+
| **outbound_clicks_ctr** | **Float** | Derived `outboundClicks / impressions * 100`, recomputed from sums at every rollup level. | [optional] |
|
|
24
|
+
| **inline_link_clicks** | **Integer** | In-session link clicks. Differs from the attributed `link_click` count in `actions`/`engagementBreakdown.linkClicks`, which uses the attribution window. Meta-only. | [optional] |
|
|
25
|
+
| **inline_link_click_ctr** | **Float** | Derived `inlineLinkClicks / impressions * 100`, recomputed from sums at every rollup level. | [optional] |
|
|
26
|
+
| **unique_clicks** | **Integer** | People who clicked at least once. NOT additive: summed across days/children it overcounts people who clicked on multiple days or ads, so treat rollups as an upper bound (same caveat as `reach`). Meta-only. | [optional] |
|
|
27
|
+
| **unique_ctr** | **Float** | Derived `uniqueClicks / impressions * 100` (NOT Meta's reach-based unique_ctr). Inherits the non-additivity caveat of `uniqueClicks`. | [optional] |
|
|
21
28
|
| **video_play_actions** | **Integer** | Number of times the video started playing, summed over the date range and across children at ad-set/campaign level. 0 for non-video ads. Sources: Meta `video_play_actions`, TikTok `video_play_actions`. | [optional] |
|
|
22
29
|
| **video30_sec_watched_actions** | **Integer** | Views of at least 30 seconds (or to the end, for shorter videos). Sources: Meta `video_30_sec_watched_actions` (Meta only). | [optional] |
|
|
23
30
|
| **video_thruplay_watched_actions** | **Integer** | ThruPlays (watched to completion, or at least 15 seconds). Sources: Meta `video_thruplay_watched_actions` (Meta only). | [optional] |
|
|
@@ -38,7 +45,7 @@
|
|
|
38
45
|
```ruby
|
|
39
46
|
require 'zernio-sdk'
|
|
40
47
|
|
|
41
|
-
instance = Zernio::
|
|
48
|
+
instance = Zernio::CampaignAnalyticsResponseAnalyticsDailyInner.new(
|
|
42
49
|
spend: null,
|
|
43
50
|
impressions: null,
|
|
44
51
|
reach: null,
|
|
@@ -53,6 +60,13 @@ instance = Zernio::GetCampaignAnalytics200ResponseAnalyticsDailyInner.new(
|
|
|
53
60
|
action_values: {offsite_conversion.fb_pixel_purchase=2456.78, offsite_conversion.fb_pixel_add_to_cart=980.5},
|
|
54
61
|
purchase_value: null,
|
|
55
62
|
roas: null,
|
|
63
|
+
cost_per_action: {link_click=0.1052, offsite_conversion.fb_pixel_purchase=4.0114},
|
|
64
|
+
outbound_clicks: null,
|
|
65
|
+
outbound_clicks_ctr: null,
|
|
66
|
+
inline_link_clicks: null,
|
|
67
|
+
inline_link_click_ctr: null,
|
|
68
|
+
unique_clicks: null,
|
|
69
|
+
unique_ctr: null,
|
|
56
70
|
video_play_actions: null,
|
|
57
71
|
video30_sec_watched_actions: null,
|
|
58
72
|
video_thruplay_watched_actions: null,
|
data/docs/{GetCampaignAnalytics200ResponseCampaign.md → CampaignAnalyticsResponseCampaign.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CampaignAnalyticsResponseCampaign
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'zernio-sdk'
|
|
17
17
|
|
|
18
|
-
instance = Zernio::
|
|
18
|
+
instance = Zernio::CampaignAnalyticsResponseCampaign.new(
|
|
19
19
|
id: null,
|
|
20
20
|
name: null,
|
|
21
21
|
platform: null,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::GetAdAnalytics202Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **backfill_pending** | **Boolean** | | |
|
|
8
|
+
| **ad** | [**AdAnalyticsResponseAd**](AdAnalyticsResponseAd.md) | | [optional] |
|
|
9
|
+
| **analytics** | [**CampaignAnalyticsResponseAnalytics**](CampaignAnalyticsResponseAnalytics.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::GetAdAnalytics202Response.new(
|
|
17
|
+
backfill_pending: null,
|
|
18
|
+
ad: null,
|
|
19
|
+
analytics: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::GetAdTree202Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **campaigns** | [**Array<AdTreeCampaign>**](AdTreeCampaign.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**Pagination**](Pagination.md) | | [optional] |
|
|
9
|
+
| **backfill_pending** | **Boolean** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::GetAdTree202Response.new(
|
|
17
|
+
campaigns: null,
|
|
18
|
+
pagination: null,
|
|
19
|
+
backfill_pending: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::GetAdsTimeline202Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **backfill_pending** | **Boolean** | | |
|
|
8
|
+
| **rows** | [**Array<AdsTimelineResponseRowsInner>**](AdsTimelineResponseRowsInner.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::GetAdsTimeline202Response.new(
|
|
16
|
+
backfill_pending: null,
|
|
17
|
+
rows: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|