late-sdk 0.0.614 → 0.0.615
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 +6 -0
- data/docs/AdCreative.md +2 -0
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +9 -0
- data/lib/zernio-sdk/models/ad_creative.rb +12 -1
- data/lib/zernio-sdk/version.rb +1 -1
- data/openapi.yaml +4 -0
- data/spec/api/ad_campaigns_api_spec.rb +3 -0
- data/spec/models/ad_creative_spec.rb +6 -0
- data/zernio-sdk-0.0.615.gem +0 -0
- metadata +2 -2
- data/zernio-sdk-0.0.614.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: 5c34aacb7001c9dc8d3419bfdb30fd2f0cce5e9928b45884572d5e4e1f69b0a8
|
|
4
|
+
data.tar.gz: 107b48d949543db735a3c63a36ecacd1ffded8318d94a7979b68e3f63912115a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0e805df737a3802362d9553ff95439b0f5819fd4b4b94f7a95311d787917f131b6687116dc72f57c58b0206b328222a4f7593eb0230e8e72dd85a79a61558396
|
|
7
|
+
data.tar.gz: d051033d468cc1ea6d0ac25d8933438bec3d89ddfd7204c9a99b491f5b702c1615c00c38be2c8a4f7a2259d8d1c65ceaaedfac39ac3e724418601407c87e1d83
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -834,6 +834,7 @@ opts = {
|
|
|
834
834
|
platform: 'facebook', # String |
|
|
835
835
|
status: Zernio::AdStatus::ACTIVE, # AdStatus | Filter by derived campaign status (post-aggregation)
|
|
836
836
|
ad_account_id: 'ad_account_id_example', # String | Platform ad account ID
|
|
837
|
+
page_id: 'page_id_example', # String | Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns.
|
|
837
838
|
account_id: 'account_id_example', # String | Social account ID
|
|
838
839
|
profile_id: 'profile_id_example', # String | Profile ID
|
|
839
840
|
campaign_id: 'campaign_id_example', # String | Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
|
|
@@ -881,6 +882,7 @@ end
|
|
|
881
882
|
| **platform** | **String** | | [optional] |
|
|
882
883
|
| **status** | [**AdStatus**](.md) | Filter by derived campaign status (post-aggregation) | [optional] |
|
|
883
884
|
| **ad_account_id** | **String** | Platform ad account ID | [optional] |
|
|
885
|
+
| **page_id** | **String** | Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns. | [optional] |
|
|
884
886
|
| **account_id** | **String** | Social account ID | [optional] |
|
|
885
887
|
| **profile_id** | **String** | Profile ID | [optional] |
|
|
886
888
|
| **campaign_id** | **String** | Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads. | [optional] |
|
|
@@ -1010,6 +1012,7 @@ opts = {
|
|
|
1010
1012
|
platform: 'facebook', # String |
|
|
1011
1013
|
status: Zernio::AdStatus::ACTIVE, # AdStatus | Filter by derived campaign status (post-aggregation)
|
|
1012
1014
|
ad_account_id: 'ad_account_id_example', # String | Platform ad account ID (e.g. act_123 for Meta)
|
|
1015
|
+
page_id: 'page_id_example', # String | Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree.
|
|
1013
1016
|
account_id: 'account_id_example', # String | Social account ID
|
|
1014
1017
|
profile_id: 'profile_id_example', # String | Profile ID
|
|
1015
1018
|
from_date: Date.parse('2013-10-20'), # Date | Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
@@ -1053,6 +1056,7 @@ end
|
|
|
1053
1056
|
| **platform** | **String** | | [optional] |
|
|
1054
1057
|
| **status** | [**AdStatus**](.md) | Filter by derived campaign status (post-aggregation) | [optional] |
|
|
1055
1058
|
| **ad_account_id** | **String** | Platform ad account ID (e.g. act_123 for Meta) | [optional] |
|
|
1059
|
+
| **page_id** | **String** | Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree. | [optional] |
|
|
1056
1060
|
| **account_id** | **String** | Social account ID | [optional] |
|
|
1057
1061
|
| **profile_id** | **String** | Profile ID | [optional] |
|
|
1058
1062
|
| **from_date** | **Date** | Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted. | [optional] |
|
|
@@ -1191,6 +1195,7 @@ opts = {
|
|
|
1191
1195
|
platform: 'facebook', # String |
|
|
1192
1196
|
account_id: 'account_id_example', # String | Social account ID
|
|
1193
1197
|
ad_account_id: 'ad_account_id_example', # String | Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
1198
|
+
page_id: 'page_id_example', # String | Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
1194
1199
|
profile_id: 'profile_id_example', # String | Profile ID
|
|
1195
1200
|
campaign_id: 'campaign_id_example', # String | Platform campaign ID (filter ads within a campaign)
|
|
1196
1201
|
platform_ad_id: 'platform_ad_id_example', # String | Meta ad ID. Returns the ad with this platform-side ad ID.
|
|
@@ -1238,6 +1243,7 @@ end
|
|
|
1238
1243
|
| **platform** | **String** | | [optional] |
|
|
1239
1244
|
| **account_id** | **String** | Social account ID | [optional] |
|
|
1240
1245
|
| **ad_account_id** | **String** | Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree. | [optional] |
|
|
1246
|
+
| **page_id** | **String** | Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree. | [optional] |
|
|
1241
1247
|
| **profile_id** | **String** | Profile ID | [optional] |
|
|
1242
1248
|
| **campaign_id** | **String** | Platform campaign ID (filter ads within a campaign) | [optional] |
|
|
1243
1249
|
| **platform_ad_id** | **String** | Meta ad ID. Returns the ad with this platform-side ad ID. | [optional] |
|
data/docs/AdCreative.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **object_type** | **String** | Meta creative object_type (e.g. SHARE, VIDEO, PRIVACY_CHECK_FAIL, POST_DELETED). Use this to render state-aware previews — when Meta moderation strips image/video fields, only thumbnailUrl at 64x64 is available. | [optional] |
|
|
12
12
|
| **object_story_id** | **String** | Meta creative `object_story_id` (the SHARE reference). Frequently absent — Meta omits it for SHARE creatives. Use effectiveObjectStoryId instead. | [optional] |
|
|
13
13
|
| **effective_object_story_id** | **String** | Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it. | [optional] |
|
|
14
|
+
| **page_id** | **String** | Facebook Page backing the creative (Meta only). What the `pageId` filter on /v1/ads, /v1/ads/campaigns and /v1/ads/tree matches against. Absent for non-Meta ads and rare Meta creatives with no page signal. | [optional] |
|
|
14
15
|
| **effective_instagram_media_id** | **String** | Meta `effective_instagram_media_id` — the Instagram media ID of the boosted post the ad's engagement lives on. Pass to GET /v1/ads?effectiveInstagramMediaId= to map a Business-Manager-visible IG post back to this ad. | [optional] |
|
|
15
16
|
| **instagram_user_id** | **String** | Meta `instagram_user_id` — the Instagram-scoped business ID that owns the boosted media. | [optional] |
|
|
16
17
|
| **instagram_permalink_url** | **String** | Meta `instagram_permalink_url` — public Instagram post URL of the boosted media. | [optional] |
|
|
@@ -36,6 +37,7 @@ instance = Zernio::AdCreative.new(
|
|
|
36
37
|
object_type: null,
|
|
37
38
|
object_story_id: null,
|
|
38
39
|
effective_object_story_id: null,
|
|
40
|
+
page_id: null,
|
|
39
41
|
effective_instagram_media_id: null,
|
|
40
42
|
instagram_user_id: null,
|
|
41
43
|
instagram_permalink_url: null,
|
|
@@ -798,6 +798,7 @@ module Zernio
|
|
|
798
798
|
# @option opts [String] :platform
|
|
799
799
|
# @option opts [AdStatus] :status Filter by derived campaign status (post-aggregation)
|
|
800
800
|
# @option opts [String] :ad_account_id Platform ad account ID
|
|
801
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns.
|
|
801
802
|
# @option opts [String] :account_id Social account ID
|
|
802
803
|
# @option opts [String] :profile_id Profile ID
|
|
803
804
|
# @option opts [String] :campaign_id Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
|
|
@@ -821,6 +822,7 @@ module Zernio
|
|
|
821
822
|
# @option opts [String] :platform
|
|
822
823
|
# @option opts [AdStatus] :status Filter by derived campaign status (post-aggregation)
|
|
823
824
|
# @option opts [String] :ad_account_id Platform ad account ID
|
|
825
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns.
|
|
824
826
|
# @option opts [String] :account_id Social account ID
|
|
825
827
|
# @option opts [String] :profile_id Profile ID
|
|
826
828
|
# @option opts [String] :campaign_id Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
|
|
@@ -877,6 +879,7 @@ module Zernio
|
|
|
877
879
|
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
878
880
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
879
881
|
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
882
|
+
query_params[:'pageId'] = opts[:'page_id'] if !opts[:'page_id'].nil?
|
|
880
883
|
query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
881
884
|
query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
|
|
882
885
|
query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
|
|
@@ -1009,6 +1012,7 @@ module Zernio
|
|
|
1009
1012
|
# @option opts [String] :platform
|
|
1010
1013
|
# @option opts [AdStatus] :status Filter by derived campaign status (post-aggregation)
|
|
1011
1014
|
# @option opts [String] :ad_account_id Platform ad account ID (e.g. act_123 for Meta)
|
|
1015
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree.
|
|
1012
1016
|
# @option opts [String] :account_id Social account ID
|
|
1013
1017
|
# @option opts [String] :profile_id Profile ID
|
|
1014
1018
|
# @option opts [Date] :from_date Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
@@ -1028,6 +1032,7 @@ module Zernio
|
|
|
1028
1032
|
# @option opts [String] :platform
|
|
1029
1033
|
# @option opts [AdStatus] :status Filter by derived campaign status (post-aggregation)
|
|
1030
1034
|
# @option opts [String] :ad_account_id Platform ad account ID (e.g. act_123 for Meta)
|
|
1035
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree.
|
|
1031
1036
|
# @option opts [String] :account_id Social account ID
|
|
1032
1037
|
# @option opts [String] :profile_id Profile ID
|
|
1033
1038
|
# @option opts [Date] :from_date Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
@@ -1068,6 +1073,7 @@ module Zernio
|
|
|
1068
1073
|
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
1069
1074
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
1070
1075
|
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1076
|
+
query_params[:'pageId'] = opts[:'page_id'] if !opts[:'page_id'].nil?
|
|
1071
1077
|
query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
1072
1078
|
query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
|
|
1073
1079
|
query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
|
|
@@ -1231,6 +1237,7 @@ module Zernio
|
|
|
1231
1237
|
# @option opts [String] :platform
|
|
1232
1238
|
# @option opts [String] :account_id Social account ID
|
|
1233
1239
|
# @option opts [String] :ad_account_id Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
1240
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
1234
1241
|
# @option opts [String] :profile_id Profile ID
|
|
1235
1242
|
# @option opts [String] :campaign_id Platform campaign ID (filter ads within a campaign)
|
|
1236
1243
|
# @option opts [String] :platform_ad_id Meta ad ID. Returns the ad with this platform-side ad ID.
|
|
@@ -1254,6 +1261,7 @@ module Zernio
|
|
|
1254
1261
|
# @option opts [String] :platform
|
|
1255
1262
|
# @option opts [String] :account_id Social account ID
|
|
1256
1263
|
# @option opts [String] :ad_account_id Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
1264
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
1257
1265
|
# @option opts [String] :profile_id Profile ID
|
|
1258
1266
|
# @option opts [String] :campaign_id Platform campaign ID (filter ads within a campaign)
|
|
1259
1267
|
# @option opts [String] :platform_ad_id Meta ad ID. Returns the ad with this platform-side ad ID.
|
|
@@ -1298,6 +1306,7 @@ module Zernio
|
|
|
1298
1306
|
query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
|
|
1299
1307
|
query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
1300
1308
|
query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
|
|
1309
|
+
query_params[:'pageId'] = opts[:'page_id'] if !opts[:'page_id'].nil?
|
|
1301
1310
|
query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
|
|
1302
1311
|
query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
|
|
1303
1312
|
query_params[:'platformAdId'] = opts[:'platform_ad_id'] if !opts[:'platform_ad_id'].nil?
|
|
@@ -37,6 +37,9 @@ module Zernio
|
|
|
37
37
|
# Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it.
|
|
38
38
|
attr_accessor :effective_object_story_id
|
|
39
39
|
|
|
40
|
+
# Facebook Page backing the creative (Meta only). What the `pageId` filter on /v1/ads, /v1/ads/campaigns and /v1/ads/tree matches against. Absent for non-Meta ads and rare Meta creatives with no page signal.
|
|
41
|
+
attr_accessor :page_id
|
|
42
|
+
|
|
40
43
|
# Meta `effective_instagram_media_id` — the Instagram media ID of the boosted post the ad's engagement lives on. Pass to GET /v1/ads?effectiveInstagramMediaId= to map a Business-Manager-visible IG post back to this ad.
|
|
41
44
|
attr_accessor :effective_instagram_media_id
|
|
42
45
|
|
|
@@ -77,6 +80,7 @@ module Zernio
|
|
|
77
80
|
:'object_type' => :'objectType',
|
|
78
81
|
:'object_story_id' => :'objectStoryId',
|
|
79
82
|
:'effective_object_story_id' => :'effectiveObjectStoryId',
|
|
83
|
+
:'page_id' => :'pageId',
|
|
80
84
|
:'effective_instagram_media_id' => :'effectiveInstagramMediaId',
|
|
81
85
|
:'instagram_user_id' => :'instagramUserId',
|
|
82
86
|
:'instagram_permalink_url' => :'instagramPermalinkUrl',
|
|
@@ -111,6 +115,7 @@ module Zernio
|
|
|
111
115
|
:'object_type' => :'String',
|
|
112
116
|
:'object_story_id' => :'String',
|
|
113
117
|
:'effective_object_story_id' => :'String',
|
|
118
|
+
:'page_id' => :'String',
|
|
114
119
|
:'effective_instagram_media_id' => :'String',
|
|
115
120
|
:'instagram_user_id' => :'String',
|
|
116
121
|
:'instagram_permalink_url' => :'String',
|
|
@@ -132,6 +137,7 @@ module Zernio
|
|
|
132
137
|
:'video_url',
|
|
133
138
|
:'object_story_id',
|
|
134
139
|
:'effective_object_story_id',
|
|
140
|
+
:'page_id',
|
|
135
141
|
:'effective_instagram_media_id',
|
|
136
142
|
:'instagram_user_id',
|
|
137
143
|
:'instagram_permalink_url',
|
|
@@ -182,6 +188,10 @@ module Zernio
|
|
|
182
188
|
self.effective_object_story_id = attributes[:'effective_object_story_id']
|
|
183
189
|
end
|
|
184
190
|
|
|
191
|
+
if attributes.key?(:'page_id')
|
|
192
|
+
self.page_id = attributes[:'page_id']
|
|
193
|
+
end
|
|
194
|
+
|
|
185
195
|
if attributes.key?(:'effective_instagram_media_id')
|
|
186
196
|
self.effective_instagram_media_id = attributes[:'effective_instagram_media_id']
|
|
187
197
|
end
|
|
@@ -256,6 +266,7 @@ module Zernio
|
|
|
256
266
|
object_type == o.object_type &&
|
|
257
267
|
object_story_id == o.object_story_id &&
|
|
258
268
|
effective_object_story_id == o.effective_object_story_id &&
|
|
269
|
+
page_id == o.page_id &&
|
|
259
270
|
effective_instagram_media_id == o.effective_instagram_media_id &&
|
|
260
271
|
instagram_user_id == o.instagram_user_id &&
|
|
261
272
|
instagram_permalink_url == o.instagram_permalink_url &&
|
|
@@ -278,7 +289,7 @@ module Zernio
|
|
|
278
289
|
# Calculates hash code according to all attributes.
|
|
279
290
|
# @return [Integer] Hash code
|
|
280
291
|
def hash
|
|
281
|
-
[thumbnail_url, image_url, video_id, video_url, object_type, object_story_id, effective_object_story_id, effective_instagram_media_id, instagram_user_id, instagram_permalink_url, media_urls, body, google_headline, google_description, link_url, pinterest_image_url, pinterest_title, pinterest_description].hash
|
|
292
|
+
[thumbnail_url, image_url, video_id, video_url, object_type, object_story_id, effective_object_story_id, page_id, effective_instagram_media_id, instagram_user_id, instagram_permalink_url, media_urls, body, google_headline, google_description, link_url, pinterest_image_url, pinterest_title, pinterest_description].hash
|
|
282
293
|
end
|
|
283
294
|
|
|
284
295
|
# Builds the object from hash
|
data/lib/zernio-sdk/version.rb
CHANGED
data/openapi.yaml
CHANGED
|
@@ -6881,6 +6881,7 @@ components:
|
|
|
6881
6881
|
objectType: { type: string, description: "Meta creative object_type (e.g. SHARE, VIDEO, PRIVACY_CHECK_FAIL, POST_DELETED). Use this to render state-aware previews — when Meta moderation strips image/video fields, only thumbnailUrl at 64x64 is available." }
|
|
6882
6882
|
objectStoryId: { type: [string, "null"], description: "Meta creative `object_story_id` (the SHARE reference). Frequently absent — Meta omits it for SHARE creatives. Use effectiveObjectStoryId instead." }
|
|
6883
6883
|
effectiveObjectStoryId: { type: [string, "null"], description: "Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it." }
|
|
6884
|
+
pageId: { type: [string, "null"], description: "Facebook Page backing the creative (Meta only). What the `pageId` filter on /v1/ads, /v1/ads/campaigns and /v1/ads/tree matches against. Absent for non-Meta ads and rare Meta creatives with no page signal." }
|
|
6884
6885
|
effectiveInstagramMediaId: { type: [string, "null"], description: "Meta `effective_instagram_media_id` — the Instagram media ID of the boosted post the ad's engagement lives on. Pass to GET /v1/ads?effectiveInstagramMediaId= to map a Business-Manager-visible IG post back to this ad." }
|
|
6885
6886
|
instagramUserId: { type: [string, "null"], description: "Meta `instagram_user_id` — the Instagram-scoped business ID that owns the boosted media." }
|
|
6886
6887
|
instagramPermalinkUrl: { type: [string, "null"], description: "Meta `instagram_permalink_url` — public Instagram post URL of the boosted media." }
|
|
@@ -34403,6 +34404,7 @@ paths:
|
|
|
34403
34404
|
- { name: platform, in: query, schema: { type: string, enum: [facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai] } }
|
|
34404
34405
|
- { name: accountId, in: query, schema: { type: string }, description: Social account ID }
|
|
34405
34406
|
- { name: adAccountId, in: query, schema: { type: string }, description: "Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree." }
|
|
34407
|
+
- { name: pageId, in: query, schema: { type: string }, description: "Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree." }
|
|
34406
34408
|
- { name: profileId, in: query, schema: { type: string }, description: Profile ID }
|
|
34407
34409
|
- { name: campaignId, in: query, schema: { type: string }, description: Platform campaign ID (filter ads within a campaign) }
|
|
34408
34410
|
- { name: platformAdId, in: query, schema: { type: string }, description: "Meta ad ID. Returns the ad with this platform-side ad ID." }
|
|
@@ -34517,6 +34519,7 @@ paths:
|
|
|
34517
34519
|
- { name: platform, in: query, schema: { type: string, enum: [facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai] } }
|
|
34518
34520
|
- { name: status, in: query, schema: { $ref: '#/components/schemas/AdStatus' }, description: Filter by derived campaign status (post-aggregation) }
|
|
34519
34521
|
- { name: adAccountId, in: query, schema: { type: string }, description: Platform ad account ID (e.g. act_123 for Meta) }
|
|
34522
|
+
- { name: pageId, in: query, schema: { type: string }, description: "Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree." }
|
|
34520
34523
|
- { name: accountId, in: query, schema: { type: string }, description: Social account ID }
|
|
34521
34524
|
- { name: profileId, in: query, schema: { type: string }, description: Profile ID }
|
|
34522
34525
|
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted." }
|
|
@@ -35186,6 +35189,7 @@ paths:
|
|
|
35186
35189
|
- { name: platform, in: query, schema: { type: string, enum: [facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai] } }
|
|
35187
35190
|
- { name: status, in: query, schema: { $ref: '#/components/schemas/AdStatus' }, description: Filter by derived campaign status (post-aggregation) }
|
|
35188
35191
|
- { name: adAccountId, in: query, schema: { type: string }, description: Platform ad account ID }
|
|
35192
|
+
- { name: pageId, in: query, schema: { type: string }, description: "Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns." }
|
|
35189
35193
|
- { name: accountId, in: query, schema: { type: string }, description: Social account ID }
|
|
35190
35194
|
- { name: profileId, in: query, schema: { type: string }, description: Profile ID }
|
|
35191
35195
|
- { name: campaignId, in: query, schema: { type: string }, description: "Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads." }
|
|
@@ -181,6 +181,7 @@ describe 'AdCampaignsApi' do
|
|
|
181
181
|
# @option opts [String] :platform
|
|
182
182
|
# @option opts [AdStatus] :status Filter by derived campaign status (post-aggregation)
|
|
183
183
|
# @option opts [String] :ad_account_id Platform ad account ID
|
|
184
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Prunes the tree to ads whose creative is backed by this Page — campaigns and ad sets with no ad on the Page drop out, and rolled-up metrics cover only the Page's ads. Mirrors the same filter on /v1/ads and /v1/ads/campaigns.
|
|
184
185
|
# @option opts [String] :account_id Social account ID
|
|
185
186
|
# @option opts [String] :profile_id Profile ID
|
|
186
187
|
# @option opts [String] :campaign_id Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
|
|
@@ -222,6 +223,7 @@ describe 'AdCampaignsApi' do
|
|
|
222
223
|
# @option opts [String] :platform
|
|
223
224
|
# @option opts [AdStatus] :status Filter by derived campaign status (post-aggregation)
|
|
224
225
|
# @option opts [String] :ad_account_id Platform ad account ID (e.g. act_123 for Meta)
|
|
226
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree.
|
|
225
227
|
# @option opts [String] :account_id Social account ID
|
|
226
228
|
# @option opts [String] :profile_id Profile ID
|
|
227
229
|
# @option opts [Date] :from_date Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
@@ -266,6 +268,7 @@ describe 'AdCampaignsApi' do
|
|
|
266
268
|
# @option opts [String] :platform
|
|
267
269
|
# @option opts [String] :account_id Social account ID
|
|
268
270
|
# @option opts [String] :ad_account_id Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
271
|
+
# @option opts [String] :page_id Meta only: Facebook Page ID. Returns only ads whose creative is backed by this Page (a Meta ad account serves ads for every Page in the Business Manager). Matches each ad's `creative.pageId`; ads with no page signal (rare IG-only creatives) never match. Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
|
|
269
272
|
# @option opts [String] :profile_id Profile ID
|
|
270
273
|
# @option opts [String] :campaign_id Platform campaign ID (filter ads within a campaign)
|
|
271
274
|
# @option opts [String] :platform_ad_id Meta ad ID. Returns the ad with this platform-side ad ID.
|
|
@@ -69,6 +69,12 @@ describe Zernio::AdCreative do
|
|
|
69
69
|
end
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
describe 'test attribute "page_id"' do
|
|
73
|
+
it 'should work' do
|
|
74
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
|
|
72
78
|
describe 'test attribute "effective_instagram_media_id"' do
|
|
73
79
|
it 'should work' do
|
|
74
80
|
# 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.615
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAPI-Generator
|
|
@@ -4886,7 +4886,7 @@ files:
|
|
|
4886
4886
|
- spec/models/you_tube_video_retention_response_retention_curve_inner_spec.rb
|
|
4887
4887
|
- spec/models/you_tube_video_retention_response_spec.rb
|
|
4888
4888
|
- spec/spec_helper.rb
|
|
4889
|
-
- zernio-sdk-0.0.
|
|
4889
|
+
- zernio-sdk-0.0.615.gem
|
|
4890
4890
|
- zernio-sdk.gemspec
|
|
4891
4891
|
homepage: https://openapi-generator.tech
|
|
4892
4892
|
licenses:
|
data/zernio-sdk-0.0.614.gem
DELETED
|
Binary file
|