AdrollAdGroupData

No description

FIELDS
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'.

adFormat (String!)

Format string. i.e. '300 wide x 250 high'.

adFormatID (Int!)

The id of the corresponding ad format in the AdRoll system.

adFormatName (String!)

Format string. i.e. '300x250'.

adrollEID (String!)

The adroll EID for prospecting ads.

advertisable (String!)

The EID of the advertisable to which this ad belongs.

body (String!)

For Facebook ads, the text to be displayed as the ad's body.

callToAction (String!)

Facebook call to action constant.

campaignType (String!)

The type for the campaign this ad belongs to. This is only available when loading the ads through a campaign.

channel (String!)

The channel for the campaign this ad belongs to. This is only available when loading the ads through a campaign.

createdDate (AdrollDateTime)

The date this ad was created.

destinationURL (String!)

The URL that the browser will navigate to when this ad is clicked.

disapprovalReason (String!)

The reason why an Ad has been rejected on the inventory network NextRoll has sync'ed it to (ex: Facebook)

eid (String!)

EID of the ad.

facebookPermalink (String!)

Facebook permalink if applicable.

hasEdits (Boolean!)

Whether or not this ad has been edited such that another ad has it's original ad parameter set to this ad's EID.

hasFutureCampaigns (Boolean!)

Whether or not this ad has the possibility of serving based on the adgroups and campaigns in which it inhabits.

hasPendingEdits (Boolean!)

Whether or not this ad has edits that must be reviewed by an AdRoll administrator.

headline (String!)

For Facebook ads, the text to be displayed as the ad's headline.

height (Int!)

The height in pixels of this ad's creative.

inAdgroupEID (String!)

The AdGroup's EID in the AdGroupAd relationship, if listed inside an AdGroup.

inAdgroupIsActive (Boolean!)

True of the AdGroupAd relationship is active, if listed inside an AdGroup.

inAdgroupRelationshipEID (String!)

The the internal EID of the AdGroupAd relationship, if such a EID exists and if the ad is listed inside an AdGroup.

inAdgroupStatus (String!)

The status of the AdGroupAd relationship, if listed inside an AdGroup.

instagramPermalink (String!)

Instagram permalink if applicable.

isActive (Boolean!)

Whether or not this ad is currently active.

isOutlined (Boolean!)

Whether or not an outline has been applied to the ad to satisfy network compliancy.

linkedInPermalink (String!)

LinkedIn permalink if applicable.

message (String!)

For Facebook Newsfeed ads, the text to be displayed as the ad's message.

name (String!)

The name of this ad.

originalAd (String!)

The EID of the ad that was edited to create this ad.

outlineColor (String!)

Hexadecimal color code corresponding to the outline of an ad.

previewURL (String!)

The preview URL for dynamic ads like HTML5.

remoteStatus (String!)

The status of the Ad on the inventory network NextRoll has sync'ed it to (ex: Facebook)

src (String!)

This ad's creative's source URL.

status (String!)

One of 'running', 'paused', 'review', 'draft', 'rejected', 'suspended' or 'deleted'.

type (String!)

The ad type: 'liquid', 'image', 'flash' or 'ad_network'.

updatedDate (AdrollDateTime)

The date this ad was last updated.

utmCampaign (String!)

UTM Campaign Parameter from this Ad's destination.

utmContent (String!)

UTM Content Parameter from this Ad's destination.

utmMedium (String!)

UTM Medium Parameter from this Ad's destination.

utmSource (String!)

UTM Source Parameter from this Ad's destination.

utmTerm (String!)

UTM Term Parameter from this Ad's destination.

validClicktag (Boolean!)

If the ad is in flash format, this is the flag showing whether or not the clickTAG is compliant.

width (Int!)

The width in pixels of this ad's creative.

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.

____________________________________________________________________________________________________