🪡 Greenbids Tailor

Bring traffic shaping to your own cloud!

🤖 API Reference

Interactions

Following the interaction diagram provided by the OpenRTB API Specification (version 2.5) (§2) here is an example of where the Greenbids Tailor product must be called.

sequenceDiagram
    activate Publisher
    Publisher ->>+ SSP: 0. Ad Request

    participant GB as Greenbids Tailor
    rect rgb(30, 183, 136)
    SSP ->>+ GB: PUT / @[Fabric, ...]
    GB -->>- SSP: 200 @[Fabric, ...]
    end

    loop for each request where fabric.prediction.shouldSend
        SSP ->>+ buyer: 1. Bid Request
        alt 200
        buyer -->> SSP: Bid Response
        else 204
        buyer -->>- SSP: No Response
        end
    end

    rect rgb(30, 183, 136)
    SSP -)+ GB: POST / @[Fabric, ...]
    GB --) greenbids.ai: status
    GB -->>- SSP: 200
    end

    note over SSP: Continue auction process
    deactivate SSP
    deactivate Publisher

Loading

Routes

Below, you can find a detailed description of the routes provided by the Greenbids Tailor API:

• Get buyers probabilities

  PUT /

  • Request body:
    • list[Fabric]
  • Responses:
    • 200 - Successful Response: list[Fabric]
    • 422 - Validation Error: HTTPValidationError

• Report buyers status

  POST /

  • Request body:
    • list[Fabric]
  • Responses:
    • 200 - Successful Response: list[Fabric]
    • 422 - Validation Error: HTTPValidationError

• Startup probe

  GET /healthz/startup

  • Responses:
    • 200 - Successful Response

• Liveness probe

  GET /healthz/liveness

  • Responses:
    • 200 - Successful Response

• Readiness probe

  GET /healthz/readiness

  • Responses:
    • 200 - Successful Response

🚀 Deployment

Depending on your current stack, find the best way to deploy this service.

• Executable

  pip install ./python
  uvicorn greenbids.tailor:app

• Docker

  docker run -P ghcr.io/greenbids/tailor:latest

• Helm

  helm install --create-namespace --namespace greenbids tailor oci://ghcr.io/greenbids/charts/tailor