Placement API

The Placement API provides endpoints to retrieve information about placements within the Retail Media platform. Placements represent advertising spaces or locations where advertisements can be displayed.

• Method: GET

• URL: https://<PA_RM_END_POINT>/rm/1.0/placement

• Headers:

  • Content-Type: application/json
  • Authorization: Bearer ACCESS_TOKEN

• Response Codes:

  • 200 OK

    Successful request. The response body will include an array of placement details:

    [
        {
            "id": "xxxxxxxxxxxxxxxxxxxxxxx",
            "name": "Name of the placement",
            "pageType": 2,
            "strategyType": 3,
            "adSetType": 1
        },
        {
            "id": "xxxxxxxxxxxxxxxxxxxxxxx",
            "name": "Name of the placement",
            "pageType": 2,
            "strategyType": 3,
            "adSetType": 1
        },
        {
            "id": "xxxxxxxxxxxxxxxxxxxxxxx",
            "name": "Name of the placement",
            "pageType": 2,
            "strategyType": 3,
            "adSetType": 1
        },
        {
            "id": "xxxxxxxxxxxxxxxxxxxxxxx",
            "name": "Name of the placement",
            "pageType": 2,
            "strategyType": 3,
            "adSetType": 1
        }
    ]
    • id (string): The unique identifier for the placement.
    • name (string): The name of the placement.
    • pageType (integer): The type of page where the placement is located.
    • strategyType (integer): The type of advertising strategy used for the placement.
    • adSetType (integer): The type of ad set associated with the placement.

  • Non-200 Responses

    If an error occurs (e.g., bad request, unauthorized access), the server will respond with an appropriate non-200 status code and include an error message in the response body:

    {
        "error": "Error message"
    }