Get customer lists
The Google Ads Customer Match lists Product Metrics manages for the property (one per list kind): whether each is not provisioned, provisioning, managed or in conflict, and the Google Ads account they live in.
GET /properties/{propertyId}/google-ads/customer-lists
Scope read · Access Read only · Operation id google_ads.get_customer_lists
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID, $COMPANY_ID first.
productmetrics google-ads get-customer-lists \
--property-id $PROPERTY_ID \
--company-id $COMPANY_ID \
--jsonResponse
API response (200), shortened:
{
"data": {
"google_ads_customer_id": "1234567890",
"lists": [
{
"kind": "all_customers",
"state": "not_provisioned",
"display_name": "Product Metrics - All customers - Example Store",
"user_list_id": "1234567890"
// … 5 more fields
}
]
},
"request_id": "req_01JX87GABSTDK2PEZ4SP12PM6B"
}CLI output: productmetrics google-ads get-customer-lists --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Read-only. Needs read access to the property. If lists are missing, google_ads.create_customer_lists creates them.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | The property id, from productmetrics whoami or properties.list (property_id). |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id | string (uuid) | Yes | Your workspace id, from productmetrics whoami or properties.list. |
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_01J2PJ4DS2GZ7962GMHW3EYTA7"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the read scope (details.required_scope): sign in again and allow it. |
| 404 | property_not_found | The property does not exist in this workspace. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |
| 503 | internal_error | The lists could not be read just now: retry later. |