AdBuyMCPDevelopers

← All API operations

POST /api/v1/planning/provider-forecast

Request native provider forecast evidence

Requests provider-owned forecasting where the configured adapter supports it. Unsupported provider contracts fail explicitly; modeled planning forecasts remain separately labeled.

Authenticated and advertiser scoped. Cross-tenant resource access returns 404. Product/channel entitlements also apply.

The request schema is generated from the runtime Zod input validator. Cross-field refinements and state-dependent constraints are additionally enforced by the API.

Request

HTTP
POST /api/v1/planning/provider-forecast

Use the configured API origin. Private requests require a verified Bearer credential; an agent mutation can additionally require exact approval headers. Authentication guide →

Request body contract
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "adapterKey": {
            "type": "string",
            "const": "google-ads"
          },
          "budget": {
            "type": "object",
            "properties": {
              "amountMinor": {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              "currency": {
                "type": "string",
                "enum": [
                  "GBP",
                  "USD",
                  "EUR"
                ]
              }
            },
            "required": [
              "amountMinor",
              "currency"
            ],
            "additionalProperties": false
          },
          "startDate": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "endDate": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "text": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "matchType": {
                  "type": "string",
                  "enum": [
                    "exact",
                    "phrase",
                    "broad"
                  ]
                }
              },
              "required": [
                "text",
                "matchType"
              ],
              "additionalProperties": false
            },
            "minItems": 1,
            "maxItems": 1000
          },
          "geoTargetConstants": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^geoTargetConstants\\/\\d+$"
            },
            "minItems": 1,
            "maxItems": 10
          },
          "languageConstants": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^languageConstants\\/\\d+$"
            },
            "minItems": 1,
            "maxItems": 20
          },
          "bidding": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "strategy": {
                    "type": "string",
                    "const": "manual-cpc"
                  },
                  "maxCpcBidMinor": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 9007199254740991
                  }
                },
                "required": [
                  "strategy",
                  "maxCpcBidMinor"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "strategy": {
                    "type": "string",
                    "const": "maximize-clicks"
                  },
                  "maxCpcBidMinor": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 9007199254740991
                  }
                },
                "required": [
                  "strategy"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "strategy": {
                    "type": "string",
                    "const": "maximize-conversions"
                  }
                },
                "required": [
                  "strategy"
                ],
                "additionalProperties": false
              }
            ]
          },
          "acknowledgedLimitations": {
            "type": "boolean",
            "const": true
          }
        },
        "required": [
          "adapterKey",
          "budget",
          "startDate",
          "endDate",
          "keywords",
          "geoTargetConstants",
          "languageConstants",
          "bidding",
          "acknowledgedLimitations"
        ],
        "additionalProperties": false
      }
    }
  }
}

Responses

Reference schemas resolve through the downloadable OpenAPI components. The specification marks unmodeled success payloads; an unrestricted payload is not a promise that arbitrary fields exist.

400Invalid request or unsupported fields
Response contract
{
  "description": "Invalid request or unsupported fields",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
401Missing or invalid authentication
Response contract
{
  "description": "Missing or invalid authentication",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
403Permission or product scope refused
Response contract
{
  "description": "Permission or product scope refused",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
404Route or tenant-scoped resource not found
Response contract
{
  "description": "Route or tenant-scoped resource not found",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
409State, revision, approval, funding or idempotency conflict
Response contract
{
  "description": "State, revision, approval, funding or idempotency conflict",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
422Supplier configuration, capability or upstream refusal
Response contract
{
  "description": "Supplier configuration, capability or upstream refusal",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
429Rate limit reached; wait before retrying
Response contract
{
  "description": "Rate limit reached; wait before retrying",
  "headers": {
    "x-ratelimit-limit": {
      "description": "Maximum requests permitted in the current rate-limit window.",
      "schema": {
        "type": "integer"
      }
    },
    "x-ratelimit-remaining": {
      "description": "Requests remaining in the current window.",
      "schema": {
        "type": "integer"
      }
    },
    "x-ratelimit-reset": {
      "description": "Seconds until the current rate-limit window resets.",
      "schema": {
        "type": "integer"
      }
    },
    "retry-after": {
      "description": "Minimum seconds to wait before retrying.",
      "schema": {
        "type": "integer"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
500Internal error; inspect state before retrying a mutation
Response contract
{
  "description": "Internal error; inspect state before retrying a mutation",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
503Dependency or authentication verifier unavailable
Response contract
{
  "description": "Dependency or authentication verifier unavailable",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}
2XXSuccessful response. Response schema completeness: unmodeled. The request contract is complete; nested service payloads are not yet fully modeled in OpenAPI. Inspect returned fields before generating a typed SDK.
Response contract
{
  "description": "Successful response. Response schema completeness: unmodeled. The request contract is complete; nested service payloads are not yet fully modeled in OpenAPI. Inspect returned fields before generating a typed SDK.",
  "headers": {
    "x-ratelimit-limit": {
      "description": "Maximum requests permitted in the current rate-limit window.",
      "schema": {
        "type": "integer"
      }
    },
    "x-ratelimit-remaining": {
      "description": "Requests remaining in the current window.",
      "schema": {
        "type": "integer"
      }
    },
    "x-ratelimit-reset": {
      "description": "Seconds until the current rate-limit window resets.",
      "schema": {
        "type": "integer"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {}
    }
  }
}

Operation constraints

Machine-readable metadata
{
  "x-response-schema-completeness": "unmodeled",
  "x-rate-limit": {
    "requests": 30,
    "windowMilliseconds": 60000,
    "key": "request IP",
    "headers": [
      "x-ratelimit-limit",
      "x-ratelimit-remaining",
      "x-ratelimit-reset"
    ]
  },
  "x-idempotency": {
    "policy": "not-generalized",
    "note": "There is no universal Idempotency-Key middleware. Only the documented endpoint mechanisms protect retries."
  }
}

Complete operation

OpenAPI
{
  "operationId": "post_api_v1_planning_provider_forecast",
  "summary": "Request native provider forecast evidence",
  "description": "Requests provider-owned forecasting where the configured adapter supports it. Unsupported provider contracts fail explicitly; modeled planning forecasts remain separately labeled.\n\nAuthenticated and advertiser scoped. Cross-tenant resource access returns 404. Product/channel entitlements also apply.\n\nThe request schema is generated from the runtime Zod input validator. Cross-field refinements and state-dependent constraints are additionally enforced by the API.",
  "tags": [
    "Planning"
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "parameters": [],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "adapterKey": {
              "type": "string",
              "const": "google-ads"
            },
            "budget": {
              "type": "object",
              "properties": {
                "amountMinor": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "currency": {
                  "type": "string",
                  "enum": [
                    "GBP",
                    "USD",
                    "EUR"
                  ]
                }
              },
              "required": [
                "amountMinor",
                "currency"
              ],
              "additionalProperties": false
            },
            "startDate": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "endDate": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "keywords": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80
                  },
                  "matchType": {
                    "type": "string",
                    "enum": [
                      "exact",
                      "phrase",
                      "broad"
                    ]
                  }
                },
                "required": [
                  "text",
                  "matchType"
                ],
                "additionalProperties": false
              },
              "minItems": 1,
              "maxItems": 1000
            },
            "geoTargetConstants": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^geoTargetConstants\\/\\d+$"
              },
              "minItems": 1,
              "maxItems": 10
            },
            "languageConstants": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^languageConstants\\/\\d+$"
              },
              "minItems": 1,
              "maxItems": 20
            },
            "bidding": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "strategy": {
                      "type": "string",
                      "const": "manual-cpc"
                    },
                    "maxCpcBidMinor": {
                      "type": "integer",
                      "exclusiveMinimum": 0,
                      "maximum": 9007199254740991
                    }
                  },
                  "required": [
                    "strategy",
                    "maxCpcBidMinor"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "strategy": {
                      "type": "string",
                      "const": "maximize-clicks"
                    },
                    "maxCpcBidMinor": {
                      "type": "integer",
                      "exclusiveMinimum": 0,
                      "maximum": 9007199254740991
                    }
                  },
                  "required": [
                    "strategy"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "strategy": {
                      "type": "string",
                      "const": "maximize-conversions"
                    }
                  },
                  "required": [
                    "strategy"
                  ],
                  "additionalProperties": false
                }
              ]
            },
            "acknowledgedLimitations": {
              "type": "boolean",
              "const": true
            }
          },
          "required": [
            "adapterKey",
            "budget",
            "startDate",
            "endDate",
            "keywords",
            "geoTargetConstants",
            "languageConstants",
            "bidding",
            "acknowledgedLimitations"
          ],
          "additionalProperties": false
        }
      }
    }
  },
  "responses": {
    "400": {
      "description": "Invalid request or unsupported fields",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Missing or invalid authentication",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "403": {
      "description": "Permission or product scope refused",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "404": {
      "description": "Route or tenant-scoped resource not found",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "409": {
      "description": "State, revision, approval, funding or idempotency conflict",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "422": {
      "description": "Supplier configuration, capability or upstream refusal",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "429": {
      "description": "Rate limit reached; wait before retrying",
      "headers": {
        "x-ratelimit-limit": {
          "description": "Maximum requests permitted in the current rate-limit window.",
          "schema": {
            "type": "integer"
          }
        },
        "x-ratelimit-remaining": {
          "description": "Requests remaining in the current window.",
          "schema": {
            "type": "integer"
          }
        },
        "x-ratelimit-reset": {
          "description": "Seconds until the current rate-limit window resets.",
          "schema": {
            "type": "integer"
          }
        },
        "retry-after": {
          "description": "Minimum seconds to wait before retrying.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "500": {
      "description": "Internal error; inspect state before retrying a mutation",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "503": {
      "description": "Dependency or authentication verifier unavailable",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "2XX": {
      "description": "Successful response. Response schema completeness: unmodeled. The request contract is complete; nested service payloads are not yet fully modeled in OpenAPI. Inspect returned fields before generating a typed SDK.",
      "headers": {
        "x-ratelimit-limit": {
          "description": "Maximum requests permitted in the current rate-limit window.",
          "schema": {
            "type": "integer"
          }
        },
        "x-ratelimit-remaining": {
          "description": "Requests remaining in the current window.",
          "schema": {
            "type": "integer"
          }
        },
        "x-ratelimit-reset": {
          "description": "Seconds until the current rate-limit window resets.",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {}
        }
      }
    }
  },
  "x-response-schema-completeness": "unmodeled",
  "x-rate-limit": {
    "requests": 30,
    "windowMilliseconds": 60000,
    "key": "request IP",
    "headers": [
      "x-ratelimit-limit",
      "x-ratelimit-remaining",
      "x-ratelimit-reset"
    ]
  },
  "x-idempotency": {
    "policy": "not-generalized",
    "note": "There is no universal Idempotency-Key middleware. Only the documented endpoint mechanisms protect retries."
  }
}
Download the complete specification, including shared schema components →
Request native provider forecast evidence | AdBuyMCP docs