Sign in
Ad Campaigns

Get ad details

Returns an ad with its creative, targeting, status, and performance metrics. Google Search ads include current creative.headlines, creative.descriptions and creative.finalUrls, preserving pinnedField. Top-level cachedAt and stale report cache freshness. Google mutations invalidate this read. RSA enrichment requires a stored advertisingChannelType of SEARCH. Ads with an unknown or other channel return their stored details without a Google read. If RSA enrichment fails, the stored ad is returned with HTTP 200 and without cache metadata.

The {adId} path segment accepts any identifier dialect Zernio indexes for the ad:

  • the Zernio internal _id (24-char hex)
  • Meta's numeric platformAdId (the value shipped in comment.received webhooks as comment.ad.id)
  • the creative's effective_object_story_id ({pageId}_{postId} shape, Facebook side)
  • the creative's effective_instagram_media_id (Instagram side)

Any of the four resolve to the same ad. Caller doesn't need a translation step. creative.creativeFeatures holds the stored requested settings, which do not confirm platform application.

get/v1/ads/{adId}

Path parameters

adIdstring required

Zernio _id (hex), Meta platformAdId (numeric), or one of the creative's effective story/media IDs. See description for details.

Response

Ad details

cachedAtstring date-time nullable

Google RSA details cache timestamp.

staleboolean

Whether Google RSA details use the last successful cached response.

Example response

{
  "ad": {
    "configuredStatus": "ACTIVE",
    "creativeType": "video",
    "metrics": {
      "actions": {
        "link_click": 160,
        "post_engagement": 300,
        "offsite_conversion.fb_pixel_purchase": 42
      },
      "actionValues": {
        "offsite_conversion.fb_pixel_purchase": 2456.78,
        "offsite_conversion.fb_pixel_add_to_cart": 980.5
      },
      "costPerAction": {
        "link_click": 0.1052,
        "offsite_conversion.fb_pixel_purchase": 4.0114
      }
    },
    "platformObjective": "OUTCOME_SALES",
    "optimizationGoal": "OFFSITE_CONVERSIONS",
    "costType": "CPC",
    "servingStatuses": [
      "ACCOUNT_TOTAL_BUDGET_HOLD"
    ],
    "platformAdAccountName": "Zernio - previously Late",
    "bidAmount": 5,
    "roasAverageFloor": 2,
    "promotedObject": {
      "custom_event_type": "PURCHASE"
    },
    "creative": {
      "assetGroup": {
        "finalUrl": "https://zernio.com",
        "headlines": [
          "Schedule posts",
          "One social API",
          "Build with Zernio"
        ],
        "longHeadline": "Schedule social content from your app with Zernio",
        "descriptions": [
          "Connect your social accounts.",
          "Publish and manage social content through one API."
        ],
        "businessName": "Zernio",
        "images": {
          "landscape": [
            "https://example.com/landscape.png"
          ],
          "square": [
            "https://example.com/square.png"
          ],
          "logo": [
            "https://example.com/logo.png"
          ]
        }
      },
      "assetGroupResourceName": "customers/9122445560/assetGroups/123456789",
      "servingHoldReasons": [
        "UNDER_REVIEW"
      ],
      "whatsappPhoneNumber": "+12025550123"
    }
  }
}

Changes