Get a placement catalog share view

POST

placement_catalog_shares

view

curl --request POST \
  --url https://your_a2_service/placement_catalog_shares/view \
  --header 'Content-Type: application/json' \
  --data '
{
  "placement_catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "password": "<string>"
}
'

{
  "catalog": {
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "no": 123,
    "placement_ids": [
      "<string>"
    ],
    "settings": {
      "include_analytics": false,
      "indicators": []
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "placements": [
    {
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "no": 123,
      "campaign_permission": {
        "black": [],
        "white": []
      },
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "display": {
        "clktype": 1,
        "displayfmt": {
          "ext": {},
          "h": 250,
          "w": 300
        },
        "h": 250,
        "mime": [],
        "nativefmt": {
          "ext": {}
        },
        "w": 300
      },
      "ext": {
        "approval_method": "admin",
        "display": {
          "enabled": 0
        },
        "native": {
          "enabled": 0
        },
        "payout": "rates",
        "responsive": "fixed",
        "target_ecpm": 0,
        "video": {
          "enabled": 0
        }
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": false,
      "updated_at": "2023-11-07T05:31:56Z",
      "video": {
        "clktype": 1,
        "ctype": [
          2
        ],
        "delay": 0,
        "h": 300,
        "linear": 0,
        "maxdur": 0,
        "mime": [],
        "mindur": 0,
        "playmethod": [],
        "ptype": 1,
        "skip": 0,
        "skipafter": 0,
        "skipmin": 0,
        "w": 480
      }
    }
  ]
}

Body

application/json

Schema for reading a placement catalog share.

placement_catalog_id

string<uuid>

required

The ID of the placement catalog

password

string | null

The password for accessing protected placement catalogs

Response

Successful Response

Schema for reading a placement catalog share view.

catalog

PlacementCatalogSchema · object

required

Schema for reading a placement catalog.

Show child attributes

catalog.created_by

string<uuid>

required

The ID of the user who created the placement catalog

catalog.description

string

required

The description in JSON Quill Delta format - a JSON format that represents rich text content
Links: https://quilljs.com/docs/delta

catalog.id

string<uuid>

required

catalog.name

string

required

The name of the placement catalog

catalog.no

integer

required

catalog.placement_ids

string[]

required

The list of placement IDs

catalog.settings

PlacementCatalogSettingSchema · object

required

Schema for placement catalog settings.

Show child attributes

catalog.settings.include_analytics

boolean

default:false

Determines whether to include statistical data for each ad placement in the placement catalog

catalog.settings.indicators

enum<string>[]

A list of metric indicators that will be included in the placement catalog for analytics purposes

Metric indicator enum.

Available options:

budget_spent,

impression,

click,

conversion,

reach,

ad_revenue,

cpm,

cpc,

cpa,

roas

catalog.created_at

string<date-time> | null

The date and time the entity was created.

catalog.updated_at

string<date-time> | null

The date and time the entity was last updated.

placements

PlacementSchema · object[]

required

Show child attributes

placements.created_by

string<uuid>

required

The ID of the user who created the placement

placements.name

string

required

The name of the placement

placements.no

integer

required

placements.campaign_permission

Permission · object

deprecated

Permission

Show child attributes

placements.campaign_permission.black

string[]

placements.campaign_permission.white

string[]

placements.created_at

string<date-time> | null

The date and time the entity was created.

placements.description

string | null

The description in JSON Quill Delta format - a JSON format that represents rich text content

Links: https://quilljs.com/docs/delta

placements.display

Display · object

Schema for display placement. It contains specifications for banner display formats, native formats, and other display-related properties.

Show child attributes

placements.display.clktype

enum<integer>

default:1

Available options:

0,

1,

2,

3

placements.display.displayfmt

DisplayFormat · object

Array of objects that govern the attributes (e.g., sizes) of a banner display placement. Refer to Object: DisplayFormat.

Show child attributes

placements.display.displayfmt.ext

Ext · object

placements.display.displayfmt.h

integer

default:250

placements.display.displayfmt.w

integer

default:300

placements.display.h

integer

default:250

placements.display.mime

string[]

placements.display.nativefmt

NativeFormat · object

Schema for native placement. It contains specifications for native placement formats, and other native-related properties.

Show child attributes

placements.display.nativefmt.ext

Ext · object

placements.display.w

integer

default:300

placements.ext

PlacementExt · object

Schema for placement default extra configuration.

Show child attributes

placements.ext.approval_method

enum<string>

default:admin

Approval process method for placement publication requests.

delegate: Advertisers with placement publication rights can decide on campaign exposure without the placement manager's approval
admin: Placement manager must approve the campaign exposure request

Available options:

admin,

delegate

placements.ext.display

Display · object

placements.ext.native

Native · object

placements.ext.payout

enum<string>

default:rates

Default billing is optimized CPC, CPM, or CPA amount determined by the algorithm.

none: No payout is calculated for the placement
rates: Optimized CPC, CPM, or CPA amount determined by the algorithm

Available options:

none,

rates

placements.ext.responsive

enum<string>

default:fixed

Defines how ad creative is displayed in placement area

fixed: Display ad creative in its original size without modification resized: Adjust ad creative size to fit the placement area dimensions

Available options:

fixed,

resized

placements.ext.target_ecpm

number

default:0

placements.ext.video

Video · object

placements.id

string<uuid> | null

placements.is_active

boolean

default:false

placements.updated_at

string<date-time> | null

The date and time the entity was last updated.

placements.video

Video · object

Schema for video placement. It contains specifications for video placement formats, and other video-related properties.

Show child attributes

placements.video.clktype

enum<integer>

default:1

Available options:

0,

1,

2,

3

placements.video.ctype

integer[]

placements.video.delay

integer

default:0

placements.video.h

integer

default:300

placements.video.linear

enum<integer>

default:0

Available options:

0,

1,

2

placements.video.maxdur

integer

default:0

placements.video.mime

string[]

placements.video.mindur

integer

default:0

placements.video.playmethod

enum<integer>[]

Available options:

1,

2,

3,

4,

5,

6,

7

placements.video.ptype

enum<integer>

default:1

Available options:

1,

2,

3,

4

placements.video.skip

enum<integer>

default:0

Available options:

0,

1

placements.video.skipafter

integer

default:0

placements.video.skipmin

integer

default:0

placements.video.w

integer

default:480

Get a placement catalog shareRetrieves a specific placement catalog share by its ID.

⌘I

Get a placement catalog share view

curl --request POST \
  --url https://your_a2_service/placement_catalog_shares/view \
  --header 'Content-Type: application/json' \
  --data '
{
  "placement_catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "password": "<string>"
}
'

{
  "catalog": {
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "no": 123,
    "placement_ids": [
      "<string>"
    ],
    "settings": {
      "include_analytics": false,
      "indicators": []
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "placements": [
    {
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "no": 123,
      "campaign_permission": {
        "black": [],
        "white": []
      },
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "display": {
        "clktype": 1,
        "displayfmt": {
          "ext": {},
          "h": 250,
          "w": 300
        },
        "h": 250,
        "mime": [],
        "nativefmt": {
          "ext": {}
        },
        "w": 300
      },
      "ext": {
        "approval_method": "admin",
        "display": {
          "enabled": 0
        },
        "native": {
          "enabled": 0
        },
        "payout": "rates",
        "responsive": "fixed",
        "target_ecpm": 0,
        "video": {
          "enabled": 0
        }
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": false,
      "updated_at": "2023-11-07T05:31:56Z",
      "video": {
        "clktype": 1,
        "ctype": [
          2
        ],
        "delay": 0,
        "h": 300,
        "linear": 0,
        "maxdur": 0,
        "mime": [],
        "mindur": 0,
        "playmethod": [],
        "ptype": 1,
        "skip": 0,
        "skipafter": 0,
        "skipmin": 0,
        "w": 480
      }
    }
  ]
}

Data Management APIs

Decision APIs

Get a placement catalog share view

Body

Response