Get sponsorship collection

cURL

curl --request GET \
  --url https://api.mottostreaming.com/monetization/ads/v1/sponsorship_collections/{sponsorship_collection_id} \
  --header 'Authorization: Bearer <token>'

{
  "sponsorship_collection": {
    "id": "<string>",
    "project_id": "<string>",
    "name": "<string>",
    "slots": [
      {
        "asset_id": {},
        "destination_url": {}
      }
    ],
    "visibility": "VISIBILITY_UNSPECIFIED"
  }
}

GET

monetization

ads

sponsorship_collections

{sponsorship_collection_id}

cURL

curl --request GET \
  --url https://api.mottostreaming.com/monetization/ads/v1/sponsorship_collections/{sponsorship_collection_id} \
  --header 'Authorization: Bearer <token>'

{
  "sponsorship_collection": {
    "id": "<string>",
    "project_id": "<string>",
    "name": "<string>",
    "slots": [
      {
        "asset_id": {},
        "destination_url": {}
      }
    ],
    "visibility": "VISIBILITY_UNSPECIFIED"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sponsorship_collection_id

string

required

Query Parameters

project_id

string

Response

sponsorship_collection

object

SponsorshipCollection represents a collection of sponsorship slots that can be displayed in one of various layouts on an end-user facing web/app page.

Show child attributes

sponsorship_collection.id

string

required

A unique identifier for the sponsorship collection. This can be set manually, or auto-generated if left empty.

sponsorship_collection.project_id

string

required

sponsorship_collection.name

string

required

A name for visual identification within the management UI. Does not appear towards end users.

sponsorship_collection.slots

object[]

A list of sponsorship slots that should be included in this sponsorship collection. The order of this list determines the order in which the sponsorship slots are displayed towards end users.

Show child attributes

sponsorship_collection.slots.asset_id

object

A map of either an image assets. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the assets for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Show child attributes

sponsorship_collection.slots.asset_id.{key}

string

sponsorship_collection.slots.destination_url

object

A map of localized destination URLs. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the URL for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Show child attributes

sponsorship_collection.slots.destination_url.{key}

string

sponsorship_collection.visibility

enum<string>

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

Delete video ad List sponsorship collections

⌘I

Get Started

Studio API

Content Delivery API

Deep dive

Get sponsorship collection

Authorizations

Path Parameters

Query Parameters

Response