Skip to content
Google Ads

Get workspace setup status

How far the workspace's Google setup is: how many Google Ads properties are connected, which of them still lack a Merchant Center connection, and whether setup is complete.

GET /companies/{companyId}/google-ads/setup-status

Scope read · Access Read only · Operation id google_ads.get_setup_status

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID first.

productmetrics google-ads get-setup-status --company-id $COMPANY_ID --json

Response

API response (200):

{
  "data": {
    "companyId": "2a7d9b3c-1e4f-4a5b-8c6d-7e8f9a0b1c2d",
    "connectedPropertyCount": 42,
    "propertiesMissingMerchantCenter": [
      {
        "propertyId": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
        "customerId": "1234567890",
        "displayName": "Example Store",
        "googleAdsConnectionMode": "central_read_only"
      }
    ],
    "setupComplete": true
  },
  "request_id": "req_01JYVGMJCBD4XS2Q3VNSPD7TMG"
}

CLI output: productmetrics google-ads get-setup-status --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Call it to decide the next setup step; connect each listed property with merchant_center.create_connection. Needs company admin.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).

Errors

A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JHG2MYJ16QHR3VKHNVD885CY"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the read scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Google Ads operations