zernio-sdk 0.0.553 → 0.0.554

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.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/docs/UpdateAdSetRequest.md +3 -3
  3. data/lib/zernio-sdk/models/update_ad_set_request.rb +3 -3
  4. data/lib/zernio-sdk/version.rb +1 -1
  5. data/openapi.yaml +11 -6
  6. metadata +1485 -1485
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2cb0f3bc4604dcf8646e158f9466a1acf7d5890cd902469ab2f19b2784eb70a4
4
- data.tar.gz: db93724947c7625d852a01d3626dd31c124211a62e604fac3e0ca3562c8b3579
3
+ metadata.gz: 35225cb78ab15337945a45e50751bec5852ae05a0b00b7055bc9a3356677bdeb
4
+ data.tar.gz: 1f504369382afb2282ff0ef5f4578ef7409a6774c0968940dd3cc85fa9db618b
5
5
  SHA512:
6
- metadata.gz: bfb2a29d234e3bbdef08052bbb8ea2bbb741ed240e8f2522da70f6b43a80cc00eef9a51f233294159501f0f06a45b89e03fd4d5ab3339ae00c978315a8163447
7
- data.tar.gz: 9ae4916481ed0b33e538f918273b7eac8748c1192ff6b39242a5472fad038882c90d19125e7d454290ddad03ef39ab9cd255cab570573e4147e23670ae3bcaed
6
+ metadata.gz: 33b3eae679d40391d2800b55eb045aa5b5cc3bdd731dfe8ae2838869627895be5e47f68d519b2a844851ba5d88aad6a3e6f06bacab83d15328aebb2deff509ca
7
+ data.tar.gz: d47d4428807b01ae1b6d7cd5985fbfea7726d30bbcee37599551331cfdf8cbf5595a9192f0b13fde73be96c318f6e02e3f06ffb3bd77522df8b563fd59797e2c
data/docs/UpdateAdSetRequest.md CHANGED
@@ -8,9 +8,9 @@
8
8
  | **budget** | [**UpdateAdSetRequestBudget**](UpdateAdSetRequestBudget.md) | | [optional] |
9
9
  | **status** | **String** | Omit if not toggling delivery state | [optional] |
10
10
  | **name** | **String** | Rename the ad set (Meta only; other platforms return 501). At least one of budget/status/bidStrategy/name is required. | [optional] |
11
- | **bid_strategy** | [**BidStrategy**](BidStrategy.md) | Ad-set-level bid strategy. Overrides the campaign-level default. Supported on Meta (facebook, instagram) and TikTok. On TikTok the Meta-style enum is mapped to bid_type / bid_price / deep_bid_type automatically. Other platforms (linkedin, pinterest, google, twitter) return 501 Not Implemented when bidStrategy is set. | [optional] |
12
- | **bid_amount** | **Float** | Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's smallest-denomination integer. | [optional] |
13
- | **roas_average_floor** | **Float** | Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000. | [optional] |
11
+ | **bid_strategy** | [**BidStrategy**](BidStrategy.md) | Ad-set-level bid strategy. Overrides the campaign-level default. Supported on Meta (facebook, instagram), TikTok, and OpenAI. On TikTok the Meta-style enum is mapped to bid_type / bid_price / deep_bid_type automatically. On OpenAI, LOWEST_COST_WITH_BID_CAP and COST_CAP both map to the ad group's `bidding_config.max_bid_micros` (one knob covers both); LOWEST_COST_WITH_MIN_ROAS is rejected with 422 (OpenAI has no ROAS-based bidding). Other platforms (linkedin, pinterest, google, twitter) return 501 Not Implemented when bidStrategy is set. | [optional] |
12
+ | **bid_amount** | **Float** | Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). | [optional] |
13
+ | **roas_average_floor** | **Float** | Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000. Not supported on OpenAI (422). | [optional] |
14
14
  | **platform_specific_data** | [**UpdateAdSetRequestPlatformSpecificData**](UpdateAdSetRequestPlatformSpecificData.md) | | [optional] |
15
15
 
16
16
  ## Example
data/lib/zernio-sdk/models/update_ad_set_request.rb CHANGED
@@ -25,13 +25,13 @@ module Zernio
25
25
  # Rename the ad set (Meta only; other platforms return 501). At least one of budget/status/bidStrategy/name is required.
26
26
  attr_accessor :name
27
27
 
28
- # Ad-set-level bid strategy. Overrides the campaign-level default. Supported on Meta (facebook, instagram) and TikTok. On TikTok the Meta-style enum is mapped to bid_type / bid_price / deep_bid_type automatically. Other platforms (linkedin, pinterest, google, twitter) return 501 Not Implemented when bidStrategy is set.
28
+ # Ad-set-level bid strategy. Overrides the campaign-level default. Supported on Meta (facebook, instagram), TikTok, and OpenAI. On TikTok the Meta-style enum is mapped to bid_type / bid_price / deep_bid_type automatically. On OpenAI, LOWEST_COST_WITH_BID_CAP and COST_CAP both map to the ad group's `bidding_config.max_bid_micros` (one knob covers both); LOWEST_COST_WITH_MIN_ROAS is rejected with 422 (OpenAI has no ROAS-based bidding). Other platforms (linkedin, pinterest, google, twitter) return 501 Not Implemented when bidStrategy is set.
29
29
  attr_accessor :bid_strategy
30
30
 
31
- # Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's smallest-denomination integer.
31
+ # Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
32
32
  attr_accessor :bid_amount
33
33
 
34
- # Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000.
34
+ # Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000. Not supported on OpenAI (422).
35
35
  attr_accessor :roas_average_floor
36
36
 
37
37
  attr_accessor :platform_specific_data
data/lib/zernio-sdk/version.rb CHANGED
@@ -11,5 +11,5 @@ Generator version: 7.19.0
11
11
  =end
12
12
 
13
13
  module Zernio
14
- VERSION = '0.0.553'
14
+ VERSION = '0.0.554'
15
15
  end
data/openapi.yaml CHANGED
@@ -33921,7 +33921,7 @@ paths:
33921
33921
  put:
33922
33922
  operationId: updateAdSet
33923
33923
  tags: ["Ad Campaigns"]
33924
- x-platforms: ["meta", "tiktok"]
33924
+ x-platforms: ["meta", "tiktok", "openai"]
33925
33925
  summary: Update an ad set
33926
33926
  description: |
33927
33927
  Ad-set-level writes. Use this for ABO budget updates, ad-set-scoped
@@ -33966,21 +33966,25 @@ paths:
33966
33966
  allOf: [{ $ref: '#/components/schemas/BidStrategy' }]
33967
33967
  description: |
33968
33968
  Ad-set-level bid strategy. Overrides the campaign-level default.
33969
- Supported on Meta (facebook, instagram) and TikTok. On TikTok the
33969
+ Supported on Meta (facebook, instagram), TikTok, and OpenAI. On TikTok the
33970
33970
  Meta-style enum is mapped to bid_type / bid_price / deep_bid_type
33971
- automatically. Other platforms (linkedin, pinterest, google, twitter)
33972
- return 501 Not Implemented when bidStrategy is set.
33971
+ automatically. On OpenAI, LOWEST_COST_WITH_BID_CAP and COST_CAP both map to
33972
+ the ad group's `bidding_config.max_bid_micros` (one knob covers both);
33973
+ LOWEST_COST_WITH_MIN_ROAS is rejected with 422 (OpenAI has no ROAS-based
33974
+ bidding). Other platforms (linkedin, pinterest, google, twitter) return 501
33975
+ Not Implemented when bidStrategy is set.
33973
33976
  bidAmount:
33974
33977
  type: number
33975
33978
  description: |
33976
33979
  Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
33977
33980
  bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
33978
- smallest-denomination integer.
33981
+ smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
33979
33982
  roasAverageFloor:
33980
33983
  type: number
33981
33984
  description: |
33982
33985
  Minimum ROAS as a decimal multiplier (2.0 = 2.0x). Required when bidStrategy is
33983
33986
  LOWEST_COST_WITH_MIN_ROAS. Sent to Meta as `bid_constraints.roas_average_floor` × 10000.
33987
+ Not supported on OpenAI (422).
33984
33988
  platformSpecificData:
33985
33989
  type: object
33986
33990
  description: |
@@ -34027,7 +34031,8 @@ paths:
34027
34031
  '401': { $ref: '#/components/responses/Unauthorized' }
34028
34032
  '404': { description: Ad set not found }
34029
34033
  '409': { description: "Campaign is CBO — route to /v1/ads/campaigns/{campaignId} instead" }
34030
- '501': { description: "bidStrategy not supported on the platform (Meta + TikTok only)" }
34034
+ '422': { description: "bidStrategy is LOWEST_COST_WITH_MIN_ROAS on OpenAI (unsupported: no ROAS-based bidding)" }
34035
+ '501': { description: "bidStrategy not supported on the platform (Meta, TikTok, and OpenAI only)" }
34031
34036
 
34032
34037
  /v1/ads/ad-sets/{adSetId}/status:
34033
34038
  put: