AdrollCampaignGroupData

No description

FIELDS
abmType (String!)

Type of ABM campaign. Empty string if this is not an ABM campaign.

actualStatus (JSON)

The effective status of the campaign. Details the reasons why it is not running, if applicable.

actualStatusString (String!)

Minimal string representation of the actual status. One of 'running', 'notRunning' ,'ended', 'paused', 'review', 'draft', 'rejected' or 'deleted'.

advertisable (String!)

EID of the advertisable to which this campaign belongs.

budget (AdrollDecimal!)

The daily budget of the campaign. Note that this can be an approximation, for example when budgetType = "lifetime" it is: budget = budgetGoal / numberOfDays(budgetStartDate, budgetEndDate)

budgetEndDate (AdrollDateTime)

The end date of a lifetime budget.

budgetGoal (AdrollDecimal!)

The budget of the campaign, considered for the whole extent of its budgetType. When budgetType = "lifetime", it will be applied in the period since budgetStartDate until budgetEndDate.

budgetSettingsString (String!)

Serialized budget settings as a string. "budgetType,budgetStartDate,budgetEndDate,budgetGoal"

budgetStartDate (AdrollDateTime)

The start date of a lifetime budget.

budgetType (String!)

The type of budget of the campaign (daily, lifetime...).

channel (String!)

Campaign channel: one of 'email', 'social' or 'web'

cpc (AdrollDecimal!)

The CPC for this campaign.

cpm (AdrollDecimal!)

The CPM for this campaign.

createdDate (AdrollDateTime)

The date this campaign was created.

currency (String!)

ISO-4217 currency code for the given amount.

eid (String!)

EID of the campaign.

endDate (AdrollDateTime)

The day the campaign will end, exclusive.

isIntegrated (Boolean!)

No description

kpiCurrency (String!)

ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.

kpiGoal (AdrollDecimal!)

Goal -for the kpiMetric- that drives the campaign's bid strategy. Null for automatic.

kpiMetric (String!)

Metric being targeted by the campaign's bid strategy.

maxCpm (AdrollDecimal!)

The maximum CPM for this campaign.

name (String!)

The name of this campaign.

newsletterScheduled (AdrollDecimal!)

If this is an Email Newsletter campaign, the number of potential recipients.

newsletterScheduledDate (AdrollDateTime)

If this is an Email Newsletter campaign, the scheduled date for delivery. Only if the delivery is scheduled to happen or of it has already occurred. Omitted if in draft, paused or cancelled.

newsletterSends (AdrollDecimal!)

If this is an Email Newsletter campaign, the number of emails sent.

performanceTargets ([AdrollPerformanceTarget])

PerformanceTargets

playbookEID (String!)

The parent Playbook's EID for the campaign, only if it exists.

playbookName (String!)

The parent Playbook's Name for the campaign, only if it exists.

playbookType (String!)

The parent Playbook's Type for the campaign, only if it exists.

possibleStatusChanges ([String!])

Available status changes for the current campaign. BETA.

processingStatus (String!)

The processing status of the campaign inside the AdRoll. It may have a transient value other than "created" while the campaign is being processed by an internal job.

proxyStrategyEID (String!)

The eid of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.

proxyStrategyName (String!)

The name of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.

proxyStrategyStatus (String!)

The status of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.

source (String!)

The service responsible for the creation of this campaign.

spendLimitUntil (AdrollDateTime)

SpendLimitUntil

spendLimitUntilReason (String!)

SpendLimitUntilReason

startDate (AdrollDateTime)

The day the campaign will start.

status (String!)

The status of the campaign. One of 'running', 'ended', 'paused', 'review', 'draft', 'rejected' or 'deleted'.

tags ([String!])

Internal tags set on creation.

targetingType (String!)

The type of targeting that is used to pick which customers will be reachedt by this campaign.

type (String!)

Type for the campaign. One of "prospecting", "blended"r "retargeting".

updatedDate (AdrollDateTime)

The date this campaign was last updated.

useCase (String!)

No description

REQUIRED BY
AdrollGroupListRow

[BETA] This GraphQL node is currently under development. Avoid its use in production until it has passed some thorough QA.

Row returned for each row in a group by query from 'group.loadByList'.

The available data depends on the arguments to the group by:

  • Entity data is only available when grouping by entity and only for the entity being grouped by.
  • Date is only available when grouping by date.
  • Only columns specified in the group by are available for a particular group.

Groups are returned as a flat list but should be interpret as a hierarchy:

  • There is always one 'root' group that has no entity data. The metrics in this root group are the total aggregate.
  • Children groups have a 'parentId' field that is the 'id' of their parent (e.g. children of the root group will have a parentId of 'root').
  • The final level of groups in the query have the 'leaf' field as true. This is made for easy filtering when only the leaf nodes are required.
  • Each group in the 'groups' parameter for the query creates a level of sub-groups in order. So the first group parameter will correspond to children of the 'root' group, while the last group parameter will correspond to the 'leaf' groups.
AdrollGroupResult

[BETA] This GraphQL node is currently under development. Avoid its use in production until it has passed some thorough QA.

Result for the 'groups.loadBy' field.

____________________________________________________________________________________________________