AdRoll v2

Provides integration with AdRoll organization, advertising, campaign and supported audience services. Use templates for read operations, campaign edits, additional API actions and Server-to-Server events.

Revision History

0.0.0.4 - Provides PAT and OAuth authentication, additional read/write templates and Server-to-Server events.

Connection

Property Type Description
AuthMode Enum PersonalAccessToken or OAuth. Defaults to PersonalAccessToken; newer Ads/Campaign templates require OAuth.
ClientId Masked Registered application identifier used with PAT or OAuth.
PersonalAccessToken Masked Personal access token when AuthMode is PersonalAccessToken.
ClientSecret Masked OAuth application secret when AuthMode is OAuth.
AccessToken Masked OAuth access token.
RefreshToken Masked OAuth refresh token.
AuthorizationState Masked Hidden, runtime-managed OAuth state.
TimeoutSeconds Integer Positive request timeout in seconds. Defaults to 30.
ServerAccessToken Masked Separate token required by Server-to-Server event templates.

Setup Notes

  1. Obtain application credentials and select AuthMode.
  2. For PAT access, enter ClientId and PersonalAccessToken. For OAuth access, enter the application credentials and connect your account using its registered callback URI.
  3. Test the Connection, which reads organization data using the selected PAT/OAuth mode.
  4. Enter ServerAccessToken separately if sending events. Event authentication does not substitute PAT or OAuth credentials.
  5. Run on a Cloud Cluster and select a template supported by your product entitlements.

Methods

Select a Method and its template to populate the operation and its supported fields.

Query

Reads the original organization, advertisable, campaign and ad operations.

Parameter Type Description
Connection Connection AdRoll Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Provider records without added mutation status fields.

Edit Campaign

Edits campaign budget, bidding, name or schedule.

Parameter Type Description
Connection Connection AdRoll Connection profile.
Items Array Campaign form fields. Each item requires campaign and ui_budget_daily.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request.

Read

Reads additional CRUD, audience, user-list, geotargeting and GraphQL operations.

Parameter Type Description
Connection Connection AdRoll Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Body Object Request body where the selected read template requires one.
Return Type Description
Response Array Provider records without added mutation status fields.

Write

Creates, updates, deletes, configures or sends events using an explicitly selected operation.

Parameter Type Description
Connection Connection AdRoll Connection profile.
OperationId String Operation identifier populated by the selected template.
Items Array Connected request records with Options and/or Body as shown by the selected template.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request.

Usage Notes

  • Keep the original Query and Edit Campaign templates for their existing operations. Additional operations use Read and Write.
  • Write items contain their own template-defined Options and Body. An empty stream makes no calls; a bodyless action still needs one connected item.
  • Read collections emit individual records without transport wrappers. GraphQL preserves the selected data roots; opaque values are returned under Value.
  • The first request completes during invocation and later work is lazy. Handled write-record validation failures return failed rows; authentication, quota, transport and server failures stop execution. Only an explicit OAuth HTTP 401 response permits one coordinated renewal and retry.
  • Product-set uploads take base64-encoded gzip CSV; CRM rule uploads take base64-encoded CSV and require at least 100 emails. Local file paths are not read.
  • Event items must match Options.advertisable and include identifiers.adct or identifiers.first_party_cookie. Use explicit dry_run=true for validation where supported.
  • Known string and integer lists use CSV where the template specifies it. Quote values containing commas, quotes or newlines, and double embedded quotes. Empty text represents an empty list; "" represents one empty string. Integer lists do not accept added whitespace or fractions. Structured object arrays retain their child fields.
  • Existing PAT Connection keys remain valid. OAuth-only profiles cannot be converted to PAT automatically during rollback.

Known Issues

  • API availability and quotas depend on your product entitlements and application permissions. Some provider schemas are incomplete and expose JSON text rather than invented fields.
  • Browser-only Pixel and Site Traffic Revealer interfaces are not exposed. Retired Automated/Universal Campaign endpoints are excluded.