late-sdk 0.0.606 → 0.0.607
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/CreateStandaloneAdRequest.md +1 -1
- data/docs/LinkedInAdsPlatformDataThoughtLeader.md +1 -1
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +2 -2
- data/lib/zernio-sdk/models/create_standalone_ad_request.rb +1 -1
- data/lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb +1 -1
- data/lib/zernio-sdk/version.rb +1 -1
- data/openapi.yaml +14 -3
- data/spec/api/ad_campaigns_api_spec.rb +1 -1
- data/zernio-sdk-0.0.607.gem +0 -0
- metadata +2 -2
- data/zernio-sdk-0.0.606.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: e8633d89d2f324390e1fc3590083c3a3290b33a2fd48bd0047ba7e3cf2c889fe
|
|
4
|
+
data.tar.gz: 51acd87c6748e55619f3bece577e03a8c8688581cde5c11bdc8c9f884dec646d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2e978f4d32bb218af9d252d5ed070ca4fffcf84ef5f9b3e4867353b496ae9e63352d5ba7f40106cc4a68326c1ceee254dd8fd95a2d602d9ede29ac285d801574
|
|
7
|
+
data.tar.gz: c7e786db0e4f30bc6b71a416f1ebf35bd271ee9516219a2066fe8668e7ec61a60f9ee7c3b51f019b4432c34139c5119dfa443b0802074f9c6e8a7d093f68d8f7
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -241,7 +241,7 @@ end
|
|
|
241
241
|
|
|
242
242
|
Create standalone ad
|
|
243
243
|
|
|
244
|
-
Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and
|
|
244
|
+
Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and an attach shape via adSetId that adds one new ad to an existing ad set, inheriting its budget, targeting, and schedule (Meta, TikTok, and LinkedIn; on LinkedIn adSetId is the existing Campaign id, and the budget, schedule, targeting and bidding fields must be omitted). Per-platform required fields, budget minimums, and video-ad rules are documented on each property below. LinkedIn creates a Single Image or Single Video Ad backed by a Direct Sponsored Content \"dark post\" authored by a Company Page (see `organizationId`); supported goals are engagement, traffic, awareness, and video_views (video ads use the `video` field; video_views requires a video), and traffic ads require `linkUrl`. **Idempotency:** this endpoint is not idempotent at the platform level (a blind retry creates a second campaign/ad set/ad). Send an `Idempotency-Key` header to make retries safe: the first request with a given key creates the ad and we store the response; a retry with the same key replays that exact response (with `Idempotent-Replayed: true`) instead of creating duplicates. Reusing a key with a different body returns 422; a key whose first request is still in flight returns 409 (retry after a short backoff). Keys are scoped to your credential and expire after 24h.
|
|
245
245
|
|
|
246
246
|
### Examples
|
|
247
247
|
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
| **images** | [**CreateStandaloneAdRequestImages**](CreateStandaloneAdRequestImages.md) | | [optional] |
|
|
35
35
|
| **video** | [**CreateStandaloneAdRequestVideo**](CreateStandaloneAdRequestVideo.md) | | [optional] |
|
|
36
36
|
| **creatives** | [**Array<CreateStandaloneAdRequestCreativesInner>**](CreateStandaloneAdRequestCreativesInner.md) | Meta-only. When present, switches to the multi-creative shape: creates 1 campaign + 1 ad set + N ads (one per entry here). Top-level `headline` / `body` / `imageUrl` / `linkUrl` / `callToAction` are ignored in this mode. Mutually exclusive with `adSetId`. | [optional] |
|
|
37
|
-
| **ad_set_id** | **String** |
|
|
37
|
+
| **ad_set_id** | **String** | When present, switches to the attach shape: adds one new ad to this existing ad set without creating a new campaign. Budget, targeting, goal, schedule, AND bid strategy are inherited from the ad set on Meta — passing `bidStrategy` in attach mode returns 400. To change an existing ad set's bid, use `PUT /v1/ads/ad-sets/{adSetId}`. Mutually exclusive with `creatives[]`. The attached ad takes the full single-creative surface: `headline`/`body`/`description`/`callToAction` plus either `imageUrl`/`video` OR `placementAssets` (its own per-placement Feed/Story assets), and `leadGenFormId` when the target is a lead ad set (the parent must be ON_AD — true for ad sets created via goal `lead_generation`; Meta rejects a formless ad there, so pass the form on EVERY attached ad). This is the way to build N full ads sharing one ad set: create the first ad via the normal shape, then attach the rest one call each. Supported on Meta (facebook, instagram), TikTok, and LinkedIn. On TikTok the `adSetId` is the ad group ID; the new ad inherits the ad group's bid + budget + targeting. On LinkedIn the `adSetId` is the LinkedIn Campaign ID (numeric); we attach a new Creative to that Campaign, so the Campaign's `platformSpecificData` bidding, targeting, budget and schedule are inherited (passing those fields returns 400). | [optional] |
|
|
38
38
|
| **existing_campaign_id** | **String** | Meta + LinkedIn. On Meta: add the new ad set under this EXISTING campaign instead of creating a new one (multi-ad-set audience testing). The new ad set's budget is matched to the campaign's mode automatically: for a CBO campaign (campaign-level budget) omit `budgetAmount`/`budgetType` — the campaign owns the budget; for an ABO campaign pass them (they go on the new ad set). On LinkedIn: create a new Campaign (and its Creative) under this EXISTING CampaignGroup. On failure only the entities we authored are cleaned up; the pre-existing parent is left untouched and is never (re)activated. Mutually exclusive with `adSetId` and `creatives[]`. | [optional] |
|
|
39
39
|
| **existing_creative_id** | **String** | Meta only. Reuse an EXISTING ad creative by id instead of building a new one from the copy/media fields (which are then ignored). Combine with `existingCampaignId` to build a multi-ad-set campaign that shares one creative. Mutually exclusive with `creatives[]`, `dynamicCreative`, and `placementAssets`. The creative id used is returned as `creativeId` on the create response. | [optional] |
|
|
40
40
|
| **business_name** | **String** | Google Display only | [optional] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **post_urn** | **String** | LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via \"Copy link to post\" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). | |
|
|
7
|
+
| **post_urn** | **String** | LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via \"Copy link to post\" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). For member (personal profile) posts, LinkedIn's API only accepts video and document posts (ugcPost URNs); text and image member posts (share URNs) are rejected by LinkedIn regardless of sponsorship approval (a LinkedIn API limitation; those can only be sponsored from Campaign Manager). The member must have authorised sponsorship for the ad account's organization. | |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -224,7 +224,7 @@ module Zernio
|
|
|
224
224
|
end
|
|
225
225
|
|
|
226
226
|
# Create standalone ad
|
|
227
|
-
# Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and
|
|
227
|
+
# Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and an attach shape via adSetId that adds one new ad to an existing ad set, inheriting its budget, targeting, and schedule (Meta, TikTok, and LinkedIn; on LinkedIn adSetId is the existing Campaign id, and the budget, schedule, targeting and bidding fields must be omitted). Per-platform required fields, budget minimums, and video-ad rules are documented on each property below. LinkedIn creates a Single Image or Single Video Ad backed by a Direct Sponsored Content \"dark post\" authored by a Company Page (see `organizationId`); supported goals are engagement, traffic, awareness, and video_views (video ads use the `video` field; video_views requires a video), and traffic ads require `linkUrl`. **Idempotency:** this endpoint is not idempotent at the platform level (a blind retry creates a second campaign/ad set/ad). Send an `Idempotency-Key` header to make retries safe: the first request with a given key creates the ad and we store the response; a retry with the same key replays that exact response (with `Idempotent-Replayed: true`) instead of creating duplicates. Reusing a key with a different body returns 422; a key whose first request is still in flight returns 409 (retry after a short backoff). Keys are scoped to your credential and expire after 24h.
|
|
228
228
|
# @param create_standalone_ad_request [CreateStandaloneAdRequest]
|
|
229
229
|
# @param [Hash] opts the optional parameters
|
|
230
230
|
# @option opts [String] :idempotency_key Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
@@ -235,7 +235,7 @@ module Zernio
|
|
|
235
235
|
end
|
|
236
236
|
|
|
237
237
|
# Create standalone ad
|
|
238
|
-
# Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and
|
|
238
|
+
# Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and an attach shape via adSetId that adds one new ad to an existing ad set, inheriting its budget, targeting, and schedule (Meta, TikTok, and LinkedIn; on LinkedIn adSetId is the existing Campaign id, and the budget, schedule, targeting and bidding fields must be omitted). Per-platform required fields, budget minimums, and video-ad rules are documented on each property below. LinkedIn creates a Single Image or Single Video Ad backed by a Direct Sponsored Content \"dark post\" authored by a Company Page (see `organizationId`); supported goals are engagement, traffic, awareness, and video_views (video ads use the `video` field; video_views requires a video), and traffic ads require `linkUrl`. **Idempotency:** this endpoint is not idempotent at the platform level (a blind retry creates a second campaign/ad set/ad). Send an `Idempotency-Key` header to make retries safe: the first request with a given key creates the ad and we store the response; a retry with the same key replays that exact response (with `Idempotent-Replayed: true`) instead of creating duplicates. Reusing a key with a different body returns 422; a key whose first request is still in flight returns 409 (retry after a short backoff). Keys are scoped to your credential and expire after 24h.
|
|
239
239
|
# @param create_standalone_ad_request [CreateStandaloneAdRequest]
|
|
240
240
|
# @param [Hash] opts the optional parameters
|
|
241
241
|
# @option opts [String] :idempotency_key Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
@@ -98,7 +98,7 @@ module Zernio
|
|
|
98
98
|
# Meta-only. When present, switches to the multi-creative shape: creates 1 campaign + 1 ad set + N ads (one per entry here). Top-level `headline` / `body` / `imageUrl` / `linkUrl` / `callToAction` are ignored in this mode. Mutually exclusive with `adSetId`.
|
|
99
99
|
attr_accessor :creatives
|
|
100
100
|
|
|
101
|
-
#
|
|
101
|
+
# When present, switches to the attach shape: adds one new ad to this existing ad set without creating a new campaign. Budget, targeting, goal, schedule, AND bid strategy are inherited from the ad set on Meta — passing `bidStrategy` in attach mode returns 400. To change an existing ad set's bid, use `PUT /v1/ads/ad-sets/{adSetId}`. Mutually exclusive with `creatives[]`. The attached ad takes the full single-creative surface: `headline`/`body`/`description`/`callToAction` plus either `imageUrl`/`video` OR `placementAssets` (its own per-placement Feed/Story assets), and `leadGenFormId` when the target is a lead ad set (the parent must be ON_AD — true for ad sets created via goal `lead_generation`; Meta rejects a formless ad there, so pass the form on EVERY attached ad). This is the way to build N full ads sharing one ad set: create the first ad via the normal shape, then attach the rest one call each. Supported on Meta (facebook, instagram), TikTok, and LinkedIn. On TikTok the `adSetId` is the ad group ID; the new ad inherits the ad group's bid + budget + targeting. On LinkedIn the `adSetId` is the LinkedIn Campaign ID (numeric); we attach a new Creative to that Campaign, so the Campaign's `platformSpecificData` bidding, targeting, budget and schedule are inherited (passing those fields returns 400).
|
|
102
102
|
attr_accessor :ad_set_id
|
|
103
103
|
|
|
104
104
|
# Meta + LinkedIn. On Meta: add the new ad set under this EXISTING campaign instead of creating a new one (multi-ad-set audience testing). The new ad set's budget is matched to the campaign's mode automatically: for a CBO campaign (campaign-level budget) omit `budgetAmount`/`budgetType` — the campaign owns the budget; for an ABO campaign pass them (they go on the new ad set). On LinkedIn: create a new Campaign (and its Creative) under this EXISTING CampaignGroup. On failure only the entities we authored are cleaned up; the pre-existing parent is left untouched and is never (re)activated. Mutually exclusive with `adSetId` and `creatives[]`.
|
|
@@ -16,7 +16,7 @@ require 'time'
|
|
|
16
16
|
module Zernio
|
|
17
17
|
# POST /v1/ads/create only. Thought-leader ad: references someone else's existing LinkedIn share or ugcPost as the creative. Unlike boostPost, which provisions its own CampaignGroup + Campaign around the post, this variant attaches the reference under the campaign /v1/ads/create builds — same shape as every other format, so the caller can pick bidding / targeting / schedule freely. No headline, body, imageUrl or organization are needed; the referenced post carries its own commentary and author. Mutually exclusive with the other creative sources.
|
|
18
18
|
class LinkedInAdsPlatformDataThoughtLeader < ApiModelBase
|
|
19
|
-
# LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via \"Copy link to post\" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id).
|
|
19
|
+
# LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via \"Copy link to post\" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). For member (personal profile) posts, LinkedIn's API only accepts video and document posts (ugcPost URNs); text and image member posts (share URNs) are rejected by LinkedIn regardless of sponsorship approval (a LinkedIn API limitation; those can only be sponsored from Campaign Manager). The member must have authorised sponsorship for the ad account's organization.
|
|
20
20
|
attr_accessor :post_urn
|
|
21
21
|
|
|
22
22
|
# Attribute mapping from ruby-style variable name to JSON key.
|
data/lib/zernio-sdk/version.rb
CHANGED
data/openapi.yaml
CHANGED
|
@@ -4798,6 +4798,13 @@ components:
|
|
|
4798
4798
|
urn:li:ugcPost:N. Get it via "Copy link to post" on the
|
|
4799
4799
|
target LinkedIn post (the URL contains -share- for a share
|
|
4800
4800
|
or -ugcPost- for a ugcPost, then the numeric id).
|
|
4801
|
+
For member (personal profile) posts, LinkedIn's API only
|
|
4802
|
+
accepts video and document posts (ugcPost URNs); text and
|
|
4803
|
+
image member posts (share URNs) are rejected by LinkedIn
|
|
4804
|
+
regardless of sponsorship approval (a LinkedIn API
|
|
4805
|
+
limitation; those can only be sponsored from Campaign
|
|
4806
|
+
Manager). The member must have authorised sponsorship for
|
|
4807
|
+
the ad account's organization.
|
|
4801
4808
|
description: >
|
|
4802
4809
|
LinkedIn-specific options for POST /v1/ads/boost and POST /v1/ads/create:
|
|
4803
4810
|
campaign bidding and delivery controls, plus the LinkedIn-only creative
|
|
@@ -36861,8 +36868,12 @@ paths:
|
|
|
36861
36868
|
Supports three mutually-exclusive request shapes selected by the body,
|
|
36862
36869
|
a legacy single-creative shape (all platforms, default), a Meta-only
|
|
36863
36870
|
multi-creative shape via the creatives array (one ad set with N ads
|
|
36864
|
-
sharing budget and targeting), and
|
|
36865
|
-
|
|
36871
|
+
sharing budget and targeting), and an attach shape via adSetId that
|
|
36872
|
+
adds one new ad to an existing ad set, inheriting its budget,
|
|
36873
|
+
targeting, and schedule (Meta, TikTok, and LinkedIn; on LinkedIn
|
|
36874
|
+
adSetId is the existing Campaign id, and the budget, schedule,
|
|
36875
|
+
targeting and bidding fields must be omitted). Per-platform
|
|
36876
|
+
required fields,
|
|
36866
36877
|
budget minimums, and video-ad rules are documented on each property
|
|
36867
36878
|
below. LinkedIn creates a Single Image or Single Video Ad backed by a
|
|
36868
36879
|
Direct Sponsored Content "dark post" authored by a Company Page (see
|
|
@@ -37023,7 +37034,7 @@ paths:
|
|
|
37023
37034
|
adSetId:
|
|
37024
37035
|
type: string
|
|
37025
37036
|
description: |
|
|
37026
|
-
|
|
37037
|
+
When present, switches to the attach shape: adds
|
|
37027
37038
|
one new ad to this existing ad set without creating a new
|
|
37028
37039
|
campaign. Budget, targeting, goal, schedule, AND bid strategy
|
|
37029
37040
|
are inherited from the ad set on Meta — passing `bidStrategy`
|
|
@@ -70,7 +70,7 @@ describe 'AdCampaignsApi' do
|
|
|
70
70
|
|
|
71
71
|
# unit tests for create_standalone_ad
|
|
72
72
|
# Create standalone ad
|
|
73
|
-
# Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and
|
|
73
|
+
# Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, LinkedIn, and OpenAI Ads (ChatGPT Ads). Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and an attach shape via adSetId that adds one new ad to an existing ad set, inheriting its budget, targeting, and schedule (Meta, TikTok, and LinkedIn; on LinkedIn adSetId is the existing Campaign id, and the budget, schedule, targeting and bidding fields must be omitted). Per-platform required fields, budget minimums, and video-ad rules are documented on each property below. LinkedIn creates a Single Image or Single Video Ad backed by a Direct Sponsored Content \"dark post\" authored by a Company Page (see `organizationId`); supported goals are engagement, traffic, awareness, and video_views (video ads use the `video` field; video_views requires a video), and traffic ads require `linkUrl`. **Idempotency:** this endpoint is not idempotent at the platform level (a blind retry creates a second campaign/ad set/ad). Send an `Idempotency-Key` header to make retries safe: the first request with a given key creates the ad and we store the response; a retry with the same key replays that exact response (with `Idempotent-Replayed: true`) instead of creating duplicates. Reusing a key with a different body returns 422; a key whose first request is still in flight returns 409 (retry after a short backoff). Keys are scoped to your credential and expire after 24h.
|
|
74
74
|
# @param create_standalone_ad_request
|
|
75
75
|
# @param [Hash] opts the optional parameters
|
|
76
76
|
# @option opts [String] :idempotency_key Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
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.607
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAPI-Generator
|
|
@@ -4862,7 +4862,7 @@ files:
|
|
|
4862
4862
|
- spec/models/you_tube_video_retention_response_retention_curve_inner_spec.rb
|
|
4863
4863
|
- spec/models/you_tube_video_retention_response_spec.rb
|
|
4864
4864
|
- spec/spec_helper.rb
|
|
4865
|
-
- zernio-sdk-0.0.
|
|
4865
|
+
- zernio-sdk-0.0.607.gem
|
|
4866
4866
|
- zernio-sdk.gemspec
|
|
4867
4867
|
homepage: https://openapi-generator.tech
|
|
4868
4868
|
licenses:
|
data/zernio-sdk-0.0.606.gem
DELETED
|
Binary file
|