MarketingCampaignBudgetTaoslByCampaignGuid |
Read budgetRetrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget.Budget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer
Catalog: CampaignsPublicApi3
Schema: Budget
Label: {res:itgen_hubspot_marketingcampaignbudgettaoslbycampaignguid_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function MarketingCampaignBudgetTaoslByCampaignGuid. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
campaignGuid |
string |
☑ |
|
Unique identifier for the campaign, formatted as a UUID. |
Columns of Table Function
The columns of the table function MarketingCampaignBudgetTaoslByCampaignGuid are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
budgetTotal |
decimal |
{res:itgen_hubspot_budgettotal} |
☐ |
|
currencyCode |
string |
Currency Code |
☐ |
|
remainingBudget |
decimal |
{res:itgen_hubspot_remainingbudget} |
☐ |
|
spendTotal |
decimal |
{res:itgen_hubspot_spendtotal} |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180