mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
The projection these were generated from was a month old and predated the compute migration, so every one of them described /v1/visor — which the API serves at zero paths now. That is why a hand-written console client and a generated one had drifted the same way at the same time. No /v1/visor path survives here. The word still appears as a source-plane value and inside gvisor and supervisor, which are not this rename.
185 lines
6.0 KiB
C++
185 lines
6.0 KiB
C++
/**
|
|
* Hanzo Cloud API
|
|
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
|
|
*
|
|
* The version of the OpenAPI document: v1
|
|
*
|
|
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
/*
|
|
* AdCampaign.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_AdCampaign_H_
|
|
#define HANZO_MODEL_AdCampaign_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class AdCampaign
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
AdCampaign();
|
|
virtual ~AdCampaign();
|
|
|
|
/////////////////////////////////////////////
|
|
/// ModelBase overrides
|
|
|
|
void validate() override;
|
|
|
|
web::json::value toJson() const override;
|
|
bool fromJson(const web::json::value& json) override;
|
|
|
|
void toMultipart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) const override;
|
|
bool fromMultiPart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) override;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// AdCampaign members
|
|
|
|
|
|
/// <summary>
|
|
/// Account is the provider ad-account the campaign runs under, in Meta's act_<id> form. Empty until the org supplies one or a launch resolves it.
|
|
/// </summary>
|
|
utility::string_t getAccount() const;
|
|
bool accountIsSet() const;
|
|
void unsetAccount();
|
|
void setAccount(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Budget is the campaign's authorized spend in MINOR units (cents). Negative clamps to 0. It is the org's stored plan: a Meta launch creates the campaign object only, and the delivering budget lives on the ad set.
|
|
/// </summary>
|
|
int64_t getBudget() const;
|
|
bool budgetIsSet() const;
|
|
void unsetBudget();
|
|
void setBudget(int64_t value);
|
|
|
|
/// <summary>
|
|
/// CreatedAt is when the campaign was first stored, in unix seconds. It never changes, including across a full-replace update.
|
|
/// </summary>
|
|
int64_t getCreatedAt() const;
|
|
bool createdAtIsSet() const;
|
|
void unsetCreatedAt();
|
|
void setCreatedAt(int64_t value);
|
|
|
|
/// <summary>
|
|
/// ExternalID is the ad network's own campaign id, written by a successful launch and by nothing else — an update never touches it. Empty means this campaign has never reached its network.
|
|
/// </summary>
|
|
utility::string_t getExternalId() const;
|
|
bool externalIdIsSet() const;
|
|
void unsetExternalId();
|
|
void setExternalId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// ID is the campaign's server-minted handle, \"camp_\" + 32 hex. A create body cannot choose it, and it is the id every other route addresses.
|
|
/// </summary>
|
|
utility::string_t getId() const;
|
|
bool idIsSet() const;
|
|
void unsetId();
|
|
void setId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Name is the campaign's display label, and the name Meta creates the campaign object under at launch. Required; trimmed and bounded to 1024 bytes.
|
|
/// </summary>
|
|
utility::string_t getName() const;
|
|
bool nameIsSet() const;
|
|
void unsetName();
|
|
void setName(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Objective is the campaign goal spelled as the provider names it (\"conversions\", \"OUTCOME_TRAFFIC\"), passed through to the network verbatim at launch — Meta defaults an empty one to OUTCOME_TRAFFIC. Free text, bounded to 1024 bytes; no vocabulary is enforced here.
|
|
/// </summary>
|
|
utility::string_t getObjective() const;
|
|
bool objectiveIsSet() const;
|
|
void unsetObjective();
|
|
void setObjective(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Platform is the ad network: meta, google, tiktok or x, and nothing else — a write naming another is 400. Empty stores as meta. Only meta executes today; launching any of the other three is 501.
|
|
/// </summary>
|
|
utility::string_t getPlatform() const;
|
|
bool platformIsSet() const;
|
|
void unsetPlatform();
|
|
void setPlatform(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Spend is spend-to-date in MINOR units (cents), as last written through create or update. Negative clamps to 0. It is NOT read back from the network — that is a separate insights call — so 0 means nothing was recorded here, not that nothing was spent.
|
|
/// </summary>
|
|
int64_t getSpend() const;
|
|
bool spendIsSet() const;
|
|
void unsetSpend();
|
|
void setSpend(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Status is the lifecycle: draft, active, paused or completed, and nothing else — a write naming another is 400. Empty stores as draft; a successful launch sets active. It records what this deployment did, not what the ad network currently reports.
|
|
/// </summary>
|
|
utility::string_t getStatus() const;
|
|
bool statusIsSet() const;
|
|
void unsetStatus();
|
|
void setStatus(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// UpdatedAt is when the row was last written, in unix seconds — set by create, update and launch. Listings are ordered by it, newest first.
|
|
/// </summary>
|
|
int64_t getUpdatedAt() const;
|
|
bool updatedAtIsSet() const;
|
|
void unsetUpdatedAt();
|
|
void setUpdatedAt(int64_t value);
|
|
|
|
|
|
protected:
|
|
utility::string_t m_Account;
|
|
bool m_AccountIsSet;
|
|
|
|
int64_t m_Budget;
|
|
bool m_BudgetIsSet;
|
|
|
|
int64_t m_CreatedAt;
|
|
bool m_CreatedAtIsSet;
|
|
|
|
utility::string_t m_ExternalId;
|
|
bool m_ExternalIdIsSet;
|
|
|
|
utility::string_t m_Id;
|
|
bool m_IdIsSet;
|
|
|
|
utility::string_t m_Name;
|
|
bool m_NameIsSet;
|
|
|
|
utility::string_t m_Objective;
|
|
bool m_ObjectiveIsSet;
|
|
|
|
utility::string_t m_Platform;
|
|
bool m_PlatformIsSet;
|
|
|
|
int64_t m_Spend;
|
|
bool m_SpendIsSet;
|
|
|
|
utility::string_t m_Status;
|
|
bool m_StatusIsSet;
|
|
|
|
int64_t m_UpdatedAt;
|
|
bool m_UpdatedAtIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_AdCampaign_H_ */
|