late-sdk 0.0.854 → 0.0.855
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/docs/AdCampaignsApi.md +1 -1
- data/docs/AdDailyMetrics.md +2 -0
- data/docs/AdMetrics.md +2 -0
- data/docs/AdsTimelineResponseRowsInner.md +2 -0
- data/docs/CampaignAnalyticsResponseAnalyticsDailyInner.md +2 -0
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +2 -2
- data/lib/zernio-sdk/models/ad_daily_metrics.rb +11 -1
- data/lib/zernio-sdk/models/ad_metrics.rb +11 -1
- data/lib/zernio-sdk/models/ads_timeline_response_rows_inner.rb +11 -1
- data/lib/zernio-sdk/models/campaign_analytics_response_analytics_daily_inner.rb +11 -1
- data/lib/zernio-sdk/version.rb +1 -1
- data/openapi.yaml +20 -0
- data/spec/api/ad_campaigns_api_spec.rb +1 -1
- data/spec/models/ad_daily_metrics_spec.rb +6 -0
- data/spec/models/ad_metrics_spec.rb +6 -0
- data/spec/models/ads_timeline_response_rows_inner_spec.rb +6 -0
- data/spec/models/campaign_analytics_response_analytics_daily_inner_spec.rb +6 -0
- data/zernio-sdk-0.0.855.gem +0 -0
- metadata +2 -2
- data/zernio-sdk-0.0.854.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: 1ab1864cbcad536ce6cf08e16d3ecaeb86ceacdee6c4cfbd30aa3261563f81fa
|
|
4
|
+
data.tar.gz: e5fbd5ef7c080df833cc544848741742a42a4597a4860578eb7a5eed9bcac3db
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2214e8ba6fd2266d69de612848e72086c2fa64cf2615c3ccae521255e92437fb1eca1f49cfcaa72fb39d3da53b611227b0cc74808754528cae2ca8c28d0f970d
|
|
7
|
+
data.tar.gz: 8e82cd61afe4a6cdcda8dcec3ba25426046ef011467593e010012c72b40fdbbba57a5d8a3176e86707d0e44892cc5cdc19c133331c6b9421ea92d3a1a25c41c3
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -1076,7 +1076,7 @@ end
|
|
|
1076
1076
|
|
|
1077
1077
|
Get daily account metrics
|
|
1078
1078
|
|
|
1079
|
-
Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data.
|
|
1079
|
+
Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data. With adAccountId set to a Google customer id this is the customer-level performance report (clicks, cost, impressions, conversions, all conversions per day).
|
|
1080
1080
|
|
|
1081
1081
|
### Examples
|
|
1082
1082
|
|
data/docs/AdDailyMetrics.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **cpm** | **Float** | Cost per 1000 impressions | [optional] |
|
|
14
14
|
| **engagement** | **Integer** | | [optional] |
|
|
15
15
|
| **conversions** | **Float** | Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired. | [optional] |
|
|
16
|
+
| **all_conversions** | **Float** | All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept. | [optional] |
|
|
16
17
|
| **cost_per_conversion** | **Float** | Derived spend / conversions in the same currency as spend. 0 when conversions is 0. | [optional] |
|
|
17
18
|
| **actions** | **Hash<String, Integer>** | Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them. | [optional] |
|
|
18
19
|
| **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] |
|
|
@@ -55,6 +56,7 @@ instance = Zernio::AdDailyMetrics.new(
|
|
|
55
56
|
cpm: null,
|
|
56
57
|
engagement: null,
|
|
57
58
|
conversions: null,
|
|
59
|
+
all_conversions: null,
|
|
58
60
|
cost_per_conversion: null,
|
|
59
61
|
actions: {link_click=160, post_engagement=300, offsite_conversion.fb_pixel_purchase=42},
|
|
60
62
|
action_values: {offsite_conversion.fb_pixel_purchase=2456.78, offsite_conversion.fb_pixel_add_to_cart=980.5},
|
data/docs/AdMetrics.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **cpm** | **Float** | Cost per 1000 impressions | [optional] |
|
|
14
14
|
| **engagement** | **Integer** | | [optional] |
|
|
15
15
|
| **conversions** | **Float** | Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired. | [optional] |
|
|
16
|
+
| **all_conversions** | **Float** | All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept. | [optional] |
|
|
16
17
|
| **cost_per_conversion** | **Float** | Derived spend / conversions in the same currency as spend. 0 when conversions is 0. | [optional] |
|
|
17
18
|
| **actions** | **Hash<String, Integer>** | Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them. | [optional] |
|
|
18
19
|
| **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] |
|
|
@@ -54,6 +55,7 @@ instance = Zernio::AdMetrics.new(
|
|
|
54
55
|
cpm: null,
|
|
55
56
|
engagement: null,
|
|
56
57
|
conversions: null,
|
|
58
|
+
all_conversions: null,
|
|
57
59
|
cost_per_conversion: null,
|
|
58
60
|
actions: {link_click=160, post_engagement=300, offsite_conversion.fb_pixel_purchase=42},
|
|
59
61
|
action_values: {offsite_conversion.fb_pixel_purchase=2456.78, offsite_conversion.fb_pixel_add_to_cart=980.5},
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **cpc** | **Float** | Cost per click in native currency. | [optional] |
|
|
15
15
|
| **cpm** | **Float** | Cost per 1000 impressions in native currency. | [optional] |
|
|
16
16
|
| **conversions** | **Float** | Sum of conversion events over the range. Fractional values are normal (attribution splitting + Google modeled conversions). Meta: events matching the campaign optimization goal. Google: tracked conversions. X / LinkedIn: reported website/lead conversions (added 2026-07). | [optional] |
|
|
17
|
+
| **all_conversions** | **Float** | All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept. | [optional] |
|
|
17
18
|
| **cost_per_conversion** | **Float** | | [optional] |
|
|
18
19
|
| **actions** | **Hash<String, Float>** | Per-action-type counts merged across all ads on this day. Keys are platform-native action types. | [optional] |
|
|
19
20
|
| **action_values** | **Hash<String, Float>** | Monetary mirror of `actions` in native currency. | [optional] |
|
|
@@ -36,6 +37,7 @@ instance = Zernio::AdsTimelineResponseRowsInner.new(
|
|
|
36
37
|
cpc: null,
|
|
37
38
|
cpm: null,
|
|
38
39
|
conversions: null,
|
|
40
|
+
all_conversions: null,
|
|
39
41
|
cost_per_conversion: null,
|
|
40
42
|
actions: null,
|
|
41
43
|
action_values: null,
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **cpm** | **Float** | Cost per 1000 impressions | [optional] |
|
|
14
14
|
| **engagement** | **Integer** | | [optional] |
|
|
15
15
|
| **conversions** | **Float** | Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired. | [optional] |
|
|
16
|
+
| **all_conversions** | **Float** | All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept. | [optional] |
|
|
16
17
|
| **cost_per_conversion** | **Float** | Derived spend / conversions in the same currency as spend. 0 when conversions is 0. | [optional] |
|
|
17
18
|
| **actions** | **Hash<String, Integer>** | Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them. | [optional] |
|
|
18
19
|
| **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] |
|
|
@@ -55,6 +56,7 @@ instance = Zernio::CampaignAnalyticsResponseAnalyticsDailyInner.new(
|
|
|
55
56
|
cpm: null,
|
|
56
57
|
engagement: null,
|
|
57
58
|
conversions: null,
|
|
59
|
+
all_conversions: null,
|
|
58
60
|
cost_per_conversion: null,
|
|
59
61
|
actions: {link_click=160, post_engagement=300, offsite_conversion.fb_pixel_purchase=42},
|
|
60
62
|
action_values: {offsite_conversion.fb_pixel_purchase=2456.78, offsite_conversion.fb_pixel_add_to_cart=980.5},
|
|
@@ -1106,7 +1106,7 @@ module Zernio
|
|
|
1106
1106
|
end
|
|
1107
1107
|
|
|
1108
1108
|
# Get daily account metrics
|
|
1109
|
-
# Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data.
|
|
1109
|
+
# Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data. With adAccountId set to a Google customer id this is the customer-level performance report (clicks, cost, impressions, conversions, all conversions per day).
|
|
1110
1110
|
# @param account_id [String] Social account ID. Sibling-expanded to its linked posting↔ads pair.
|
|
1111
1111
|
# @param [Hash] opts the optional parameters
|
|
1112
1112
|
# @option opts [String] :ad_account_id Optional platform-native ad account ID (e.g. Meta `act_…`, TikTok advertiser ID). Use when the connection wraps multiple platform ad accounts and the chart should show one only. Note: rows ingested before 2026-05-13 don't carry this column; the recurring 7-day re-sync repopulates them naturally.
|
|
@@ -1120,7 +1120,7 @@ module Zernio
|
|
|
1120
1120
|
end
|
|
1121
1121
|
|
|
1122
1122
|
# Get daily account metrics
|
|
1123
|
-
# Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data.
|
|
1123
|
+
# Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data. With adAccountId set to a Google customer id this is the customer-level performance report (clicks, cost, impressions, conversions, all conversions per day).
|
|
1124
1124
|
# @param account_id [String] Social account ID. Sibling-expanded to its linked posting↔ads pair.
|
|
1125
1125
|
# @param [Hash] opts the optional parameters
|
|
1126
1126
|
# @option opts [String] :ad_account_id Optional platform-native ad account ID (e.g. Meta `act_…`, TikTok advertiser ID). Use when the connection wraps multiple platform ad accounts and the chart should show one only. Note: rows ingested before 2026-05-13 don't carry this column; the recurring 7-day re-sync repopulates them naturally.
|
|
@@ -39,6 +39,9 @@ module Zernio
|
|
|
39
39
|
# Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired.
|
|
40
40
|
attr_accessor :conversions
|
|
41
41
|
|
|
42
|
+
# All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept.
|
|
43
|
+
attr_accessor :all_conversions
|
|
44
|
+
|
|
42
45
|
# Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
|
|
43
46
|
attr_accessor :cost_per_conversion
|
|
44
47
|
|
|
@@ -127,6 +130,7 @@ module Zernio
|
|
|
127
130
|
:'cpm' => :'cpm',
|
|
128
131
|
:'engagement' => :'engagement',
|
|
129
132
|
:'conversions' => :'conversions',
|
|
133
|
+
:'all_conversions' => :'allConversions',
|
|
130
134
|
:'cost_per_conversion' => :'costPerConversion',
|
|
131
135
|
:'actions' => :'actions',
|
|
132
136
|
:'action_values' => :'actionValues',
|
|
@@ -178,6 +182,7 @@ module Zernio
|
|
|
178
182
|
:'cpm' => :'Float',
|
|
179
183
|
:'engagement' => :'Integer',
|
|
180
184
|
:'conversions' => :'Float',
|
|
185
|
+
:'all_conversions' => :'Float',
|
|
181
186
|
:'cost_per_conversion' => :'Float',
|
|
182
187
|
:'actions' => :'Hash<String, Integer>',
|
|
183
188
|
:'action_values' => :'Hash<String, Float>',
|
|
@@ -272,6 +277,10 @@ module Zernio
|
|
|
272
277
|
self.conversions = attributes[:'conversions']
|
|
273
278
|
end
|
|
274
279
|
|
|
280
|
+
if attributes.key?(:'all_conversions')
|
|
281
|
+
self.all_conversions = attributes[:'all_conversions']
|
|
282
|
+
end
|
|
283
|
+
|
|
275
284
|
if attributes.key?(:'cost_per_conversion')
|
|
276
285
|
self.cost_per_conversion = attributes[:'cost_per_conversion']
|
|
277
286
|
end
|
|
@@ -412,6 +421,7 @@ module Zernio
|
|
|
412
421
|
cpm == o.cpm &&
|
|
413
422
|
engagement == o.engagement &&
|
|
414
423
|
conversions == o.conversions &&
|
|
424
|
+
all_conversions == o.all_conversions &&
|
|
415
425
|
cost_per_conversion == o.cost_per_conversion &&
|
|
416
426
|
actions == o.actions &&
|
|
417
427
|
action_values == o.action_values &&
|
|
@@ -449,7 +459,7 @@ module Zernio
|
|
|
449
459
|
# Calculates hash code according to all attributes.
|
|
450
460
|
# @return [Integer] Hash code
|
|
451
461
|
def hash
|
|
452
|
-
[spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, cost_per_conversion, actions, action_values, purchase_value, roas, cost_per_action, outbound_clicks, outbound_clicks_ctr, inline_link_clicks, inline_link_click_ctr, unique_clicks, unique_ctr, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at, date].hash
|
|
462
|
+
[spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, all_conversions, cost_per_conversion, actions, action_values, purchase_value, roas, cost_per_action, outbound_clicks, outbound_clicks_ctr, inline_link_clicks, inline_link_click_ctr, unique_clicks, unique_ctr, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at, date].hash
|
|
453
463
|
end
|
|
454
464
|
|
|
455
465
|
# Builds the object from hash
|
|
@@ -38,6 +38,9 @@ module Zernio
|
|
|
38
38
|
# Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired.
|
|
39
39
|
attr_accessor :conversions
|
|
40
40
|
|
|
41
|
+
# All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept.
|
|
42
|
+
attr_accessor :all_conversions
|
|
43
|
+
|
|
41
44
|
# Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
|
|
42
45
|
attr_accessor :cost_per_conversion
|
|
43
46
|
|
|
@@ -123,6 +126,7 @@ module Zernio
|
|
|
123
126
|
:'cpm' => :'cpm',
|
|
124
127
|
:'engagement' => :'engagement',
|
|
125
128
|
:'conversions' => :'conversions',
|
|
129
|
+
:'all_conversions' => :'allConversions',
|
|
126
130
|
:'cost_per_conversion' => :'costPerConversion',
|
|
127
131
|
:'actions' => :'actions',
|
|
128
132
|
:'action_values' => :'actionValues',
|
|
@@ -173,6 +177,7 @@ module Zernio
|
|
|
173
177
|
:'cpm' => :'Float',
|
|
174
178
|
:'engagement' => :'Integer',
|
|
175
179
|
:'conversions' => :'Float',
|
|
180
|
+
:'all_conversions' => :'Float',
|
|
176
181
|
:'cost_per_conversion' => :'Float',
|
|
177
182
|
:'actions' => :'Hash<String, Integer>',
|
|
178
183
|
:'action_values' => :'Hash<String, Float>',
|
|
@@ -259,6 +264,10 @@ module Zernio
|
|
|
259
264
|
self.conversions = attributes[:'conversions']
|
|
260
265
|
end
|
|
261
266
|
|
|
267
|
+
if attributes.key?(:'all_conversions')
|
|
268
|
+
self.all_conversions = attributes[:'all_conversions']
|
|
269
|
+
end
|
|
270
|
+
|
|
262
271
|
if attributes.key?(:'cost_per_conversion')
|
|
263
272
|
self.cost_per_conversion = attributes[:'cost_per_conversion']
|
|
264
273
|
end
|
|
@@ -395,6 +404,7 @@ module Zernio
|
|
|
395
404
|
cpm == o.cpm &&
|
|
396
405
|
engagement == o.engagement &&
|
|
397
406
|
conversions == o.conversions &&
|
|
407
|
+
all_conversions == o.all_conversions &&
|
|
398
408
|
cost_per_conversion == o.cost_per_conversion &&
|
|
399
409
|
actions == o.actions &&
|
|
400
410
|
action_values == o.action_values &&
|
|
@@ -431,7 +441,7 @@ module Zernio
|
|
|
431
441
|
# Calculates hash code according to all attributes.
|
|
432
442
|
# @return [Integer] Hash code
|
|
433
443
|
def hash
|
|
434
|
-
[spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, cost_per_conversion, actions, action_values, purchase_value, roas, cost_per_action, outbound_clicks, outbound_clicks_ctr, inline_link_clicks, inline_link_click_ctr, unique_clicks, unique_ctr, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at].hash
|
|
444
|
+
[spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, all_conversions, cost_per_conversion, actions, action_values, purchase_value, roas, cost_per_action, outbound_clicks, outbound_clicks_ctr, inline_link_clicks, inline_link_click_ctr, unique_clicks, unique_ctr, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at].hash
|
|
435
445
|
end
|
|
436
446
|
|
|
437
447
|
# Builds the object from hash
|
|
@@ -41,6 +41,9 @@ module Zernio
|
|
|
41
41
|
# Sum of conversion events over the range. Fractional values are normal (attribution splitting + Google modeled conversions). Meta: events matching the campaign optimization goal. Google: tracked conversions. X / LinkedIn: reported website/lead conversions (added 2026-07).
|
|
42
42
|
attr_accessor :conversions
|
|
43
43
|
|
|
44
|
+
# All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept.
|
|
45
|
+
attr_accessor :all_conversions
|
|
46
|
+
|
|
44
47
|
attr_accessor :cost_per_conversion
|
|
45
48
|
|
|
46
49
|
# Per-action-type counts merged across all ads on this day. Keys are platform-native action types.
|
|
@@ -68,6 +71,7 @@ module Zernio
|
|
|
68
71
|
:'cpc' => :'cpc',
|
|
69
72
|
:'cpm' => :'cpm',
|
|
70
73
|
:'conversions' => :'conversions',
|
|
74
|
+
:'all_conversions' => :'allConversions',
|
|
71
75
|
:'cost_per_conversion' => :'costPerConversion',
|
|
72
76
|
:'actions' => :'actions',
|
|
73
77
|
:'action_values' => :'actionValues',
|
|
@@ -99,6 +103,7 @@ module Zernio
|
|
|
99
103
|
:'cpc' => :'Float',
|
|
100
104
|
:'cpm' => :'Float',
|
|
101
105
|
:'conversions' => :'Float',
|
|
106
|
+
:'all_conversions' => :'Float',
|
|
102
107
|
:'cost_per_conversion' => :'Float',
|
|
103
108
|
:'actions' => :'Hash<String, Float>',
|
|
104
109
|
:'action_values' => :'Hash<String, Float>',
|
|
@@ -169,6 +174,10 @@ module Zernio
|
|
|
169
174
|
self.conversions = attributes[:'conversions']
|
|
170
175
|
end
|
|
171
176
|
|
|
177
|
+
if attributes.key?(:'all_conversions')
|
|
178
|
+
self.all_conversions = attributes[:'all_conversions']
|
|
179
|
+
end
|
|
180
|
+
|
|
172
181
|
if attributes.key?(:'cost_per_conversion')
|
|
173
182
|
self.cost_per_conversion = attributes[:'cost_per_conversion']
|
|
174
183
|
end
|
|
@@ -224,6 +233,7 @@ module Zernio
|
|
|
224
233
|
cpc == o.cpc &&
|
|
225
234
|
cpm == o.cpm &&
|
|
226
235
|
conversions == o.conversions &&
|
|
236
|
+
all_conversions == o.all_conversions &&
|
|
227
237
|
cost_per_conversion == o.cost_per_conversion &&
|
|
228
238
|
actions == o.actions &&
|
|
229
239
|
action_values == o.action_values &&
|
|
@@ -240,7 +250,7 @@ module Zernio
|
|
|
240
250
|
# Calculates hash code according to all attributes.
|
|
241
251
|
# @return [Integer] Hash code
|
|
242
252
|
def hash
|
|
243
|
-
[date, spend, impressions, reach, clicks, engagement, ctr, cpc, cpm, conversions, cost_per_conversion, actions, action_values, purchase_value, roas].hash
|
|
253
|
+
[date, spend, impressions, reach, clicks, engagement, ctr, cpc, cpm, conversions, all_conversions, cost_per_conversion, actions, action_values, purchase_value, roas].hash
|
|
244
254
|
end
|
|
245
255
|
|
|
246
256
|
# Builds the object from hash
|
|
@@ -38,6 +38,9 @@ module Zernio
|
|
|
38
38
|
# Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired.
|
|
39
39
|
attr_accessor :conversions
|
|
40
40
|
|
|
41
|
+
# All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept.
|
|
42
|
+
attr_accessor :all_conversions
|
|
43
|
+
|
|
41
44
|
# Derived spend / conversions in the same currency as spend. 0 when conversions is 0.
|
|
42
45
|
attr_accessor :cost_per_conversion
|
|
43
46
|
|
|
@@ -125,6 +128,7 @@ module Zernio
|
|
|
125
128
|
:'cpm' => :'cpm',
|
|
126
129
|
:'engagement' => :'engagement',
|
|
127
130
|
:'conversions' => :'conversions',
|
|
131
|
+
:'all_conversions' => :'allConversions',
|
|
128
132
|
:'cost_per_conversion' => :'costPerConversion',
|
|
129
133
|
:'actions' => :'actions',
|
|
130
134
|
:'action_values' => :'actionValues',
|
|
@@ -176,6 +180,7 @@ module Zernio
|
|
|
176
180
|
:'cpm' => :'Float',
|
|
177
181
|
:'engagement' => :'Integer',
|
|
178
182
|
:'conversions' => :'Float',
|
|
183
|
+
:'all_conversions' => :'Float',
|
|
179
184
|
:'cost_per_conversion' => :'Float',
|
|
180
185
|
:'actions' => :'Hash<String, Integer>',
|
|
181
186
|
:'action_values' => :'Hash<String, Float>',
|
|
@@ -270,6 +275,10 @@ module Zernio
|
|
|
270
275
|
self.conversions = attributes[:'conversions']
|
|
271
276
|
end
|
|
272
277
|
|
|
278
|
+
if attributes.key?(:'all_conversions')
|
|
279
|
+
self.all_conversions = attributes[:'all_conversions']
|
|
280
|
+
end
|
|
281
|
+
|
|
273
282
|
if attributes.key?(:'cost_per_conversion')
|
|
274
283
|
self.cost_per_conversion = attributes[:'cost_per_conversion']
|
|
275
284
|
end
|
|
@@ -410,6 +419,7 @@ module Zernio
|
|
|
410
419
|
cpm == o.cpm &&
|
|
411
420
|
engagement == o.engagement &&
|
|
412
421
|
conversions == o.conversions &&
|
|
422
|
+
all_conversions == o.all_conversions &&
|
|
413
423
|
cost_per_conversion == o.cost_per_conversion &&
|
|
414
424
|
actions == o.actions &&
|
|
415
425
|
action_values == o.action_values &&
|
|
@@ -447,7 +457,7 @@ module Zernio
|
|
|
447
457
|
# Calculates hash code according to all attributes.
|
|
448
458
|
# @return [Integer] Hash code
|
|
449
459
|
def hash
|
|
450
|
-
[spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, cost_per_conversion, actions, action_values, purchase_value, roas, cost_per_action, outbound_clicks, outbound_clicks_ctr, inline_link_clicks, inline_link_click_ctr, unique_clicks, unique_ctr, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at, date].hash
|
|
460
|
+
[spend, impressions, reach, clicks, ctr, cpc, cpm, engagement, conversions, all_conversions, cost_per_conversion, actions, action_values, purchase_value, roas, cost_per_action, outbound_clicks, outbound_clicks_ctr, inline_link_clicks, inline_link_click_ctr, unique_clicks, unique_ctr, video_play_actions, video30_sec_watched_actions, video_thruplay_watched_actions, video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions, video_p100_watched_actions, video_avg_time_watched_actions, cost_per_thruplay, funnel, engagement_breakdown, last_synced_at, date].hash
|
|
451
461
|
end
|
|
452
462
|
|
|
453
463
|
# Builds the object from hash
|
data/lib/zernio-sdk/version.rb
CHANGED
data/openapi.yaml
CHANGED
|
@@ -8175,6 +8175,9 @@ components:
|
|
|
8175
8175
|
cpc: { type: number, description: "Cost per click in native currency." }
|
|
8176
8176
|
cpm: { type: number, description: "Cost per 1000 impressions in native currency." }
|
|
8177
8177
|
conversions: { type: number, description: "Sum of conversion events over the range. Fractional values are normal (attribution splitting + Google modeled conversions). Meta: events matching the campaign optimization goal. Google: tracked conversions. X / LinkedIn: reported website/lead conversions (added 2026-07)." }
|
|
8178
|
+
allConversions:
|
|
8179
|
+
type: number
|
|
8180
|
+
description: 'All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept.'
|
|
8178
8181
|
costPerConversion: { type: number }
|
|
8179
8182
|
actions:
|
|
8180
8183
|
type: object
|
|
@@ -8268,6 +8271,9 @@ components:
|
|
|
8268
8271
|
conversions:
|
|
8269
8272
|
type: number
|
|
8270
8273
|
description: "Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired."
|
|
8274
|
+
allConversions:
|
|
8275
|
+
type: number
|
|
8276
|
+
description: 'All conversions, including actions excluded from the Conversions column (Google metrics.all_conversions). 0 on platforms without the concept.'
|
|
8271
8277
|
costPerConversion:
|
|
8272
8278
|
type: number
|
|
8273
8279
|
description: "Derived spend / conversions in the same currency as spend. 0 when conversions is 0."
|
|
@@ -30092,6 +30098,18 @@ paths:
|
|
|
30092
30098
|
type: "platform_error"
|
|
30093
30099
|
code: "platform_api_error"
|
|
30094
30100
|
platform: "instagram"
|
|
30101
|
+
declinedByMeta:
|
|
30102
|
+
summary: "Meta declined the private reply on this media (subcode 2534066, reply NOT consumed)"
|
|
30103
|
+
value:
|
|
30104
|
+
error: "Instagram declined this private reply (Meta error 2534066). Despite Meta's wording, the token and permissions are fine and the comment ID is valid, so reconnecting the account or retrying this comment will not change the result."
|
|
30105
|
+
type: "platform_error"
|
|
30106
|
+
code: "platform_api_error"
|
|
30107
|
+
platform: "instagram"
|
|
30108
|
+
platformError:
|
|
30109
|
+
code: 200
|
|
30110
|
+
error_subcode: 2534066
|
|
30111
|
+
type: "IGApiException"
|
|
30112
|
+
message: "Please check if access token has enough IG permissions granular scopes for IG private reply. Or, verify if the comment ID is valid"
|
|
30095
30113
|
missingMessage:
|
|
30096
30114
|
summary: Missing message
|
|
30097
30115
|
value:
|
|
@@ -42283,6 +42301,8 @@ paths:
|
|
|
42283
42301
|
than the ingested history return a `202` immediately with the covered part
|
|
42284
42302
|
and `backfillPending: true` while the rest is backfilled in the background;
|
|
42285
42303
|
repeat the request shortly until it returns 200 with full data.
|
|
42304
|
+
|
|
42305
|
+
With adAccountId set to a Google customer id this is the customer-level performance report (clicks, cost, impressions, conversions, all conversions per day).
|
|
42286
42306
|
security:
|
|
42287
42307
|
- bearerAuth: []
|
|
42288
42308
|
parameters:
|
|
@@ -231,7 +231,7 @@ describe 'AdCampaignsApi' do
|
|
|
231
231
|
|
|
232
232
|
# unit tests for get_ads_timeline
|
|
233
233
|
# Get daily account metrics
|
|
234
|
-
# Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data.
|
|
234
|
+
# Returns daily aggregate metrics across all ads in a SocialAccount as a single time series — one row per calendar day in the requested range. Use this for dashboards that draw a daily-spend or daily-conversions chart, instead of calling `/v1/ads/tree` once per day. `accountId` is required. The lookup is sibling-expanded so passing the `metaads` ID also includes ads under the linked `facebook` / `instagram` posting account (and vice-versa) — same convention as `/v1/ads/tree` and `/v1/ads`. Date range defaults to the last 90 days. Capped at 730 days. Ranges older than the ingested history return a `202` immediately with the covered part and `backfillPending: true` while the rest is backfilled in the background; repeat the request shortly until it returns 200 with full data. With adAccountId set to a Google customer id this is the customer-level performance report (clicks, cost, impressions, conversions, all conversions per day).
|
|
235
235
|
# @param account_id Social account ID. Sibling-expanded to its linked posting↔ads pair.
|
|
236
236
|
# @param [Hash] opts the optional parameters
|
|
237
237
|
# @option opts [String] :ad_account_id Optional platform-native ad account ID (e.g. Meta `act_…`, TikTok advertiser ID). Use when the connection wraps multiple platform ad accounts and the chart should show one only. Note: rows ingested before 2026-05-13 don't carry this column; the recurring 7-day re-sync repopulates them naturally.
|
|
@@ -81,6 +81,12 @@ describe Zernio::AdDailyMetrics do
|
|
|
81
81
|
end
|
|
82
82
|
end
|
|
83
83
|
|
|
84
|
+
describe 'test attribute "all_conversions"' do
|
|
85
|
+
it 'should work' do
|
|
86
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
84
90
|
describe 'test attribute "cost_per_conversion"' do
|
|
85
91
|
it 'should work' do
|
|
86
92
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -81,6 +81,12 @@ describe Zernio::AdMetrics do
|
|
|
81
81
|
end
|
|
82
82
|
end
|
|
83
83
|
|
|
84
|
+
describe 'test attribute "all_conversions"' do
|
|
85
|
+
it 'should work' do
|
|
86
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
84
90
|
describe 'test attribute "cost_per_conversion"' do
|
|
85
91
|
it 'should work' do
|
|
86
92
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -87,6 +87,12 @@ describe Zernio::AdsTimelineResponseRowsInner do
|
|
|
87
87
|
end
|
|
88
88
|
end
|
|
89
89
|
|
|
90
|
+
describe 'test attribute "all_conversions"' do
|
|
91
|
+
it 'should work' do
|
|
92
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
|
|
90
96
|
describe 'test attribute "cost_per_conversion"' do
|
|
91
97
|
it 'should work' do
|
|
92
98
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -81,6 +81,12 @@ describe Zernio::CampaignAnalyticsResponseAnalyticsDailyInner do
|
|
|
81
81
|
end
|
|
82
82
|
end
|
|
83
83
|
|
|
84
|
+
describe 'test attribute "all_conversions"' do
|
|
85
|
+
it 'should work' do
|
|
86
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
84
90
|
describe 'test attribute "cost_per_conversion"' do
|
|
85
91
|
it 'should work' do
|
|
86
92
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: late-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.855
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAPI-Generator
|
|
@@ -5614,7 +5614,7 @@ files:
|
|
|
5614
5614
|
- spec/models/you_tube_video_retention_response_retention_curve_inner_spec.rb
|
|
5615
5615
|
- spec/models/you_tube_video_retention_response_spec.rb
|
|
5616
5616
|
- spec/spec_helper.rb
|
|
5617
|
-
- zernio-sdk-0.0.
|
|
5617
|
+
- zernio-sdk-0.0.855.gem
|
|
5618
5618
|
- zernio-sdk.gemspec
|
|
5619
5619
|
homepage: https://openapi-generator.tech
|
|
5620
5620
|
licenses:
|
data/zernio-sdk-0.0.854.gem
DELETED
|
Binary file
|