/*
* Zernio API
*
* API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). Request ids: responses carry an X-Request-Id header with the id we log the request under. Quote it when reporting a problem. A valid x-request-id you send is reused as that id.
*
* The version of the OpenAPI document: 1.220.3
* Contact: support@zernio.com
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// ErrorResponseDetails : Additional structured context (e.g. field-level validation errors), for example `privateReplyConsumed` on the private-reply endpoint's 400 when the comment's single reply is already spent. On a Google Ads 429 it carries `quotaExhausted: true`, which marks the failure as Google's own ads quota rather than a Zernio rate limit, so you can keep calling other platforms instead of backing off everywhere. When Google names the scope it also carries `quotaScope`: `DEVELOPER` means the shared developer-token budget (every Google account is affected and there is nothing to change on your side), `ACCOUNT` means your own ad account. A Meta 429 carries neither field. A Zernio Google Ads burst-limit 429 carries `budgetScope` instead, and never `quotaExhausted`: these are Zernio's own limits, applied before the call reaches Google, and both clear within a minute. `account` is the limit of 15 requests per minute per connected Google Ads account; `user` is the ceiling of 120 requests per minute per Zernio user across all their Google Ads accounts. Both are separate axes from `quotaScope`, not the same pool named twice. A failed Meta ad create (`POST /v1/ads/create`, `POST /v1/ads/boost`, `POST /v1/ads/ctwa`) carries `stage`, `adAccountId` and `createdObjects`: where it failed, on which ad account, and every object this request had already created with what cleanup did to it. `left_behind` objects still exist on the ad account (Meta refused the delete, typically on a held account), so delete them yourself or reuse them. `unconfirmedWrite` is set when Meta answered a create with a 5xx or dropped the connection and Zernio could not confirm whether the object exists: check that parent before creating it again. When Meta refuses a write because the ad account's status is ineligible to manage ads (Meta subcode 2490592 or 4841021, on the write itself or on a cleanup delete), any Meta ads write (create, boost, CTWA, campaign / ad set / ad updates and status changes) answers 422 `ad_account_unusable`. The message names the ad account when known, links Meta's fix (https://www.facebook.com/business/help/422289316306981), lists the objects left behind and ends with Meta's original error, which also stays verbatim in `platformError`. Meta often reports the first failure under an unrelated code (e.g. 1487194 on the creative), so branch on `code`, not on `platformError`.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct ErrorResponseDetails {
/// Meta ad create failures only. The step that failed: `media` (image/video download or upload), `campaign`, `adset`, `creative`, `ad` (the ad POST itself, where Meta's code 31 / 3858385 hold and 100 / 1359188 payment rejections land), `activation` (switching the created objects on), or `other` (a read or check before any write).
#[serde(rename = "stage", skip_serializing_if = "Option::is_none")]
pub stage: Option<Stage>,
/// Meta ad create failures only. The ad account the request wrote to (`act_...`).
#[serde(rename = "adAccountId", skip_serializing_if = "Option::is_none")]
pub ad_account_id: Option<String>,
/// Meta ad create failures only. Every object this request created before failing, in creation order. Objects you referenced (an existing campaign, ad set, creative or video) are never listed and never deleted.
#[serde(rename = "createdObjects", skip_serializing_if = "Option::is_none")]
pub created_objects: Option<Vec<models::ErrorResponseDetailsCreatedObjectsInner>>,
#[serde(rename = "unconfirmedWrite", skip_serializing_if = "Option::is_none")]
pub unconfirmed_write: Option<Box<models::ErrorResponseDetailsUnconfirmedWrite>>,
/// Google Ads 429 only. True when the upstream Google Ads quota is spent rather than a Zernio limit.
#[serde(rename = "quotaExhausted", skip_serializing_if = "Option::is_none")]
pub quota_exhausted: Option<bool>,
/// Google Ads 429 only, when Google names the scope. DEVELOPER is the shared developer-token budget; ACCOUNT is your ad account.
#[serde(rename = "quotaScope", skip_serializing_if = "Option::is_none")]
pub quota_scope: Option<QuotaScope>,
/// Zernio Google Ads burst-limit 429 only (never set alongside `quotaExhausted`). `account` is the limit of 15 requests per minute per connected Google Ads account; `user` is the ceiling of 120 requests per minute per Zernio user across all their Google Ads accounts. Both clear within a minute.
#[serde(rename = "budgetScope", skip_serializing_if = "Option::is_none")]
pub budget_scope: Option<BudgetScope>,
}
impl ErrorResponseDetails {
/// Additional structured context (e.g. field-level validation errors), for example `privateReplyConsumed` on the private-reply endpoint's 400 when the comment's single reply is already spent. On a Google Ads 429 it carries `quotaExhausted: true`, which marks the failure as Google's own ads quota rather than a Zernio rate limit, so you can keep calling other platforms instead of backing off everywhere. When Google names the scope it also carries `quotaScope`: `DEVELOPER` means the shared developer-token budget (every Google account is affected and there is nothing to change on your side), `ACCOUNT` means your own ad account. A Meta 429 carries neither field. A Zernio Google Ads burst-limit 429 carries `budgetScope` instead, and never `quotaExhausted`: these are Zernio's own limits, applied before the call reaches Google, and both clear within a minute. `account` is the limit of 15 requests per minute per connected Google Ads account; `user` is the ceiling of 120 requests per minute per Zernio user across all their Google Ads accounts. Both are separate axes from `quotaScope`, not the same pool named twice. A failed Meta ad create (`POST /v1/ads/create`, `POST /v1/ads/boost`, `POST /v1/ads/ctwa`) carries `stage`, `adAccountId` and `createdObjects`: where it failed, on which ad account, and every object this request had already created with what cleanup did to it. `left_behind` objects still exist on the ad account (Meta refused the delete, typically on a held account), so delete them yourself or reuse them. `unconfirmedWrite` is set when Meta answered a create with a 5xx or dropped the connection and Zernio could not confirm whether the object exists: check that parent before creating it again. When Meta refuses a write because the ad account's status is ineligible to manage ads (Meta subcode 2490592 or 4841021, on the write itself or on a cleanup delete), any Meta ads write (create, boost, CTWA, campaign / ad set / ad updates and status changes) answers 422 `ad_account_unusable`. The message names the ad account when known, links Meta's fix (https://www.facebook.com/business/help/422289316306981), lists the objects left behind and ends with Meta's original error, which also stays verbatim in `platformError`. Meta often reports the first failure under an unrelated code (e.g. 1487194 on the creative), so branch on `code`, not on `platformError`.
pub fn new() -> ErrorResponseDetails {
ErrorResponseDetails {
stage: None,
ad_account_id: None,
created_objects: None,
unconfirmed_write: None,
quota_exhausted: None,
quota_scope: None,
budget_scope: None,
}
}
}
/// Meta ad create failures only. The step that failed: `media` (image/video download or upload), `campaign`, `adset`, `creative`, `ad` (the ad POST itself, where Meta's code 31 / 3858385 hold and 100 / 1359188 payment rejections land), `activation` (switching the created objects on), or `other` (a read or check before any write).
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Stage {
#[serde(rename = "media")]
Media,
#[serde(rename = "campaign")]
Campaign,
#[serde(rename = "adset")]
Adset,
#[serde(rename = "creative")]
Creative,
#[serde(rename = "ad")]
Ad,
#[serde(rename = "activation")]
Activation,
#[serde(rename = "other")]
Other,
}
impl Default for Stage {
fn default() -> Stage {
Self::Media
}
}
/// Google Ads 429 only, when Google names the scope. DEVELOPER is the shared developer-token budget; ACCOUNT is your ad account.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum QuotaScope {
#[serde(rename = "DEVELOPER")]
Developer,
#[serde(rename = "ACCOUNT")]
Account,
}
impl Default for QuotaScope {
fn default() -> QuotaScope {
Self::Developer
}
}
/// Zernio Google Ads burst-limit 429 only (never set alongside `quotaExhausted`). `account` is the limit of 15 requests per minute per connected Google Ads account; `user` is the ceiling of 120 requests per minute per Zernio user across all their Google Ads accounts. Both clear within a minute.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum BudgetScope {
#[serde(rename = "account")]
Account,
#[serde(rename = "user")]
User,
}
impl Default for BudgetScope {
fn default() -> BudgetScope {
Self::Account
}
}