← All MCP tools

MCP tool

get_brand_lift_study_catalogs

Read supplier-reported or deterministic sandbox industries, country languages and explicitly scoped standard question templates. Select both catalog IDs to read templates. Catalog availability is not a quote, purchase approval or credentialed acceptance.

Input

Pass fields from this schema as the tool arguments. Runtime ownership, product scope and readiness checks still apply.

Input JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "mode": {
      "type": "string",
      "enum": [
        "sandbox",
        "live"
      ]
    },
    "countryLanguageId": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "industryId": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "page": {
      "default": 1,
      "type": "integer",
      "minimum": 1,
      "maximum": 10000
    },
    "pageSize": {
      "default": 100,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "campaignId",
    "mode"
  ],
  "additionalProperties": false
}

REST mapping and authority

The tool wraps this REST endpoint. The mapping identifies path/query/body transformations and approval or idempotency headers.

Request contract
{
  "method": "GET",
  "path": "/api/v1/campaigns/{campaignId}/brand-lift-study-catalogs",
  "pathFields": [
    "campaignId"
  ],
  "pathSchema": {
    "type": "object",
    "properties": {
      "campaignId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "additionalProperties": false,
    "required": [
      "campaignId"
    ]
  },
  "pathEncoding": "encodeURIComponent for each path field",
  "governedAction": null,
  "headers": {},
  "querySchema": {
    "type": "object",
    "properties": {
      "mode": {
        "type": "string",
        "enum": [
          "sandbox",
          "live"
        ]
      },
      "countryLanguageId": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      },
      "industryId": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      },
      "page": {
        "default": 1,
        "type": "integer",
        "minimum": 1,
        "maximum": 10000
      },
      "pageSize": {
        "default": 100,
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      }
    },
    "additionalProperties": false,
    "required": [
      "mode"
    ]
  },
  "queryEncoding": "URLSearchParams; omit undefined fields, stringify supplied values",
  "responseMapping": "REST JSON is returned as MCP structuredContent and a compatibility text block; privacy-sensitive tools validate their output schema."
}

Output

This is the registered MCP output envelope. Nested fields are only modeled where the schema explicitly defines them.

Output JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "mode": {
      "type": "string",
      "enum": [
        "sandbox",
        "live"
      ]
    },
    "observedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "attemptId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "authority": {
      "type": "object",
      "properties": {
        "providerAccountId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "connectionRevision": {
          "anyOf": [
            {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "configuredIdentityDigest": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "dossierRevision": {
          "anyOf": [
            {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "dossierDigest": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "providerAccountId",
        "connectionRevision",
        "configuredIdentityDigest",
        "dossierRevision",
        "dossierDigest"
      ],
      "additionalProperties": false
    },
    "evidenceSource": {
      "type": "string",
      "enum": [
        "provider-reported",
        "sandbox-modeled"
      ]
    },
    "industries": {
      "type": "object",
      "properties": {
        "page": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 10000
        },
        "pageSize": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 100
        },
        "totalItems": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "hasMore": {
          "type": "boolean"
        },
        "evidenceSource": {
          "type": "string",
          "enum": [
            "provider-reported",
            "sandbox-modeled"
          ]
        },
        "items": {
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "page",
        "pageSize",
        "totalItems",
        "hasMore",
        "evidenceSource",
        "items"
      ],
      "additionalProperties": false
    },
    "countryLanguages": {
      "type": "object",
      "properties": {
        "page": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 10000
        },
        "pageSize": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 100
        },
        "totalItems": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "hasMore": {
          "type": "boolean"
        },
        "evidenceSource": {
          "type": "string",
          "enum": [
            "provider-reported",
            "sandbox-modeled"
          ]
        },
        "items": {
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              "countryId": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              "countryName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
              },
              "languageId": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              "languageName": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
              },
              "locale": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "channels": {
                "maxItems": 4,
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "digital",
                    "linear_tv",
                    "social",
                    "forced_exposure"
                  ]
                }
              }
            },
            "required": [
              "id",
              "countryId",
              "countryName",
              "languageId",
              "languageName",
              "locale",
              "channels"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "page",
        "pageSize",
        "totalItems",
        "hasMore",
        "evidenceSource",
        "items"
      ],
      "additionalProperties": false
    },
    "standardTemplates": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "evidenceSource": {
              "type": "string",
              "enum": [
                "provider-reported",
                "sandbox-modeled"
              ]
            },
            "templates": {
              "maxItems": 100,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "usage": {
                    "type": "string",
                    "enum": [
                      "lift",
                      "baseline"
                    ]
                  },
                  "questionName": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 300
                  },
                  "kpiType": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 100
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "definitionDigest": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "questionTextTemplate": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 10000
                  },
                  "required": {
                    "type": "boolean"
                  },
                  "fields": {
                    "maxItems": 20,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 100
                        },
                        "label": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 500
                        },
                        "defaultValue": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 500
                        }
                      },
                      "required": [
                        "name",
                        "label",
                        "defaultValue"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "supported": {
                    "type": "boolean"
                  },
                  "unsupportedReason": {
                    "anyOf": [
                      {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 1000
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "usage",
                  "questionName",
                  "kpiType",
                  "definitionDigest",
                  "questionTextTemplate",
                  "required",
                  "fields",
                  "supported",
                  "unsupportedReason"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "evidenceSource",
            "templates"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "templateScope": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "countryLanguageId": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "industryId": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "countryLanguageId",
            "industryId"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "pricing": {
      "type": "string",
      "const": "supplier-quote-required"
    },
    "cancellation": {
      "type": "string",
      "const": "human-supplier-workflow-required"
    },
    "credentialedAcceptance": {
      "type": "boolean",
      "const": false
    }
  },
  "required": [
    "campaignId",
    "mode",
    "observedAt",
    "attemptId",
    "authority",
    "evidenceSource",
    "industries",
    "countryLanguages",
    "standardTemplates",
    "templateScope",
    "pricing",
    "cancellation",
    "credentialedAcceptance"
  ],
  "additionalProperties": false
}

Safety annotations

MCP annotations
{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": true
}

Annotations help a client present the tool. The API independently enforces authorization and exact action approvals. Error and retry guidance →

get_brand_lift_study_catalogs | AdBuyMCP docs