diff --git a/README.md b/README.md index 7b9bf54d670a..fd79eca262c8 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,21 @@ If you're looking to contribute to the developer documentation itself, see https 1. `npm install` on first usage 2. `git submodule update --init` to install submodules 3. `npm start` to open in dev mode + +### Ads API reference + +The V2 Ads API reference is generated from the commit-pinned `openapi.json` in +`Dolby-OptiView/optiview-ads`. The generated MDX pages are committed, but the +fetched spec is not. Private GitHub fetches require `ADS_OPENAPI_TOKEN`, +`GITHUB_TOKEN`, or `GH_TOKEN` with `contents:read` access to `optiview-ads`. + +To refresh the published contract, update `DEFAULT_SPEC_REF` in +`scripts/fetch-ads-openapi.mjs`, then run: + +```bash +npm run refresh-ads-api-docs +npm run build +``` + +Use `ADS_OPENAPI_REF` to validate another remote commit or branch, or +`ADS_OPENAPI_SPEC_URL=/path/to/openapi.json` for a local checkout. diff --git a/ads/api/ads-client.swagger.json b/ads/api/ads-client.swagger.json deleted file mode 100644 index a56eacc2ae37..000000000000 --- a/ads/api/ads-client.swagger.json +++ /dev/null @@ -1,2005 +0,0 @@ -{ - "components": { - "examples": {}, - "headers": {}, - "parameters": {}, - "requestBodies": {}, - "responses": {}, - "schemas": { - "IStatus": { - "properties": { - "status": { - "type": "string" - }, - "error": { - "type": "string", - "nullable": true - }, - "uptime": { - "type": "number", - "format": "double" - }, - "timestamp": { - "type": "number", - "format": "double" - }, - "version": { - "type": "string" - } - }, - "required": [ - "status", - "error", - "uptime", - "timestamp", - "version" - ], - "type": "object", - "additionalProperties": false - }, - "MonetizedStreamEvent": { - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "id": { - "type": "string" - }, - "monetizedStream": { - "type": "string" - } - }, - "required": [ - "name", - "description", - "startDate", - "endDate", - "id", - "monetizedStream" - ], - "type": "object", - "additionalProperties": false - }, - "PaginationDetails": { - "properties": { - "total_records": { - "type": "number", - "format": "double" - }, - "current_page": { - "type": "number", - "format": "double" - }, - "total_pages": { - "type": "number", - "format": "double" - }, - "next_page": { - "type": "number", - "format": "double", - "nullable": true - }, - "prev_page": { - "type": "number", - "format": "double", - "nullable": true - } - }, - "required": [ - "total_records", - "current_page", - "total_pages", - "next_page", - "prev_page" - ], - "type": "object", - "additionalProperties": false - }, - "StreamEventResponse": { - "properties": { - "monetizedStream": { - "type": "string" - }, - "data": { - "items": { - "$ref": "#/components/schemas/MonetizedStreamEvent" - }, - "type": "array" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationDetails" - } - }, - "required": [ - "monetizedStream", - "data", - "pagination" - ], - "type": "object", - "additionalProperties": false - }, - "ReturnType_typeofStreamEventUpdateSchema.validateSync_": { - "properties": { - "endDate": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "StreamEventUpdate": { - "$ref": "#/components/schemas/ReturnType_typeofStreamEventUpdateSchema.validateSync_" - }, - "IStreamEvent": { - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - } - }, - "required": [ - "name", - "description", - "startDate", - "endDate" - ], - "type": "object", - "additionalProperties": false - }, - "ResourceType.MONETIZED_STREAM": { - "enum": [ - "monetized-stream" - ], - "type": "string" - }, - "MonetizedStreamType": { - "enum": [ - "LIVE", - "VOD" - ], - "type": "string" - }, - "MonetizedStreamLayout": { - "enum": [ - "SINGLE", - "DOUBLE", - "LSHAPE_AD", - "LSHAPE_CONTENT" - ], - "type": "string" - }, - "DynamicDetail": { - "properties": {}, - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "AssetKeyDetails": { - "properties": { - "podDuration": { - "type": "number", - "format": "double" - }, - "eabnAdTagParameters": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "adBreakSelectionParameters": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "assetKey": { - "type": "string" - } - }, - "required": [ - "assetKey" - ], - "type": "object" - }, - "IGamProperties": { - "properties": { - "iu": { - "type": "string" - }, - "sz": { - "properties": { - "tv": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "default": { - "type": "string" - } - }, - "required": [ - "default" - ], - "type": "object" - } - }, - "required": [ - "iu", - "sz" - ], - "type": "object", - "additionalProperties": false - }, - "EABNVersion": { - "enum": [ - "V1", - "V2" - ], - "type": "string" - }, - "BumperAdDetails": { - "properties": { - "eabnAdTagParameters": { - "$ref": "#/components/schemas/DynamicDetail" - } - }, - "type": "object" - }, - "IMonetizedStream": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "streamId": { - "type": "string" - }, - "streamType": { - "$ref": "#/components/schemas/MonetizedStreamType" - }, - "origin": { - "type": "string" - }, - "segmentOrigin": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "assetKey": { - "type": "string" - }, - "networkCode": { - "type": "string" - }, - "originPath": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "backdropURI": { - "type": "string" - }, - "backdropURIGamProperties": { - "$ref": "#/components/schemas/IGamProperties" - } - }, - "required": [ - "streamId", - "layout" - ], - "type": "object", - "additionalProperties": false - }, - "IMonetizedStreamApiResponse": { - "properties": { - "id": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "created", - "deleted" - ] - }, - "type": { - "$ref": "#/components/schemas/ResourceType.MONETIZED_STREAM" - }, - "payload": { - "$ref": "#/components/schemas/IMonetizedStream" - } - }, - "required": [ - "id", - "state", - "type", - "payload" - ], - "type": "object", - "additionalProperties": false - }, - "ResourceType.MONETIZED_STREAM_REFERENCE_TIME": { - "enum": [ - "monetized-stream-reference-time" - ], - "type": "string" - }, - "IMonetizedStreamReferenceTime": { - "properties": { - "date": { - "type": "string" - }, - "pts": { - "type": "number", - "format": "double" - }, - "engineId": { - "type": "string" - } - }, - "required": [ - "date", - "pts" - ], - "type": "object", - "additionalProperties": false - }, - "IMonetizedStreamReferenceTimeApiResponse": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/ResourceType.MONETIZED_STREAM_REFERENCE_TIME" - }, - "state": { - "type": "string", - "enum": [ - "created", - "deleted", - "updated" - ] - }, - "payload": { - "$ref": "#/components/schemas/IMonetizedStreamReferenceTime" - } - }, - "required": [ - "id", - "type", - "state", - "payload" - ], - "type": "object", - "additionalProperties": false - }, - "ScteParams": { - "properties": { - "uniqueProgramId": { - "type": "number", - "format": "double" - }, - "segmentationTypeId": { - "type": "number", - "format": "double" - }, - "eabnAdTagParameters": { - "$ref": "#/components/schemas/DynamicDetail" - } - }, - "type": "object", - "additionalProperties": false - }, - "IMonetizedStreamEarlyReturn": { - "properties": { - "date": { - "type": "string" - }, - "pts": { - "type": "number", - "format": "double" - }, - "id": { - "type": "string" - }, - "duration": { - "type": "string" - }, - "spliceEvent": { - "$ref": "#/components/schemas/ScteParams" - }, - "engineId": { - "type": "string" - } - }, - "required": [ - "date" - ], - "type": "object", - "additionalProperties": false - }, - "IMonetizedStreamUpdate": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "streamType": { - "$ref": "#/components/schemas/MonetizedStreamType" - }, - "origin": { - "type": "string" - }, - "segmentOrigin": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "originPath": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "backdropURI": { - "type": "string" - }, - "backdropURIGamProperties": { - "$ref": "#/components/schemas/IGamProperties" - } - }, - "type": "object", - "additionalProperties": false - }, - "ResourceType.AD_BREAK": { - "enum": [ - "adbreak" - ], - "type": "string" - }, - "AdBreakInsertionType": { - "enum": [ - "REPLACE", - "INSERT" - ], - "type": "string" - }, - "SignaledAdBreakStatus": { - "enum": [ - "new", - "future", - "signaled", - "finished", - "error", - "continuous" - ], - "type": "string" - }, - "AdbreakInternalType": { - "enum": [ - "BUMPER", - "ORIGINAL" - ], - "type": "string" - }, - "LifeCycle": { - "enum": [ - "NEW", - "FUTURE", - "ERROR", - "SCHEDULED", - "DECISIONED", - "COMPLETED", - "ENDED" - ], - "type": "string" - }, - "IAdBreak": { - "properties": { - "id": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "duration": { - "type": "number", - "format": "double" - }, - "source": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "assetURI": { - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/SignaledAdBreakStatus" - }, - "asset_key": { - "type": "string" - }, - "network_code": { - "type": "string" - }, - "backdropURI": { - "type": "string" - }, - "backdropURIGamProperties": { - "$ref": "#/components/schemas/IGamProperties" - }, - "startPts": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "startDate" - ], - "type": "object", - "additionalProperties": false - }, - "IAdBreakApiResponse": { - "properties": { - "payload": { - "$ref": "#/components/schemas/IAdBreak" - }, - "type": { - "$ref": "#/components/schemas/ResourceType.AD_BREAK" - }, - "state": { - "type": "string", - "enum": [ - "created", - "deleted" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "payload", - "type", - "state", - "id" - ], - "type": "object" - }, - "IAdBreaksApiResponse": { - "properties": { - "payload": { - "items": { - "$ref": "#/components/schemas/IAdBreak" - }, - "type": "array" - }, - "type": { - "$ref": "#/components/schemas/ResourceType.AD_BREAK" - }, - "state": { - "type": "string", - "enum": [ - "created", - "deleted" - ] - }, - "id": { - "type": "string" - } - }, - "required": [ - "payload", - "type", - "state", - "id" - ], - "type": "object" - }, - "IAdBreakUpdate": { - "properties": { - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "duration": { - "type": "number", - "format": "double" - }, - "source": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "assetURI": { - "type": "string" - }, - "status": { - "$ref": "#/components/schemas/SignaledAdBreakStatus" - }, - "asset_key": { - "type": "string" - }, - "network_code": { - "type": "string" - }, - "backdropURI": { - "type": "string" - }, - "backdropURIGamProperties": { - "$ref": "#/components/schemas/IGamProperties" - }, - "startPts": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "type": "object", - "additionalProperties": false - }, - "OverlayTypes": { - "enum": [ - "image" - ], - "type": "string" - }, - "OverlayURITypes": { - "enum": [ - "png", - "svg" - ], - "type": "string" - }, - "IOverlay": { - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - }, - "startDate": { - "type": "string" - }, - "endDate": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "type": { - "$ref": "#/components/schemas/OverlayTypes" - }, - "position": { - "properties": { - "bottom": { - "type": "number", - "format": "double" - }, - "top": { - "type": "number", - "format": "double" - }, - "right": { - "type": "number", - "format": "double" - }, - "left": { - "type": "number", - "format": "double" - } - }, - "type": "object" - }, - "size": { - "properties": { - "height": { - "type": "number", - "format": "double" - }, - "width": { - "type": "number", - "format": "double" - } - }, - "required": [ - "height", - "width" - ], - "type": "object" - }, - "opacity": { - "type": "number", - "format": "double" - }, - "gamProperties": { - "$ref": "#/components/schemas/IGamProperties" - }, - "resourceURI": { - "items": { - "properties": { - "tv": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "default": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/OverlayURITypes" - } - }, - "required": [ - "default", - "type" - ], - "type": "object" - }, - "type": "array" - }, - "clickThroughURI": { - "type": "string" - } - }, - "required": [ - "id", - "startDate", - "duration", - "type", - "position", - "size" - ], - "type": "object", - "additionalProperties": false - }, - "IOverlayApiResponse": { - "properties": { - "id": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "created", - "deleted" - ] - }, - "type": { - "type": "string", - "enum": [ - "overlay" - ], - "nullable": false - }, - "payload": { - "$ref": "#/components/schemas/IOverlay" - } - }, - "required": [ - "id", - "state", - "type", - "payload" - ], - "type": "object", - "additionalProperties": false - }, - "IOverlaysApiResponse": { - "properties": { - "id": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "created", - "deleted" - ] - }, - "type": { - "type": "string", - "enum": [ - "overlay" - ], - "nullable": false - }, - "payload": { - "items": { - "$ref": "#/components/schemas/IOverlay" - }, - "type": "array" - } - }, - "required": [ - "id", - "state", - "type", - "payload" - ], - "type": "object", - "additionalProperties": false - }, - "ScteParamsResponse": { - "properties": { - "uniqueProgramId": { - "type": "number", - "format": "double" - }, - "segmentationTypeId": { - "type": "number", - "format": "double" - }, - "eabnAdTagParameters": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "id": { - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object", - "additionalProperties": false - }, - "IScteParamMappingApiResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/ScteParamsResponse" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object", - "additionalProperties": false - }, - "MonetizedStreamApiResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/IMonetizedStream" - }, - "type": "array" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationDetails" - } - }, - "required": [ - "data", - "pagination" - ], - "type": "object", - "additionalProperties": false - }, - "AdbreakApiResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/IAdBreak" - }, - "type": "array" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationDetails" - } - }, - "required": [ - "data", - "pagination" - ], - "type": "object", - "additionalProperties": false - }, - "OverlayApiResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/IOverlay" - }, - "type": "array" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationDetails" - } - }, - "required": [ - "data", - "pagination" - ], - "type": "object", - "additionalProperties": false - }, - "ReturnType_typeofISharedTemplateSchema.validateSync_": { - "properties": { - "metadata": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "backdropURI": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "source": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "ISharedTemplateType": { - "$ref": "#/components/schemas/ReturnType_typeofISharedTemplateSchema.validateSync_" - }, - "ReturnType_typeofTemplateAssignmentSchema.validateSync_": { - "properties": { - "templateId": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "TemplateAssignmentType": { - "$ref": "#/components/schemas/ReturnType_typeofTemplateAssignmentSchema.validateSync_" - }, - "ReturnType_typeofAssignedTemplateDataSchema.validateSync_": { - "properties": { - "notReadyReason": { - "type": "string" - }, - "isReady": { - "type": "boolean" - }, - "metadata": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "backdropURI": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "source": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "AssignedTemplateDataType": { - "$ref": "#/components/schemas/ReturnType_typeofAssignedTemplateDataSchema.validateSync_" - }, - "TemplateAssignmentMultipleResponse": { - "properties": { - "eventId": { - "type": "string" - }, - "monetizedStream": { - "type": "string" - }, - "templates": { - "items": { - "$ref": "#/components/schemas/AssignedTemplateDataType" - }, - "type": "array" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationDetails" - } - }, - "required": [ - "eventId", - "monetizedStream", - "templates", - "pagination" - ], - "type": "object", - "additionalProperties": false - }, - "ReturnType_typeofTemplateAssignmentSingleResponseSchema.validateSync_": { - "properties": { - "template": { - "properties": { - "id": { - "type": "string" - }, - "notReadyReason": { - "type": "string" - }, - "isReady": { - "type": "boolean" - }, - "metadata": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "backdropURI": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "source": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "monetizedStream": { - "type": "string" - }, - "eventId": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "TemplateAssignmentSingleResponseType": { - "$ref": "#/components/schemas/ReturnType_typeofTemplateAssignmentSingleResponseSchema.validateSync_" - }, - "ReturnType_typeofAssignedTemplateDataUpdateSchema.validateSync_": { - "properties": { - "metadata": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "backdropURI": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "source": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "AssignedTemplateDataUpdateType": { - "$ref": "#/components/schemas/ReturnType_typeofAssignedTemplateDataUpdateSchema.validateSync_" - }, - "ReturnType_typeofSharedTemplateSchema.validateSync_": { - "properties": { - "id": { - "type": "string" - }, - "notReadyReason": { - "type": "string" - }, - "isReady": { - "type": "boolean" - }, - "metadata": { - "$ref": "#/components/schemas/DynamicDetail" - }, - "backdropURI": { - "type": "string" - }, - "assetURI": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "source": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "name": { - "type": "string" - } - }, - "type": "object", - "description": "Obtain the return type of a function type" - }, - "SharedTemplateType": { - "$ref": "#/components/schemas/ReturnType_typeofSharedTemplateSchema.validateSync_" - }, - "SharedTemplateResponse": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/SharedTemplateType" - }, - "type": "array" - }, - "pagination": { - "$ref": "#/components/schemas/PaginationDetails" - } - }, - "required": [ - "data", - "pagination" - ], - "type": "object", - "additionalProperties": false - }, - "ISharedTemplate": { - "properties": { - "name": { - "type": "string" - }, - "duration": { - "type": "number", - "format": "double" - }, - "source": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "assetURI": { - "type": "string" - }, - "backdropURI": { - "type": "string" - }, - "metadata": { - "properties": {}, - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object", - "additionalProperties": false - }, - "ISharedTemplateUpdate": { - "properties": { - "duration": { - "type": "number", - "format": "double" - }, - "source": { - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - }, - "assetURI": { - "type": "string" - }, - "backdropURI": { - "type": "string" - }, - "metadata": { - "properties": {}, - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - }, - "type": "object", - "additionalProperties": false - } - }, - "securitySchemes": { - "apiKeyAuth": { - "type": "apiKey", - "name": "X-API-KEY", - "in": "header" - } - } - }, - "info": { - "title": "THEOads Api", - "version": "25.9.0", - "description": "The THEOads REST API allows you to create and manage monetized streams, which are deployments of signaling services. Each monetized stream corresponds to an origin stream that is monetized using THEOads (SGAI). For detailed information on the various parameters and their usage, please refer to the getting started guide.", - "license": { - "name": "UNLICENSED" - }, - "contact": {} - }, - "openapi": "3.0.0", - "paths": { - "/v1/monetized-streams": { - "get": { - "operationId": "GetMonetizedStreams", - "responses": { - "200": { - "description": "List of monetized streams", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/IMonetizedStreamApiResponse" - }, - "type": "array" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "description": "Retrieves all created and deployed monetized streams (signaling services) along with their configurations.", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [] - }, - "post": { - "operationId": "CreateMonetizedStream", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStreamApiResponse" - } - } - } - } - }, - "description": "Creates and deploys a new monetized stream in the environment, resulting in a deployment of a signaling service.", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [], - "requestBody": { - "description": "The monetized stream configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStream", - "description": "The monetized stream configuration" - } - } - } - } - } - }, - "/v1/monetized-streams/{monetizedStreamId}": { - "get": { - "operationId": "GetMonetizedStream", - "responses": { - "200": { - "description": "A monetized stream", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStreamApiResponse" - } - } - } - } - }, - "description": "Retrieves a single monetized stream (signaling service) based on its identifier, along with its configuration details.", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "patch": { - "operationId": "UpdateMonetizedStream", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStreamApiResponse" - } - } - } - } - }, - "description": "Updates a single monetized stream (signaling service) based on its identifier, along with its configuration update.", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The monetized stream configuration update", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStreamUpdate", - "description": "The monetized stream configuration update" - } - } - } - } - }, - "delete": { - "operationId": "DeleteMonetizedStream", - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStreamApiResponse" - } - } - } - } - }, - "description": "Deletes a single monetized stream (signaling service) based on its identifier.", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ] - } - }, - "/v1/monetized-streams/{monetizedStreamId}/layout": { - "patch": { - "operationId": "UpdateMonetizedStreamLayout", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IMonetizedStreamApiResponse" - } - } - } - } - }, - "description": "Updates the default layout for an existing monetized stream (signaling service).", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The layout configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "layout": { - "$ref": "#/components/schemas/MonetizedStreamLayout" - } - }, - "required": [ - "layout" - ], - "type": "object", - "description": "The layout configuration" - } - } - } - } - } - }, - "/v1/monetized-streams/{monetizedStreamId}/break": { - "post": { - "operationId": "CreateMonetizedStreamBreak", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IAdBreakApiResponse" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "description": "Creates an ad break on an existing monetized stream (signaling service).", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The ad break configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IAdBreak", - "description": "The ad break configuration" - } - } - } - } - }, - "get": { - "operationId": "GetMonetizedStreamBreaks", - "responses": { - "200": { - "description": "A monetized stream", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IAdBreaksApiResponse" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "description": "Retrieves all adbreaks linked to the monetized sctream", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ] - } - }, - "/v1/monetized-streams/{monetizedStreamId}/break/{adbreakId}": { - "delete": { - "operationId": "DeleteMonetizedStreamBreaks", - "responses": { - "200": { - "description": "An abreak", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IAdBreakApiResponse" - } - } - } - } - }, - "description": "Deletes an adbreak linked to the monetized sctream", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The adbreak identifier.", - "in": "path", - "name": "adbreakId", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "patch": { - "operationId": "UpdateMonetizedStreamBreaks", - "responses": { - "200": { - "description": "An adbreak", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IAdBreakApiResponse" - } - } - } - } - }, - "description": "Patches an adbreak linked to the monetized sctream", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The adbreak identifier.", - "in": "path", - "name": "adbreakId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IAdBreakUpdate" - } - } - } - } - } - }, - "/v1/monetized-streams/{monetizedStreamId}/overlay": { - "post": { - "operationId": "CreateMonetizedStreamOverlay", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IOverlayApiResponse" - } - } - } - } - }, - "description": "Creates an overlay on an existing monetized stream (signaling service).", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The overlay configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IOverlay", - "description": "The overlay configuration" - } - } - } - } - }, - "get": { - "operationId": "GetMonetizedStreamOverlays", - "responses": { - "200": { - "description": "A monetized stream", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/IOverlaysApiResponse" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "description": "Retrieves all overlays linked to the monetized sctream", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - } - ] - } - }, - "/v1/monetized-streams/{monetizedStreamId}/overlay/{overlayId}": { - "delete": { - "operationId": "DeleteMonetizedStreamOverlay", - "responses": { - "200": { - "description": "A monetized stream", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IOverlayApiResponse" - } - } - } - } - }, - "description": "Deletes an overlay linked to the monetized sctream", - "tags": [ - "Monetized-Stream" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "overlayId", - "required": true, - "schema": { - "type": "string" - } - } - ] - } - }, - "/v2/monetized-streams": { - "get": { - "operationId": "GetMonetizedStreamsPaginated", - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/MonetizedStreamApiResponse" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "tags": [ - "Monetized-Stream-V2" - ], - "security": [], - "parameters": [ - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "double", - "type": "number" - } - }, - { - "in": "query", - "name": "skip", - "required": false, - "schema": { - "format": "double", - "type": "number" - } - } - ] - } - }, - "/v2/monetized-streams/{monetizedStreamId}/break": { - "get": { - "operationId": "GetMonetizedStreamBreaksPaginated", - "responses": { - "200": { - "description": "A monetized stream", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/AdbreakApiResponse" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "description": "Retrieves all adbreaks linked to the monetized stream", - "tags": [ - "Monetized-Stream-V2" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "double", - "type": "number" - } - }, - { - "in": "query", - "name": "skip", - "required": false, - "schema": { - "format": "double", - "type": "number" - } - } - ] - } - }, - "/v2/monetized-streams/{monetizedStreamId}/overlay": { - "get": { - "operationId": "GetMonetizedStreamOverlaysPaginated", - "responses": { - "200": { - "description": "A monetized stream", - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/OverlayApiResponse" - }, - { - "type": "string" - } - ] - } - } - } - } - }, - "description": "Retrieves all overlays linked to the monetized sctream", - "tags": [ - "Monetized-Stream-V2" - ], - "security": [], - "parameters": [ - { - "description": "The Monetized stream identifier.", - "in": "path", - "name": "monetizedStreamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "double", - "type": "number" - } - }, - { - "in": "query", - "name": "skip", - "required": false, - "schema": { - "format": "double", - "type": "number" - } - } - ] - } - } - }, - "servers": [ - { - "url": "/ads-client/api" - } - ] -} \ No newline at end of file diff --git a/ads/api/index.mdx b/ads/api/index.mdx new file mode 100644 index 000000000000..b963cbb4e8d9 --- /dev/null +++ b/ads/api/index.mdx @@ -0,0 +1,45 @@ +--- +title: Ads REST API +sidebar_label: REST API +--- + +# Ads REST API + +The Ads REST API manages channels, origins, marker rules, breaks, events, templates, and integrations under `/api/v1`. + +## Authentication + +Every request requires both: + +- HTTP Basic authentication, with the API key as the username and API secret as the password. +- The `X-Org-ID` header identifying the organization. + +```bash +curl 'https://ads.example.com/api/v1/channels' \ + -u "$ADS_API_KEY:$ADS_API_SECRET" \ + -H 'X-Org-ID: org_123' +``` + +Treat the secret like a password. The internal service authentication used between platform components is not a public API authentication method. + +## Reference + +Browse the [generated Ads REST API reference](/ads/api/reference/optiview-ads-api). Operations are grouped by resource. + +## Refresh the reference + +The reference is generated at build time from the committed OpenAPI contract in `Dolby-OptiView/optiview-ads`. The default URL is pinned to the ADS-109 contract commit so documentation builds remain reproducible without storing a second copy of `openapi.json`. + +```bash +npm run fetch-ads-openapi +npm run refresh-ads-api-docs +``` + +For a local checkout or a newer remote ref, override the source: + +```bash +ADS_OPENAPI_SPEC_URL=/path/to/optiview-ads/openapi.json npm run refresh-ads-api-docs +ADS_OPENAPI_REF=commit-or-branch npm run refresh-ads-api-docs +``` + +Private GitHub fetches use `ADS_OPENAPI_TOKEN`, `GITHUB_TOKEN`, or `GH_TOKEN`. Change the pinned commit in `scripts/fetch-ads-openapi.mjs` when intentionally refreshing the published contract, regenerate the pages, and commit the reviewed generated reference. diff --git a/ads/api/reference/delete-channels-channel-id-breaks-break-id.api.mdx b/ads/api/reference/delete-channels-channel-id-breaks-break-id.api.mdx new file mode 100644 index 000000000000..7941e5857b20 --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-breaks-break-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: delete-channels-channel-id-breaks-break-id +title: 'Delete /channels/{channelId}/breaks/{breakId}' +description: 'Delete a break.' +sidebar_label: 'Delete /channels/{channelId}/breaks/{breakId}' +hide_title: true +hide_table_of_contents: true +api: eJytVEtvm0AQ/iurOcXSUuqqJ26u4oPVSonSx8XiMIaxWRkvm93BCUX892oAP2JZTiv1BOy8vgezLeQUMm8cm8pCAvdUEpNCtfKE2w+gwaHHHTH5AMmyvUhf5GTZrA15Va0VF6SyAq2lUiqNZDjkAjRY3BEkMEYXOWjw9FwbTzkk7GvSELKCdghJC9w4SQ7sjd1A1+n3xx7hXhnax/5xZCrJwVU2UJD4p4+f5XEp1hrrktXTmClQoXLkURIWOSSQ93pGI+8QHQWIelQhOoFj3IjE8KUPQKphR1xUpy69GVxAAjE6E++n8aFt3B77dvHQOG7Hzh1oCJTV3nDTO7jCYLJZLY2WqYbKbwTpMhXOh8TvIszA/Cz9kv/scaG21Ki7OpAXsScKba4CZZ5Y3TkM4aXy+UR86aXu3ZB+QndQvGB20B1hXI548Bu05ncvqDJH249OF4Q5+ZPXr1HlN5HJTwPQma/U9NYYu656sw2XEnpwbH4ZelGzPKjZ4wI07MmHYfJ+KrBcFXiHVqrGCeOG/LX2b/i0kFWWyfLVVRsRM71y7Eo0VhDUvpS6wfml0BGYU9CHZQqgITlfrAGEnB5+rlRDUQWW+rZdYaCfvuw6OX6uyTfDj7BHb3AlwsiamyDvOSRrLAPdoHH3NC7VRN28Da6SO3hkGyGFZS1foGFLzZvbor8C/g+k22rfBnTQs0u7s+28n3+b/5hD1/0B6YnMMw== +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete a break. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-breaks.api.mdx b/ads/api/reference/delete-channels-channel-id-breaks.api.mdx new file mode 100644 index 000000000000..684f0357c913 --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-breaks.api.mdx @@ -0,0 +1,61 @@ +--- +id: delete-channels-channel-id-breaks +title: 'Delete /channels/{channelId}/breaks' +description: 'Bulk delete breaks by IDs.' +sidebar_label: 'Delete /channels/{channelId}/breaks' +hide_title: true +hide_table_of_contents: true +api: eJyFVMFu2zAM/RWBpxZwlmXYybd0ySFYgRZdt0uQA2MzsRpbUiU6rRf43wfKjpOmW5dLbPmReo985AFyCpnXjrU1kMJNXe5UTiUxqbUn3AW1btRiFj5BAg49VsTkA6TLw0XkIifDeqPJK7tRXJDKCjSGSonUgnDIBSRgsCJIof+6yCEBT8+19pRDyr6mBEJWUIWQHoAbJ+DAXpsttO2qA1PgG5s3gsisYTIsj+hcqTMUQuOnIKwOZ6mct448awrypvP49y8N4SiiLwLbviqf1JRVSRhYWUNKB3UkH3UyVTFvpc0tmS0XkE6SSxWJfF500NNX9B4baNvzciwjz9WAsesnyhjatygpWjwIzprQ6fvy+et7fTPaYF2yeuiR8TapSqzZIocUOpWjvjthNLRp1FUCEmDcigHgpjtYJVARF/YUHa0i0mGMTo/3k/Ex3fgw5GvHQ8JAWe01N9FVaww6m9YSvlwlYP1WeC1X0voj8Ic0tdN5Br9UO71fqB016qoO5MV11wpNrgJlnlhdOQzhxfr8WhoXbSIVjvlgKHjB7KRhPY3LK+78Fo3+Hcun9OCewfIFYU7+ZPrXkfXbkc5PF6DT36lru1j24WTu+StWrqTBrMujf1atZN/YOB+aBQJ3jvUvTS9qmgc1vV9AAnvyoWO5n4gEZwNXGIeiZzPr5vw/3Xmj+GzePt4VvTymVx67ErURCrUv4yRGcyxFu/CcQHLcBnJfer4Z1oPHChtYgg6HNQb66cu2lePnmnzTWWWPXuNayiHLSQd5ziHdYBnoAxlXD/0gXasPd9hfFR27aBpRgmUtb5DAjpo3O66VpvVuEHrd928didGjZDnFv9tj7fmMzea388e51KbfgJXNJcrji6xSfOkY2Cg1zkg8O0CJZlvjVrBdVvn9AfxoDMU= +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Bulk delete breaks by IDs. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-events-event-id.api.mdx b/ads/api/reference/delete-channels-channel-id-events-event-id.api.mdx new file mode 100644 index 000000000000..529619fa8da1 --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-events-event-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: delete-channels-channel-id-events-event-id +title: 'Delete /channels/{channelId}/events/{eventId}' +description: 'Delete /channels/{channelId}/events/{eventId}' +sidebar_label: 'Delete /channels/{channelId}/events/{eventId}' +hide_title: true +hide_table_of_contents: true +api: eJytVE1v2zAM/SsCTwkgz8uwk28BmkOwAS26j0uQg2oxsVBHUiU6rWf4vw/0V5K2++iwk22R5nt8j2IDXgV1QMIQIds0oDHmwXgyzkIGa42WzM5gEG4nqECRF8paLN+BBMMZXlEBEqw6IGQwRNcaJAR8qExADRmFCiXEvMCDgqwBqj0nRwrG7qFt5Z9h8YiWfgHaxd4IueXk6J2NGDn+4f1HflzSuMKdqkoSt0MmUwXnMShOWGvIQGOJhMnQd0wmAZKOVUxO5EjtWWJYdQHYyhdoXEqkY620mYq1aV8tbYZyLUg4IBXuxAFkL0sGqfImPS7+ulDEvAqG6s7/OxVNvqy40GYrwYU997nZsmJj4heWtdftLP25esubtbjHWsyqiIGtmgtltYiYByQx8yrGRxf0nF3tjGKDunosVu9XQeShnWg8h7gOe2XNj84OYaahmeakQKUxnCblKXFhnxh9AlDefMK6M9bYnetGxVDJoWtP5rvBR7HUUSxv1iDhiCH2yMcF0/Iu0kFZ/mtAeKuJF/1MY0r4RKkvlbGMUoWSY727G6bMVBYgx+sWQUJ2fvV6ID4dx28roXCR+P+muVMRv4Wybfn4ocJQ92YfVTDqjpvnRWAiv2vIdqqM+IJq7iyhJchgdjtcu7n47b54tbnRB1tzU6qs+Ask3GN9sU+6JfF/KE275B8IjXq22/bsBl6tPq++rqBtfwLVVNDK +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete /channels/\{channelId\}/events/\{eventId\} + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-events.api.mdx b/ads/api/reference/delete-channels-channel-id-events.api.mdx new file mode 100644 index 000000000000..c1216447034f --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-events.api.mdx @@ -0,0 +1,61 @@ +--- +id: delete-channels-channel-id-events +title: 'Delete /channels/{channelId}/events' +description: 'Delete /channels/{channelId}/events' +sidebar_label: 'Delete /channels/{channelId}/events' +hide_title: true +hide_table_of_contents: true +api: eJyNVE1v2zAM/SsCTy3gNMuwk2/ZmkOwAi26bpcgB8ZmbLW2pEp0Ws/wfx8oJ07a7MsX2xL19B75yA4ceqyJyQdIVx3kFDKvHWtrIIVlTob1VpNXdqu4JJWVaAxVV5CAlgiHXEICBmuCFPa7yxwS8PTcaE85pOwbSiBkJdUIaQfcOgkO7LUpoO/XQzAF/mzzViIya5gMyyc6V+kMhdD0MQir7gTKeevIs6YgfzqPrz9pCAcRtCPDQbFVOVXEdKXmrCrCwMoaUjqoA/mok6mOuLU2N2QKLiGdJe9VJLK9HEKPu+g9ttD3p+lYRZ7rMcZuHilj6N9GSdLiQnDWhEHfxw+fzvVd0xabitX9PjLeJlmJOVvmkMKgcrKvTpiMZZoMmYAEGAsxACyGhXVydotAqOkBY9qNIP10RKmJS3u8EZLBHylM0enpbvaP44GyxmtuoxM3GHQ2b+T4ap2A9YVoWa3FLofAb2KEITcn4e8zNL9bqidq1UUTyItTLxWaXAXKPLG6cBjCi/X5pRQ7WkuqEvFgLFLJ7KTIexrvr7j1BRr9M6Zc6dFxY5uUhDn5Y6O8TqwvJjo/XoBOf6XBKmLz+2NDLF6xdhWNBl8dPLfuBX1rY09plhC4dax/aHpR8zyo+d0SEtiRDwPL3UwkOBu4xthIezb/V9w3iscuZnrlqatQG8FufBXbMlZ9JaKEwAySw2gQoPR0TNBouNIGlkNdt8FA333V97L83JBvBw/s0GvciE6ZVDrIdw7pFqtAZ/zGGQIX9/uuulR/HWi/VXQoj2lFCVaN/EECT9S+GXi9VGNfZqE37H8ZSEweBOV4/myoianH5rle3CweFpDAZj8Oa5vLKY8vMlfxZWBgo9Ro/rjWQYWmaLCQ2AFVnl/eXQTl +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete /channels/\{channelId\}/events + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-integrations-channel-integration-id.api.mdx b/ads/api/reference/delete-channels-channel-id-integrations-channel-integration-id.api.mdx new file mode 100644 index 000000000000..17b70ce72cd1 --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-integrations-channel-integration-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: delete-channels-channel-id-integrations-channel-integration-id +title: 'Delete /channels/{channelId}/integrations/{channelIntegrationId}' +description: 'Delete a channel integration.' +sidebar_label: 'Delete /channels/{channelId}/integrations/{channelIntegrationId}' +hide_title: true +hide_table_of_contents: true +api: eJytVEuP2jAQ/ivWnEAyTal6yg1pOaBW2tX2cUE5mGRIrA22156wm0b579WEEEJUIar2RPCMZ77HjBvIMKReO9LWQAwPWCKhUCItlDFYCm0Ic684/AEkOOXVAQl9gHjbTC5vMjSk9xq9sHtBBZ6r8E3NGU5RARKMOiDE0Ec3GUjw+FppjxnE5CuUENICDwriBqh2nBzIa5ND28q7207B34BwSfxLNAknB2dNwMDxTx8/889U1b2qShLPfSazAOtw6BhD1gm/6PGExaDNYkTicjzBSypnQ2B0HiCRcEAq7KV8ZyAVEEOknI6Oy+jcL2qGhm007ngJjFu2ICFgWnlNdTcIOxV0uqq49jaRYH3OrLYJ63NO/MYinlQapU+1Wj1txAvWYlYF9OzSXCiTiYCpRxIzp0J4sz6bs6GdLWxHV491OLlTEDloBxjTFo8+V0b/6rgIPUzPMCIFqgz9ZUjeF9bnC51dGiinv2Dd2ajN3naDoank0KMj/VPjm1hlQayeNiDhiD6cOh+XDMvZQAdl+FbfoV+7f7HjimIDqTWEhu5Y6Z4S4TtFrlTaMMTKl1zlNC1b5ss8liDPGxNAQjxe4DHKcexqUhMJhQ3EJZtmpwL+8GXb8vFrhb4+Dc9Rea12LCa/MDrwdwbxXpUBb/CcPfdLOxc3H6I/8j37amrmqcqK/4GEF6yvHqru9fmvkO6y4z54V1K3STva/4f11/X3NbTtbywOD80= +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete a channel integration. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-marker-rules-marker-rule-id.api.mdx b/ads/api/reference/delete-channels-channel-id-marker-rules-marker-rule-id.api.mdx new file mode 100644 index 000000000000..58b70d7748ac --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-marker-rules-marker-rule-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: delete-channels-channel-id-marker-rules-marker-rule-id +title: 'Delete /channels/{channelId}/markerRules/{markerRuleId}' +description: 'Delete a marker rule.' +sidebar_label: 'Delete /channels/{channelId}/markerRules/{markerRuleId}' +hide_title: true +hide_table_of_contents: true +api: eJytVMlu2zAQ/RViTglAV03Rk24G4oPRFgnS5WL4MJHGFhGZYoYjJ6qgfy9GklcE7oKetPCRb5kZtpBTzNgFcZWHFG6pJCGDZoP8RGy4LukdWAjIuCEhjpAu2rNN85y8uJUjNtXKSEEmK9B7KnWnU0RAKcCCxw1BCuPqPAcLTM+1Y8ohFa7JQswK2iCkLUgTFByFnV9D19nf056JfoN6QDzUJf0l+1LBMVQ+UtT1D+8/6uM8vRXWpZiHEamqoQrEqIB5DinkfcCTMYI42WcxOUiLkzOZgmvNHb4M/noMLC1sSIrqcGpfJykghQSDS7Y3yY4mafc8XXJElLTHTB1YiJTV7KTpy/yI0WXTWo9cLC1UvFYPi6WmsQN+1ciGTI7g58lM7+fmiRpzVUdircW1QZ+bSBmTmKuAMb5UnF9r2foiaPj9eWp/qEUhEqDbyzinuOM1evezj9q4fW/sG6EgzIkPrfA6qXg9cfmBAIP7RE1fNOdXVd8GTkpdugvifjh6MdM8mun9HCxsiePAvL1RWaGKskGvu0aGcZj+oQonzlrIKi/k5cJ8jg6EXiUJJTqvimoudffQEwu1p7JvwO4mMIKF9Hgaj0Tp0kkbLi0UVRQ9qW0fMdJ3LrtOfz/XxM3QIltkh48amd4SLup7DukKy0gXbF09jIN4bS5eJm/a3FXPN2oPy1q/wMITNSeXTX+D/B9Jf5L+ZVkn0XbL7miYb2efZ99m0HW/AIhY7I4= +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete a marker rule. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-marker-rules.api.mdx b/ads/api/reference/delete-channels-channel-id-marker-rules.api.mdx new file mode 100644 index 000000000000..08fcadaf1d9a --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-marker-rules.api.mdx @@ -0,0 +1,61 @@ +--- +id: delete-channels-channel-id-marker-rules +title: 'Delete /channels/{channelId}/markerRules' +description: 'Bulk delete marker rules by IDs.' +sidebar_label: 'Delete /channels/{channelId}/markerRules' +hide_title: true +hide_table_of_contents: true +api: eJyNVE1v2zAM/SsCTy3gLMuwk2/pkkOwDi2ybpcgB8ZmbDW2pEpyUi/wfx8oOZ/divpiW6Ko9x4fuYecXGal8VIrSOGuqTYip4o8iRrthqywTUVOrFoxm7hPkIBBizV5sg7Sxf7q/Cwn5eVakhV6LXxJIitRKar4pOQIg76EBBTWBCn0u7McErD00khLOaTeNpSAy0qqEdI9+NZwsPNWqgK6bhmDyfk7nbcckWnlSXn+RGMqmSEDGj47RrU/S2WsNmS9JMd/Mg+v/3FwBxIXUnjdK/RJjL2oCJ0XWpGQThwoBLae6pC9luqeVOFLSEfJNZeEt2cx9LSL1mILXXcuyiKgXR5j9OqZMg/dZRRLFxac0cpFll8+f33LckJrbCov5n1kuI21CcrNckghshz0NXKDY7EGUY85ywEJeCzYC/AjqhSXlwnU5Et9ShS8wyrAEI0cbkfDQ+bh/pi6G17mdpQ1Vvo2eG2FTmbjhnMslgloWzDOxZINcQj8yaWOvM/Cr9mPH2diQ624aRxZ9uKtQJULR5klL24MOrfTNr/lQgbzsOIhHxwLUHpvuIA9jOsrHmyBSv4Jcgp59NSxEUrCnOypFV4H2hYDmZ8uQCO/U7QBG3l+svz0FWtT0dHCi4Oflh1nX+vQNdJzCDwYL39L2olx7sT4cQYJbMm6iHI7YgpGO19jaJUezSTOgI+U6IL2WSt+ZJj0TD29+qGpUCpG09gqtGowy4JlYMgjSA7jgm9Nz0fHOaBlAqV2nk/u9yt09MtWXcfLLw3ZNlpni1biiuXhESYdf+eQrrFy9A6jm3nfaLfi3Un3T1qHqqqW6WDV8B8ksKH2YhJ2XMTeHQwv7n+LIAZPnOV0/s20684bbzK9nz5NIYFVPydrnfMpizseuLiLCHSgGnomrO2hQlU0WHBszMrPX1V1Hk0= +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Bulk delete marker rules by IDs. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id-origins-origin-id.api.mdx b/ads/api/reference/delete-channels-channel-id-origins-origin-id.api.mdx new file mode 100644 index 000000000000..fc461853b3ba --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id-origins-origin-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: delete-channels-channel-id-origins-origin-id +title: 'Delete /channels/{channelId}/origins/{originId}' +description: 'Delete an origin within a channel.' +sidebar_label: 'Delete /channels/{channelId}/origins/{originId}' +hide_title: true +hide_table_of_contents: true +api: eJytVE1v2zAM/SsCTymgzOuwk28BmkOwAS26j0uQg2IzNlFHUiU6rWf4vw+0HScNtm4ddrIt0o/vPYpsIceYBfJMzkIKN1ghozJWuUAFWfVEXJJVRmWlsRard6DBm2D2yBgipOv2AmGVo2XaEQbldopLPP+TJMMbLkGDNXuEFMboKgcNAR9rCphDyqFGDTErcW8gbYEbL8mRA9kCuk7/uewg4DdVh+Abi24kOXpnI0aJf3j/UR6XDu5MXbG6HzOFLDiPwUjCKocU8t7k+ag8zicL5gOtOD+jx6YQm+F2CMFGwx65dCegviNcQgqJ8ZQcrpMjctJO0F0yYiftEbwDDRGzOhA3fSO3JlK2qAVqvdHgQiF01xsRfkz8Iu4M8s/SL01Y3K3UAzZqVkcMYvmVMjZXEbOArGbexPjkQn4l3en9Fp97PFE82F4ye+gmGpclbkNhLP3oXVU0dX/qd4kmx3Dq+PPchWJO+amA8fQJm74/ZHeu7zhxJaFbz/Sd8Ekt8qgWdyvQcMAQh8qHa6HlXeS9sfLXWGGcnTe4/0JRC5mzjJb/dgxHGYzPnPjKkBVadagEargQa9Eo3K9BHwctgob0fOhGZnI8XbuNhtJFFoS23ZqI30LVdXL8WGNohvtxMIHMVvySJUBR3nNId6aK+Iq22f04cFfq1V3xS3nH1tlGZJmqli/Q8IDNi13SL4j/Q+m0R/6B0eRot+nOBvdm+Xn5dQld9xOy1uEW +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete an origin within a channel. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-channels-channel-id.api.mdx b/ads/api/reference/delete-channels-channel-id.api.mdx new file mode 100644 index 000000000000..6be2cb6263b8 --- /dev/null +++ b/ads/api/reference/delete-channels-channel-id.api.mdx @@ -0,0 +1,40 @@ +--- +id: delete-channels-channel-id +title: 'Delete /channels/{channelId}' +description: 'Delete a channel.' +sidebar_label: 'Delete /channels/{channelId}' +hide_title: true +hide_table_of_contents: true +api: eJx9U01v2zAM/SsCTwmgLMuwk2/BmkOwAS26j0uQA2MxsVBHUiU6rWfovw90nI8Ga0/+4CP53iPZgaFURhvYegcF3FFNTApVWaFzVH8CDQEj7okpJihW3U3C0pBju7UUld8qrug60woiIFegweGeoIAhujSgIdJzYyMZKDg2pCGVFe0Rig64DQJOHK3bQc5rAafgXaIk8S+fv8rjlvsWm5rV44CEnDX4QBEFsDRQgOnlTQYSaXLNhnEnAuHbEIS1hj1x5S+JvRlcQQFTDHZ6mE1PlabduVQGDYnKJlpue8M2mGw5byRvtdbg4064rNai6gT8KdKP2q7gtwrnD0v1RK0aNYmiGDpW6IxKVEZiNQqY0ouPZize92aKiX090Xf0tGIOkM80blvcxx06+7e3TNnzcM/TrAgNxcs8Xyc+7ibWXBpgsN+p7c23buv7cVquJXQf2P6x9KLmJqn5wxI0HCimY+fDTGgFn3iPTrKGDsNKvmf1G/odlN4xOX5nlQeKTK88DTVaJy2bWEvmcbIr4S+8ZqBPy5pAQ3FZlbWGyicWbNdtMNHvWOcsv58biu1xygeMFjeiWk7GJnk3UGyxTvQB6dHjcBNj9eFl/VfIaQCuFQFYN/IFGp6ofXN5eZ2vVvtu8WPxawE5/wMQS18b +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete a channel. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-origins-origin-id.api.mdx b/ads/api/reference/delete-origins-origin-id.api.mdx new file mode 100644 index 000000000000..09cf14d4c0f4 --- /dev/null +++ b/ads/api/reference/delete-origins-origin-id.api.mdx @@ -0,0 +1,40 @@ +--- +id: delete-origins-origin-id +title: 'Delete /origins/{originId}' +description: 'Delete an origin.' +sidebar_label: 'Delete /origins/{originId}' +hide_title: true +hide_table_of_contents: true +api: eJx9U8uO2zAM/BWBpwRQ6qboybcAm0PQAllsH5fAB8VibGEdSSvR2XUN/XtB23k02O7JDw7JmSHZg8ZYBuPJOAs5PGCDhEJZ4YKpjP0EErwK6oiEIUK+6+8SNhotmYPBINxBUI03iYYBXlENEqw6IuQwBjcaJAR8aU1ADTmFFiXEssajgrwH6jxjIwVjK0ipYHD0zkaMHP/y+Ss/7pkfVNuQeJqQkJIE5zEoBmw05KAHcYuRQ1zccCFVsTjYjiEoJByRanfNGnygGnLIlDfZaZlNZbL+XCeBhIhlGwx1g1N7FU25ajlrV0hwoWIau4IFnYE/WPUo6wZ+L271uBHP2IlZGzGwlXOhrBYRy4AkZl7F+OqCnrPrg4/s31CPxY121kQe0oXGfYttqJQ1fwa3hLlM9TLHGpXGcJ3k28KFamH0tYHy5ht2g+/GHtwwSUMNh7aezG+Dr2Klo1g9bkDCCUMcO5+WTMu7SEdlOWvqMO3i+0b/Q76H0llCS//Z4Ikg4RtlvlHGcsM2NJw5TnXH7JnVEuS0pBEk5JcdKSTULhIj+36vIv4KTUr8+6XF0I0TPqlg1J4V852YyO8a8oNqIn5AefY0ncJcfHRO76o4e287Zq+alr9AwjN2t+eWinSz0g/r7+ufa0jpL3QjWzg= +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete an origin. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-templates-template-id.api.mdx b/ads/api/reference/delete-templates-template-id.api.mdx new file mode 100644 index 000000000000..3882a3f9fabf --- /dev/null +++ b/ads/api/reference/delete-templates-template-id.api.mdx @@ -0,0 +1,40 @@ +--- +id: delete-templates-template-id +title: 'Delete /templates/{templateId}' +description: 'Delete a template.' +sidebar_label: 'Delete /templates/{templateId}' +hide_title: true +hide_table_of_contents: true +api: eJx9U0tv2zAM/isCTwmgLMuwk28BmkOwAS26bpcgB9ZiYqG2pEp0Ws/Qfx/ovIO1Jz/4UfweVA+GUhltYOsdFHBHNTEpVExNqJHpC2gIGLEhppigWPU3HUtDju3GUlR+o7iiq1YrkIBcgQaHDUEBx/LSgIZIr62NZKDg2JKGVFbUIBQ9cBcEnThat4Wc1wJOwbtESerfvn6Xxy39DbY1q8cDEnLW4ANFFMDSQAFmUDg5skiTKz6MWxEJT8cyrDU0xJU/9w6OcAUFTDHY6W42PR027c+nZdCQqGyj5W7w7RmTLeetdK7WGnzcCqHVWqQdgb9E/17gBfxW5vxhqV6oU6M2URRbxwqdUYnKSKxGAVN689GMJYHBUXFyOE8k7o2tmAPkE43bEfdxi87+HXxT9pTxKdOK0FA8p/o+8XE7seY8AIP9Qd2QgHUbP2RquZbSfWD7x9Kbmpuk5g9L0LCjmPaTdzOhFXziBp10HSYcVvNjs68E9FB6x+T4o6U+sGR652mo0TqZ2sZaWvfxrkSCUJsJ/LQQGoqLlVlrqHxiQff9Myb6Heuc5fdrS7HbR73DaPFZpMv1sUneDRQbrBN9wnv0eLgdY/X5LfuvlmMMrhMNWLfyBRpeqLu+hXmdL3b8bvFz8bSAnP8Be7dmyA== +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Delete a template. + + + Request + + + + + + + diff --git a/ads/api/reference/delete-templates.api.mdx b/ads/api/reference/delete-templates.api.mdx new file mode 100644 index 000000000000..1040029f1cd9 --- /dev/null +++ b/ads/api/reference/delete-templates.api.mdx @@ -0,0 +1,59 @@ +--- +id: delete-templates +title: 'Delete /templates' +description: 'Bulk delete templates by IDs.' +sidebar_label: 'Delete /templates' +hide_title: true +hide_table_of_contents: true +api: eJyFVE1v2zAM/SsCTy3gNMuwk2/ZkkOwAi26bhcjB8ZmbLW2pEp0Us/wfx8oe/noDssltvhEvkc+uoeCQu61Y20NpPC1rV9VQTUxKabG1cgU1K5Tm1W4gwQ8vbUU+KstOkh7yK1hMiyP6Fytc5Q885cgyXoIeUUNypPz1pFnTUHedBH/rktvCjKs95p8UHavuLpkwHZidaeWrGrCwMoaUjoooaQ9FUJPMzUxdaPNPZmSK0gXCXDnCFII7LUpYUgkvBmh5yh6jx0MwyhSMkKaRarbE8buXihnGK5R7FuKB8FZE0aJnz99+VfiivbY1qyeJmSsJo2JbdsUkMKocnZSDgkwlkGoPJ/Otgk0xJU9X4AEHIpamKPT88NifpkhUN56zR2kWQ87DDpftgLOtglYX0rhbDtsz8AfMrhRyAX8o5zl40a9Uqdu2kDeYEO3Ck2hAuWeWN04DOFofXErk4lWkBbGfHDqaMXsZCITjY8lHnyJRv+O/VH65JA4a4lXhAV5SEDKQwrvM+vLmS7OBdDp7zTOVWz5dDbw+h0bV9PJkNlfg2wHyb63EmHNAoEHx/qXpqNaFkEtHzeQwIF8GFkeFiLB2cANRuNPbFbjIl3N4krfxQb9d/UmPUzvPHc1aiM1W1/H9Yqzz0SsEFsI/NItlQ0s8b7fYaCfvh4GOX5ryXejDQ7oNe5Eaibyp76KX16pgxS+jTxnz8JC4HU7dvfD1g+X3lyt79fPa0hgN30vGlvILY9H+ZbgEVIA2QC5H90Wz3qo0ZQtloIds8rvD96qmKw= +sidebar_class_name: 'delete api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Bulk delete templates by IDs. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-breaks-active.api.mdx b/ads/api/reference/get-channels-channel-id-breaks-active.api.mdx new file mode 100644 index 000000000000..977c21ccf87e --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-breaks-active.api.mdx @@ -0,0 +1,4058 @@ +--- +id: get-channels-channel-id-breaks-active +title: 'Get /channels/{channelId}/breaks/active' +description: 'List the currently active breaks for the channel within the DVR window.' +sidebar_label: 'Get /channels/{channelId}/breaks/active' +hide_title: true +hide_table_of_contents: true +api: eJztXVtzG7eS/iuoqX0Qa0mJcnyyDvPg0ol9sqqVY5V8ObUraZfgoEkimgHGAIY0I+u/bzWAuZAcRZIvx47ZeXDEGQzQAPrydX8D8joRYFMjCye1SkbJibSOuTmwtDQGlMtWjKdOLoBNDPAry6bahPtzrhRkbCndXCp/6dnbM7aUSujlftJPCm54Dg6MTUbn1xvDHAtQTk4lGKan7f7wSYktCu7mST9RPIdklMS7xyLpJwbeldKASEbOlNBPbDqHnCej68StCmxsnZFqltzcXGJjW2hlweL9R8Mh/i/VyoFy+CcvikymHKU6+N2iaNet/rgQEm/x7NToAoyT2M+UZxb6SdG6dJ0I7vwj0kFuH/hsM7nRvdeJubm0YU/YBDKtZpY5jauXS3UCaubmyeiwv7kkfT95o7O7ZVwX5GURGrIi46sJT69Y1VGtEV6YPrNlOmfcMnslC8aVYFbxwj8xgTlfSG28dqytALZ9OZ1acNtL8FuZT8L0LaRaCesHW0hYgmF5aR1bcpfO2QSm2kAjCZtAqnMIghR8ksE+eyGVzMucDeNC4YdkNKyXSfmxcJkqobfl+ecc3BxMWwppGc8yvQTBnGYW4IrpBbRWZZ/9cw6KgUIxRJ/x6klsK9Vsozl2aMCVRoUe8YZ13LhKCUIrXFzcDsukY1KxaZllPzOtUljvSmgF/WbjDNgS14UHQ9dGziTurJe70NarRJR4TVDLpIrSxL12c1gxboDxzOqHiNySuM/41IFhy7lM57dKKWDKy8zFy6zQUjm2Fz4Fzemzth4yURpv1myJ81DaMQuuF6eFHwsDFpTrP2wjk1pXJlpnwFVyc1Nf0pPfIXXeygxwB+KoQ59fyxys43kRJGskXnLL4nN9NCCu2PGrl+zJj8NDJrgDJ3NcUzTklhiNZVcz3h7y7+srIlVlSg+xCDBGmxdgLZ/B9hD/WeZcDQxwgSrODHCr25MD5cCAYM/Pzl6eoWa40u6z07AHTKtsFZYj3MGN8C07JwoLUO5+3tI37faVfSanjKtV5xCyo/c3Sr4rgcmtQeL2NYGwFcvu8MY5N1dgnoGDFEfpmtQ/tGG8dHogfCsQMRIHxd2WJnTJRNUnM5BqI5ibc1R6LcoU1btekn12NPGbgH48Bvmohmwhue/z6PS4c5nCWGdlBp9RclNmEKTN0bGDCFGkxFDtJQfmIC8y7uBTZA9+7za5Y2fr4k+NzhlHGwSeR3Fvm0zoni3n2qK7yjJ083VPzXQ/ZQpt97c9jXC9Ze1VyPaiLOdggEUo1OF2vU/eDGBbfnPD10rLSosbFoJ0dNbaC9IdUbx75S0TqnHFfo0b6rC51ScOKGdKm6gkLVceoxmGiUoqp+PTDwICGMQ8WFKrl1MPZafa5NwlIwR9MEC37OGuc2Bw3f937+lo7+no4kJcXIjzR49/fHJ5Pnz85PJDvHL4w9/+46fL80c/VleG53j3fNg0HQ4/tJoNh73B8NHg0U/Y/vrxzSAMMPRNnlx+ODwfPrrsDcKlwU+XH84PH11eXIgPP5wPDy97H/yNxz/+dPnh8LCz2TC0edS+eYh3Hp0PB08ue73e6zAk9ldd/+GyNzofDv6GF/aejtp/X1zsX1yIf+897T3dezr6n17v3zq09/rP1v1yE3++QkdQZiA6UMU+e6nYkmdZmmkEpsH7/mkARZjETl+/ajX2H8P4azaZlrXjYnzJpUPr4VEM7HI/qokr7bYRnsgppKs0gyqy6Wml7iM2Pj17fnp0dvzbr2O2V/cN71GRPCBzZdHrs/Evb54/G7O9wsBAQCqt1IiyJiv2q9azDNizo+N+t2z49Nnzo2f/PWZ7kMmZxOCMsxKQyQWYFTZ4dfzrb0cnfoh4ORgLOgUwtueR1djH4zHbm3KZgeih4YDC3TtP6mkk/QRlTfqJHzTpJ1XfST/xHSSXHX6scuf3i+lV63ZYb2En76Xr4M6OghMYSOUtlRmYgoGAkbn3DejUrqAInnKl0uCG1sJMl/NdcCO52nANWkH86wH5H7cWXIfuHPnrYRtETLOkZXHgfXbkWAbcInyCkDKExNjn0FUe+lES3Q4ln1WuPm6Gl70VY/oBxl0pvVQPcbMV4PIoPxklw/jfwP/zGP95Un2s/ks2ncStCC1I2UJo0W+cGr2QIthSKHpYp3N8LiKXGSgwXqsQkLM3b46fhQnqXDoXlvoOiCcR+fK0Ws6PyblbXdRJdJ12+7k1aTdnaSbTq4GbG13O5uzN2cl2vu2bvA4ttvf4l80OmC4APU6dsFTpUpTLNibDxT57gUn5BDDU80yKSoQ6bJZGbhtUVxaVg5D8tb+6KeMLvMXwCe9RVViGERvjfuqx91gy5zMYtx2Vv4nWgXc6XVEuc7hlxOMXz+sBG6XyMrI93A14z/MigyjDQV48HvfW7eEIk8uAjYJzRTeLoNDkUgEri6nRyuEjvsQgHUu5CgmzN30/5M9M492ltIAt5gi2NHNm1Wc599WEIFlhAGtwXmssJrWm04+5ztl63xOmKyTeyKXiTpt9NsZAJtPxiHEmpIHU1Siy8a2NNob10Yb5Na90odqQ0FfnTqCWdMOuTv3pf1ztzXEzAwybH2ubAhYSg0nVTwgrFjLwdhEsRlr25uy4AqLb9hg66da7Z3EA3ArfEyhnVnFAW6PqEAeL4NAss7AAw7MqWMScKypdJZ3PUxSEPCvIXtt2EKm9VwLsldMFLj3icYeuT09khujXLTr2sMukFzwrOyb5urYnXKc61IWprhlXS6PeHr16zRyfoVL17vTEN+3K8XkU5LLL60h1HDSp6YQbw1cdsPREp2vhMOhz5YxAejPmzEqFOA1daRDHQyr0WtgvPoy3cLYSLAOezoNH1bdp2f7WfCSWxhuHGSUPZtQxS4IDBAcIDhAc+HQ4sODWeTDQdsftORmwOluAF2sKSNVgqcaAErHC5BM3uVgLNtgrwQKCBX9NWFCLkEV88P1gAb8dpy1u/7ant+j4W22FC9a8LMAKHAFLuSHeRC5xAUrgMtlQf0etzHmxz/7R6EDfK0gsiR0J9oIrPgsuxoJnKbGjMRev+ayZwLjlBZvNJsRDiIcQDyGebsTjfZHHPOHPQe5djajMzFNrqLxvJSxZuGnjawyh7N6wVcGvtdtwwaoqf6T6693zjf8MFjX+o8h4CnOdCTBbbuJt5UxjZA1udNtzFjpOKQgWsYpbFTLlWbZipfLbiu9oBAynlZ9YqTzfJvRSBa705+r9Db9TnLWEu4cDidPe3iJRLV98y6vFbtTr5wWql92zL4vW9PfZL/WLbv4thPGM52O2t7UYa4THjOeduxB6/izRMezRwBaQyqlM2xFyKwi+RS/jnXQBJk7vZ78QYTacjXG0MZtKyESbKmB76cb0Cy3GvY6YeE+IEfeqH33c1oJsw4/LP8dWjdvc3P63AcOyjK906bbLlB5neSvF14wGNjUAKgLiqQwsuH9HRDlpan+Enr3Qxq1VKX1X3dTVZ08Utnmej4DyhUyv7gXk2VHVgQ9huJCNKNK/MmCl8Iwgr4w4SrQpAHtX8kxOV2wvLzMnMRBUVu8hbn21fqCdHQGzPPfyO9zwXj++RSF8mI1vh9XvmwmYSgzIaOgC7Kg999JGRzqVxrpmev5NjKBMa4ElvqcUDaGWYHfTsQ1Tj/bXr3jKz5JBPJju7IdUqODebXm4xVmq84IrH3aCM78XJcqz7FPoWsoNKDeg3IByAyJHqQpKVVAiRwkOEBwgOEBwgMhRggUEC4gcJXKUEA8hHkI8O4p4iBwlcpTI0c9Hjj7sq0QqQqTDb69zJWi4kWrh/ki8FAEDFEbmHI3Qt9rzyjpZsbHQ5SSDsVeZcWbnvID/42Jco2W/LkSoEJ4gPEF4gggVqpxQ5YQIFSJUCA4QHCA4QIQKwQKCBUSoEKFChAohHkI8hHiIUCFChQiVr0CobHTdMCb/uqNpkUoZeXwmYDBZDTz9EpsHi/ZYLMZ7y+wcVb/72Ev9TYY+1PL0amZ0qQTGLhkNvz3MGpz2ktDJNjrZthOpH51so8or5SGUh1AeQkQsVVyp4kpELMEBggMEBwgOEBFLsIBgARGxRMQS4iHEQ4iHEA8RsUTEEhFLJ9voZBvhCcIThCeIUKHKCVVOiFAhQoXgAMEBggNEqBAsIFhAhAoRKkSoEOIhxEOIhwgVIlSIUNnpk20NezJCX3oy8J/F+sm2aJw6TctCRmM9GUxxbvvseXPsbR6i0P0Ou0VfujFiW9lq2ei4Gx1324l88Js87nbPo2zEt1K6QekGpRvEt1Jh9asH0u+usEp8K8EBggMEB3YYDhDfSrCAYAHxrcS3EuIhxEOIZwcQD/GtxLcS3/r5DrB9SQo11ibv4lFRP+o6Ziejus2AxuZEgxINuhNp2telQcM390b4qhdgMr4iDpRSAEoBKAUgDpSKnX+VKPrdFTuJAyU4QHCA4MAOwwHiQAkWECwgDpQ4UEI8hHgI8ewA4iEOlDhQ4kC/cQ400iTBTKUteVYxJ5FOQY5LF03lBhW1Jvy8Zzdl4bE7+h88JtpWgdhXpxrogqfSrbZFfhkFiA3CTk6byOaWAIoN2d60RPtyhitbcNyfntfjw+qOLvi7EgK65e8Dqji8A2EU2sqPCcJR5urxNorAMFho4/bZWdANi76gIaVwbXGJDZto53TuJxFvZDB1eMfI2dxtR+jwQAf+ktZxLDHHfav2NA4AYgZsanQeUE64GJtW0vZvXXe/xg9aVJzF/YX0c14XMSzDlxPQL+/9JfTNN0QM176gjJg+3ltCVKh1+VpW/Pml64JlVv4BH2lF+CjKVklmNyXftoQ5dG9h1WW4vzHhjV5jo/4nbdNSCteBlis5/O07xPBtPkWKjTAUROpXa9SVt9PbKPQ2yvdWMLvjbZRWrI/O6pbvTv+0t0To7D6VbahsQ2Wbv0jZht5bIYKKCCp6b4XgAMEBggM7DwfovRWCBQQL6L0Vem+FEA8hHkI8O4B46L0Vem+F3lv5xt9bCTjLWym+6zGwqUGqNADiqcyyCtlirDS1P2rzx3WV0ndFZ/SJFd2JdOyb/KryfkiFCu7dlodbW79HcE9KlGdZrB0QOUq5AeUGlBsQOUpV0K8edr+7KiiRowQHCA4QHNhhOEDkKMECggVEjhI5SoiHEA8hnh1APESOEjlK5OjnI0cfBECa35ne9tsbv90spI1UC8+0miHLF1yPkTlHI/St9ryyTlZsLHQ5yWDsVab129I1WvbrQoQK4QnCE4QniFChyglVTohQIUKF4ADBAYIDRKgQLCBYQIQKESpEqBDiIcRDiIcIFSJUiFD5CoTKRtcNY/KvO5oWqZSRx2cCBpPVwNMva78o67FYjPfVL1d2H3sJaF8Gs8HvV54ZXSqBsUtGw28PswanvSR0so1Otu1E6kcn26jySnkI5SGUhxARSxVXqrgSEUtwgOAAwQGCA0TEEiwgWEBELBGxhHgI8RDiIcRDRCwRsUTE0sk2OtlGeILwBOEJIlSockKVEyJUiFAhOEBwgOAAESoECwgWEKFChAoRKoR4CPEQ4iFChQgVIlR2+mRbw56M0JeeDPxnsX6yLRqnTtOykNFYTwZTnNs+e94ce5uHKHS/w27Rl26M2Fa2WjY67kbH3XYiH/wmj7vd8ygb8a2UblC6QekG8a1UWP3qgfS7K6wS30pwgOAAwYEdhgPEtxIsIFhAfCvxrYR4CPEQ4tkBxEN8K/GtxLd+vgNsX5JCjbXJu3hU1I+6jtnJqG4zoLE50aBEg+5EmvZ1adDwzb0RvuoFmIyviAOlFIBSAEoBiAOlYudfJYp+d8VO4kAJDhAcIDiww3CAOFCCBQQLiAMlDpQQDyEeQjw7gHiIAyUOlDjQb5wDjTRJMFNpS55VzEmkU5Dj0kVTuUFFrQk/79lNWXjsjv4Hj4m2VSD21akGuuCpdKttkV9GAWKDsJPTJrK5JYBiQ7Y3LdG+nOHKFhz3p+f1+LC6owv+roSAbvn7gCoO70AYhbbyY4JwlLl6vI0iMAwW2rh9dhZ0w6IvaEgpXFtcYsMm2jmd+0nEGxlMHd4xcjZ32xE6PNCBv6R1HEvMcd+qPY0DgJgBmxqdB5QTLsamlbT9W9fdr/GDFhVncX8h/ZzXRQzL8OUE9Mt7fwl98w0Rw7UvKCOmj/eWEBVqXb6WFX9+6bpgmZV/wEdaET6KslWS2U3Jty1hDt1bWHUZ7m9MeKPX2Kj/Sdu0lMJ1oOVKDn/7DjF8m0+RYiMMBZH61Rp15e30Ngq9jfK9FczueBulFeujs3ow7NoqaR1VhauwQPXvziKQZpm0PkDUeuN9c60RH7NenYCzLstgxdAPlfSTdM6VguwYGyD/VuIC+HwExNEtPmFtrhsjCe54x1M3WxD9WbAddhayD/A9oTp6GY9FMkpm4AZRPjuoBR34NbQDdJILv+18ZnHov/vrOHgObq5jD7ifHD1vcsALebA4PKi6PLiu+7w5CJ0e1J1aSEvjYej5dTLhVqZHJfZyftlPtJmhfOeXuNFVw1fpHPKIvprmW1nX6TG7gpX/7nujeA4BmlpIDX4jPpbvltoIj02t7zEZhf6apGLuXOGBchBjK6KYGVfyj5BQNsUs/14T3p8DD2ktDp+MkvcDbWYDryHVzhbyvyBsrVRT7fMt6TKIft3n5UfCsqPTY5+lGBtGXhxGpOxy7oFyHOFXcOx+q742E/zJgfCe5Cg5QRtpubFsxcJDwaJsXc+Knbdx9rO3Z2wpldDLVmbm4L07KDIuVSgAZDheUJRzXACc2GFjH2gVo7athGHRawTZL/vJXFuHT19fT7iFNya7ucHL70owq6A43uzw595RqYS0+LfojqDtye/F/ED02PFWcTIKdevUqj1Vq6RmCpKkn1zBKhm1zN/7tKgbKF64f5SmULjWk7woMhnK8ge/W628s6vt7dfnr5Obm/8HDTK6rw== +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List the currently active breaks for the channel within the DVR window. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-breaks-break-id.api.mdx b/ads/api/reference/get-channels-channel-id-breaks-break-id.api.mdx new file mode 100644 index 000000000000..c38ba2d98139 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-breaks-break-id.api.mdx @@ -0,0 +1,3982 @@ +--- +id: get-channels-channel-id-breaks-break-id +title: 'Get /channels/{channelId}/breaks/{breakId}' +description: 'Get a break by ID.' +sidebar_label: 'Get /channels/{channelId}/breaks/{breakId}' +hide_title: true +hide_table_of_contents: true +api: eJztXV1z27iS/Sso1j5YtZIjZ3JnM5qHlO8kN+vaZOJykrm163hXENmSMCYBBgDlaBz/961ugBQl0WM7cW4yUc9DxiJBoAH0x+k+hHSZZOBSq0qvjE5GyXPwQoqJBXkuJktx9HQ/6SeltLIAD9Ylo9PLjSeOMtBeTRVYYabCz0Gkc6k15Pikwhal9POkn2hZQDJK4t2jLOknFt5XykKWjLytoJ+4dA6FTEaXiV+W2Nh5q/Qsubrq3zwsCX3NoHTvjkOeYWNXGu3A4f2HwyH+LzXag/b4pyzLXKUSJXrwu0OxLlv9ySxTeEvmx9aUYL3CfqYyd9BPytaly9aajG69vMLPlat3CnKjZ054g/MvlH4BeubnyeigvzmtPk3AmtzdKOO6IK/K0FCUuVxOZHou6o7E1NjVDvSFq9K5kE64c1UKqTPhtCzpiQnM5UIZS0q1tgLY9tV06sBvL8GvVTEJ03eQGp05Gmyh4AKsKCrnxYX06VxMYGosrCQRE0hNAUGQUk5y2BcvlVZFVYhhXCj8kIyGzTJpGguXqRZ6W55/zsHPwbalUE7IPDcXkAlvhAM4F2YBrVXZF/+cgxagUYysL2T9JLZVerbRHDu04CurQ494w3lp/Zqy0+LidjihvFBaTKs8/1kYncJ6V5nR0F9tnAVX4bpIT82MVTOFO0tyl8aRSkSJ1wR1QukoTdxrP4elkBaEzJ25i8gtiftCTj1YcTFX6fxaKTOYyir38bIojdJe7IVPQXP6oq2HIqssmaa4wHlo44UD34vTwo+lBQfa9++2kUmjKxNjcpAavVN9yUx+h9STlVmQHrLDDn1+owpwXhZlkGwl8YV0Ij7XRwOSWhy9fiUe/zg8EJn04FWBa4qG3BJjZdn1jLeH/Pv6iihdm9JdLAKsNfYlOCdnsD3Ef1aF1AMLMkMVFxakM+3JgfZgIRPPTk5enaBm+Mrti+OwB8LofBmWI9zBjaCWnROFBWh/O29JTbt9ZV+oqZB62TmE6uj9rVbvKxCqO/SIC+XnSm+GwBu8cSHtOdin4CHFUbom9Q9jhay8GWTUCrIwnguKuy1N6FJkdZ/CQmpsJvxcotKbrEpRvZsl2ReHE9oE9OOh61oNxUJJ6vPw+KhzmcJYJ1UO9yi5rXII0hbo2CELUaTCcEuSg/BQlLn08DmyB793ndyxs3Xxp9YUQqINgiyiuNdNJnQvLubGobvKc3TzTU+r6X7OFNrub3sa4XrL2uuQTaJczMGCiHCmw+2ST94MYFt+c8PXKicqhxsWgnR01oYE6Y4o5F5ly4QaXLHf4IYmbG71iQOqmTY2KknLlcdohmGilsqb+PSdgAAGMQJLevlqSgh4amwhfTJK0CsP0C0TSvYeLK77/+49Ge09Gb17l717l50+fPTj47PT4aPHZx/jlYMf/vYfP52dPvyxvjI8xbunw1XT4fBjq9lw2BsMHw4e/oTtLx9dDcIAQ2ry+Ozjwenw4VlvEC4Nfjr7eHrw8Ozdu+zjD6fDg7PeR7rx6Mefzj4eHHQ2G4Y2D9s3D/DOw9Ph4PFZr9d7E4bE/urrP5z1RqfDwd/wwt6TUfvvd+/2373L/r33pPdk78nof3q9f+vQ3ss/W/ezTfz5Gh1BlUPWgSr2xSstLmSep7lBYBq8758GUIRJ4vjN61Zj+hjGX7PJtGocl5AXUnm0HhnFwC73o5r4ym0b4Qs1hXSZ5lBHNjOt1X0kxscnz44PT45+fT4We03f8AEViQCZr8peX4x/efvs6VjslRYGGaTKKYMoa7IUz42Z5SCeHh71u2XDp0+eHT7977HYg1zNFAZnnFUGuVqAXWKD10fPfz18QUPEy8FY0CmAdT1CVmOKx2OxN5Uqh6yHhgMad+80aaaR9BOUNeknNGjST+q+k35CHSRnHX6sdue3i+l163ZYb2En8tJNcBeHwQkMlCZLFRamYCFgZEm+AZ3aOZTBUy51GtzQWpjpcr4LaZXUG67BaIh/3SH/k86B79CdQ7oetiGLaZZyIg68Lw69yEE6hE8QUoaQ3FIW7KGgLj9Jouuh5NPa1cfNINlbMaYfYNy5Nhf6Lm62BlyE8pNRMoz/DeifR/jP4/pj/V+y6SSuRWhByhZCi37j2JqFyoItEXCrnDcFPheRyww0WNIqBOTi7dujp2GCplDeh6W+AeIpRL4yrZfzU3LuVhdNEt2k3TS3VdotRZqr9Hzg59ZUs7l4e/JiO9+mJm9Ci+09/mWzA2FKQI/TJCx1uhTlciuTkdm+eIlJ+QQw1MtcZbUITdisrNo2qK4sqoBMyTd0dVPGl3hL4BPkUXVYhpEY436aMXksVcgZjNuOim6ideCdTldUqAKuGfHo5bNmwJVSkYxiD3cDPsiizCHK8KAoH4176/ZwiMllwEbBuaKbRVBoC6VBVOXUGu3xESoxKC9SqUPCTKZPQ/4sDN69UA6wxRzBlhHeLvuikFRNCJKVFrB0R1rjMKm1nX7Md86WfE+YbqbwRqG09MbuizEGMpWOR0KKTFlIfYMiV751pY1hfYwVtOa1LtQbEvrq3AnUkm7Y1ak//cuVz7uDp/PSzgDD5qfaZgYLhcGk7ieEFQc5kF0Ei1FOvD05qoHotj2GTrr17mkcALeCegLt7TIO6BpUHeJgGRyaEw4WYGVeB4uYc0Wlq6WjPEVDyLOC7I1tB5Hae5WBO/emxKVHPO7R9ZmJyhH9+kXHHnaZ9ELmVcck3zT2hOvUhLow1TXjamnUb4ev3wgvZ6hUvRs98VW7+nsaBTnr8jpKHwVNWnUirZXLDlj6wqRr4TDoc+2MQJEZS+GURpyGrjSIQ5AKvRb2iw/jLZytAidApvPgUc11Wra/NR+F5e2Vw4ySBzPqmCXDAYYDDAcYDnw+HFhI5wkMtN1xe04WnMkXQGJNAakaLNVY0FmsMFHiphZrwQZ7ZVjAsOCvCQsaEfKID74fLEDbcdx6JeC6p7co9WttRWZi9Y6BKHEELOWGeBO5xAXoDJfJhfo7amUhy33xj5UO9ElBYknsMBMvpZaz4GIcEEuJHY1l9kbOVhMYt7zgarMZ8TDiYcTDiKcb8ZAvIswT/hwU5Gqy2syIWkPl/U3BhQg3XXyNIZTdV2xV8GvtNjITdZU/Uv3N7lHjP4NFK/9R5jKFuckzsFtu4rfamcbIGtzotucsTZxSECxiFb8sVSrzfCkqTduK72gEDGc0TazSxLdl5kIHrvTn+v0N2ikpWsLdwoHEaW9vUVYvX3xTq8VuNOtHAjXLTuzLojX9ffFLZS1ony/DWwjjmSzGYm9rMdYIj5ksOnch9Hwv0THs0cCVkKqpStsRcisI/oZehpx0CTZO72daiDAbKcY42lhMFeRZmyoQe+nG9EuTjXsdMfGWECPuVT/6uK0F2YYfZ3+OrVZuc3P7fwsYVuRyaSq/XaYknEVWiq8ZDVxqAXQExFMVWHB6R0R7ZRt/hJ69NNavVSmpq27q6t4ThW2e5xOgfKnS81sBeXFYd0AhDBdyJYqiVwacyogRlLURR4k2BRDvK5mr6VLsFVXuFQaC2uoJ4jZXmwfa2REIJwuS3+OG9/rxLYqMwmx8O6x53yyDqcKAjIaegRu151656Einyjq/mh69iRGUaS2wxPeUoiE0EuxuOrZh6tH++jVPeS8ZxJ3pzn5IhUpJbovglhSpKUqpKewEZ34rSlTm+efQtZwbcG7AuQHnBkyOchWUq6BMjjIcYDjAcIDhAJOjDAsYFjA5yuQoIx5GPIx4dhTxMDnK5CiTo/dHjt7tq0RqQqTDb69zJWi4kWqRdCReZQEDlFYVEo2QWu2Rsk6WYpyZapLDmFRmnLu5LOH/ZDZu0DKtCxMqjCcYTzCeYEKFKydcOWFChQkVhgMMBxgOMKHCsIBhARMqTKgwocKIhxEPIx4mVJhQYULlKxAqG12vGJN/3dG0SKWMCJ9lMJgsB0S/xObBogmLxXjvhJuj6ncfe2m+yZBCrUzPZ9ZUOsPYpaLht4dZg9MkCZ9s45NtO5H68ck2rrxyHsJ5COchTMRyxZUrrkzEMhxgOMBwgOEAE7EMCxgWMBHLRCwjHkY8jHgY8TARy0QsE7F8so1PtjGeYDzBeIIJFa6ccOWECRUmVBgOMBxgOMCECsMChgVMqDChwoQKIx5GPIx4mFBhQoUJlZ0+2bZiT0boS18M6HO2frItGqdJ06pU0VhfDKY4t33xbHXsbR6i0O0Ou0VfujFiW9ka2fi4Gx9324l88Js87nbLo2zMt3K6wekGpxvMt3Jh9asH0u+usMp8K8MBhgMMB3YYDjDfyrCAYQHzrcy3MuJhxMOIZwcQD/OtzLcy33p/B9i+JIUaa5M38aioH00ds5NR3WZAY3OmQZkG3Yk07evSoOGbeyN8NQuwuVwyB8opAKcAnAIwB8rFzr9KFP3uip3MgTIcYDjAcGCH4QBzoAwLGBYwB8ocKCMeRjyMeHYA8TAHyhwoc6DfOAcaaZJgpspVMq+Zk0inIMdlylXlBhW1IfzIs9uqJOyO/gePibZVIPbVqQamlKnyy22RX0UBYoOwk9NVZPMXAFoMxd60QvvyVmpXStyfHunxQX3HlPJ9BQHdyg8BVRzcgDBK49SnBOEoc/14G0VgGCyN9fviJOiGQ1+wIqVwbXGJrZgY701Bk4g3cph6vGPVbO63I3R4oAN/KecllpjjvtV7GgeAbAZiak0RUE64GJvW0vavXXda4zstKs7i9kLSnNdFDMvw5QSk5b29hNR8Q8Rw7QvKiOnjrSVEhVqXr2XF9y9dFyxz6g/4RCvCR1G2WjK3Kfm2JcyhewvrLsP9jQlv9Bob9T9rmy5U5jvQci0H3b5BDGrzOVJshKEgUr9eo668nd9G4bdRvreC2Q1vo7RifXRW13x3+ue9JcJn97lsw2UbLtv8Rco2/N4KE1RMUPF7KwwHGA4wHNh5OMDvrTAsYFjA763weyuMeBjxMOLZAcTD763weyv83so3/t5KwFlkpfiux8ClFqnSAIinKs9rZIux0jb+qM0fN1VK6orP6DMruhPp2Df5VeX9kAqVktwWwa2t3yO4JSUq8zzWDpgc5dyAcwPODZgc5SroVw+7310VlMlRhgMMBxgO7DAcYHKUYQHDAiZHmRxlxMOIhxHPDiAeJkeZHGVy9P7I0TsBkNXvTG/77Y3fbs6Ui1SLzI2eIcsXXI9VhUQjpFZ7pKyTpRhnpprkMCaVaf22dIOWaV2YUGE8wXiC8QQTKlw54coJEypMqDAcYDjAcIAJFYYFDAuYUGFChQkVRjyMeBjxMKHChAoTKl+BUNnoesWY/OuOpkUqZUT4LIPBZDkg+mXtF2UJi8V4X/9yZfexl4D2VTAb/H7lmTWVzjB2qWj47WHW4DRJwifb+GTbTqR+fLKNK6+ch3AewnkIE7FcceWKKxOxDAcYDjAcYDjARCzDAoYFTMQyEcuIhxEPIx5GPEzEMhHLRCyfbOOTbYwnGE8wnmBChSsnXDlhQoUJFYYDDAcYDjChwrCAYQETKkyoMKHCiIcRDyMeJlSYUGFCZadPtq3YkxH60hcD+pytn2yLxmnStCpVNNYXgynObV88Wx17m4codLvDbtGXbozYVrZGNj7uxsfddiIf/CaPu93yKBvzrZxucLrB6QbzrVxY/eqB9LsrrDLfynCA4QDDgR2GA8y3MixgWMB8K/OtjHgY8TDi2QHEw3wr863Mt97fAbYvSaHG2uRNPCrqR1PH7GRUtxnQ2JxpUKZBdyJN+7o0aPjm3ghfzQJsLpfMgXIKwCkApwDMgXKx868SRb+7YidzoAwHGA4wHNhhOMAcKMMChgXMgTIHyoiHEQ8jnh1APMyBMgfKHOg3zoFGmiSYqXKVzGvmJNIpyHGZclW5QUVtCD/y7LYqCbuj/8Fjom0ViH11qoEpZar8clvkV1GA2CDs5HQV2fwFgBZDsTet0L68ldqVEvenR3p8UN8xpXxfQUC38kNAFQc3IIzSOPUpQTjKXD/eRhEYBktj/b44Cbrh0BesSClcW1xiKybGe1PQJOKNHKYe71g1m/vtCB0e6MBfynmJJea4b/WexgEgm4GYWlMElBMuxqa1tP1r153W+E6LirO4vZA053URwzJ8OQFpeW8vITXfEDFc+4IyYvp4awlRodbla1nx/UvXBcuc+gM+0YrwUZStlsxtSr5tCXPo3sK6y3B/Y8IbvcZG/c/apguV+Q60XMtBt28Qg9p8jhQbYSiI1K/XqCtv57dR+G2U761gdsPbKK1YH53VnWHXVknrsC5chQVqfncWgbTIlaMA0egN+eZGIz5lvToBZ1OWwYohDZX0k3QutYb8CBsg/1bhAlA+Atlhl0+42gLbT4MViJOQRwCNjopFox1lySiZgR/EkdygGXJAq+HC/0gCL2cO5f073cDRC/BzE7vArZHoRJMHslQPFgcP6j4fXDadXj0IvT64jN1e4cwgrSyBytPLZCKdSg8r7Oj0rJ8YO0MZT89w2+qGr9M5FBFLrZpv5VDHR+IclvRN9lbLAgLQdJBa/H57LMZdGJsR0nTUYzIK/a1ShLn3JcHeIMZWfLAzqdUfIT1claboLSW8PwcZklQcPhklHwbGzga037VOluq/YEmbovTUUPakfA7RS1OWfZg5cXh8RDmHdWHkxUHEvb6QBHvjCM/Bi1sv/Npk8DcEwouPoZfaX0yW4uhpK2vy8ME/KHOpdEjOc3w07PwpTgfFPFjpLmrsqK3HQQ68WmvWWT+ZG+fx+cvLiXTw1uZXV3j5fQV2GRSBjAJ/jB2VJFMO/86641t7JnsRvWc9cbRVOoxiXTu5eo/0Mmnq+EnST85hmYxaxol15nsSKRQvP02gej3JAUbVw9UKdw/TFErfek6WZa5CDf/B785o8oyNRT9/9ia5uvp/wlzDuA== +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get a break by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-breaks-current.api.mdx b/ads/api/reference/get-channels-channel-id-breaks-current.api.mdx new file mode 100644 index 000000000000..af7b4eab10b6 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-breaks-current.api.mdx @@ -0,0 +1,4058 @@ +--- +id: get-channels-channel-id-breaks-current +title: 'Get /channels/{channelId}/breaks/current' +description: 'List the breaks currently playing for the channel (request time within the break start + duration window).' +sidebar_label: 'Get /channels/{channelId}/breaks/current' +hide_title: true +hide_table_of_contents: true +api: eJztXVtzG7eS/iuoqX0QK6QsOT5Zh3lw6cQ+WdWRY5ds59SurF2CM00S0QwwBjCiGVv/fasbmAvJUST5cuyYnQdHnMEADaAvX/c3IN8lGbjUqtIro5NxcqKcF34BYmpBXjiRVtaC9vlKlLlcKT0XM2OpQbqQWkMu9iy8qQCfUgWIpfILpdsehPPSevGdyCorcQyxVDozy8F+MkxKaWUBHqxLxmfvNiQ5zkB7NVNghZl1R8QnFbYopV8kw0TLApJxEu8eZ8kwQZGUhSwZe1vBMHHpAgqZjN8lflViY+et0vPk6uocG7vSaAcO798/OMD/pUZ70B7/lGWZq5Rkv/e7Q9HedfqTWabwlsyfW1OC9Qr7mcncwTApO5feJZn09IjyULg7PttObnzrdRJ+oVzchSnkRs+d8AZXr1D6BPTcL5Lx4XBzSYY0eWvym2VcF+RZGRqSpkxleiHqjhqdIWGGwlXpQkgn3IUqhdSZcFqW9MQUFvJSGUvasbYC2PbZbObAby/Br1UxDdN3kBqdORrsUsESrCgq58VS+nQhpjAzFjrKOYXUFBAEKeU0h33xVGlVVIU4iAuFH5LxQbNMmsbCZaqF3pbnXwvwC7BdKZQTMs/NEjLhjXAAF8JcQmdV9sW/FqAFaBQjGwpZP4lt0e7Wm2OHFnxldegRbwRTi0oQWuHi4nY4obxQWsyqPP9JGJ3CeleZ0TBsN86Cq3BdZPAFxqq5wp0luUvjSCWixGuCOqF0lCbutV/ASkgLQubO3EXkjsRDIWcerFguVLq4VsoMZrLKfbwsSqO0R++En4LmDEVXDzsuCeehjRcO/CBOCz+WFhxoP7zbRiaNrkyNyUHq5OqquWSmv0PqycosSA/ZUY8+v1QFOC+LMkjWSryUTsTnhmhAUovjF8/Ewx8ODkUmPZALDobcEaO17HrG20P+fX1FlK5N6S4WAdYa+xSck3PYHuK/qkLqkQWZoYoLC9KZ7uRAe7CQiSenp89OUTN85fbF87AHwuh8FZYj3MGNoJa9E4VL0P523pKa9vvKoVAzIfWqdwjV0/srrd5UINTWIHH72uDYiWU3eONC2guwj8FDiqP0TeofxgpZeTPKqBVkMXoHxd2WJnQpsrpPYSE1NhN+IVHpTValqN7NkuyLoyltAvrxGhgENRSXSlKfR8+Pe5cpjHVa5fAJJbdVDkHaAh07ZCGKVBiqSXIQHooylx4+Rvbg966TO3a2Lv7MmkJItEGQRRT3usmE7sVyYRy6qzxHN9/01E73Y6bQdX/b0wjXO9Zeh2wSZbkACyJCoR63Sz55M4Bt+c0NX6ucqBxuWAjS0VkbEqQ/opB7lR0TanDFfoMbmrC51ScOqOba2KgkHVceoxmGiVoqb+LTdwICGMQILOnVsxlB2ZmxhfTJGEEfjNAtE9z1Hiyu+//uPRrvPRq/fp29fp2d3X/ww8Pzs4MHD8/fxyuH3//tP388P7v/Q33l4Azvnh20TQ8O3neaHRwMRgf3R/d/xPbvHlyNwgAH1OTh+fvDs4P754NRuDT68fz92eH989evs/ffnx0cng/e040HP/x4/v7wsLfZQWhzv3vzEO/cPzsYPTwfDAYvw5DYX339+/PB+Oxg9De8sPdo3P379ev916+z7waPBo/2Ho3/ZzD4jx7tffdn636+iT9foCOocsh6UMW+eKbFUuZ5mhsEpsH7/mkARZgknr980WlMH8P4azaZVo3jEnIplUfrkVEM7HI/qomv3LYRnqgZpKs0hzqymVmt7mMxeX765PnR6fGvv0zEXtM3vEVFIkDmq3IwFJOfXz15PBF7pYVRBqlyyiDKmq7EL8bMcxCPj46H/bLh06dPjh7/90TsQa7mCoMzziqDXF2CXWGDF8e//Hp0QkPEy8FY0CmAdQNCVhOKxxOxN5Mqh4xSPNC4e2dJM41kmKCsyTChQZNhUvedDBPqIDnv8WO1O79dTK9bd8N6BzuRl26CuzgKTmCkNFmqsDADCwEjS/IN6NQuoAyecqXT4IbWwkyf872UVkm94RqMhvjXHfI/6Rz4Ht05outhG7KYZikn4sD74siLHKRD+AQhZQiJMeXQdR76QRJdDyUf164+bgbJ3okxwwDjLrRZ6ru42RpwEcpPxslB/G9E/zzAfx7WH+v/kk0ncS1CC1Juli8Qf5pLlQVbIuBWOW8KfC4ilzlosKRVCMjFq1fHj8METaG8D0t9A8RTiHxlWi/nh+TcnS6aJLpJu2lubdotRZqr9GLkF9ZU84V4dXqynW9Tk5ehxfYe/7zZgTAloMdpEpY6XYpyudZkZLYvnmJSPgUM9TJXWS1CEzYrq7YNqi+LKiBT8iVd3ZTxKd4S+AR5VB2WYSwmuJ9mQh5LFXIOk66joptoHXin1xUVqoBrRjx++qQZsFUqklHs4W7AW1mUOUQZ7hXlg8lg3R6OMLkM2Cg4V3SzCAptoTSIqpxZoz0+QiUG5UUqdUiYyfRpyJ+EwbtL5QBbLBBsGeHtaigKSdWEIFlpAWtwpDUOk1rb68d872zJ94TpZgpvFEpLb+y+mGAgU+lkLKTIlIXUNyiy9a2tNob1MVbQmte6UG9I6Kt3J1BL+mFXr/4MP6z25qWdA4bND7XNDC4VBpO6nxBWHORAdhEsRjnx6vS4BqLb9hg66de7x3EA3ArqCbS3qziga1B1iINlcGhOOLgEK/M6WMScKypdLR3lKRpCnhVkb2w7iNTdqwzchTclLj3icY+uz0xVjujXX/bsYZ9JX8q86pnky8aecJ2aUBemumZcHY367ejFS+HlHJVqcKMnvupWjs+iIOd9Xkfp46BJbSfSWrnqgaUnJl0Lh0Gfa2cEisxYCqc04jR0pUEcglTotbBffBhv4WwVOAEyXQSPaq7Tsv2t+SgsjbcOM0oezKhnlgwHGA4wHGA48PFw4FI6T2Cg6467c7LgTH4JJNYMkKrBUo0FncUKEyVu6nIt2GCvDAsYFvw1YUEjQh7xwbeDBWg7nne4/eue3qLjr7UVmYn2ZQFR4ghYyg3xJnKJl6AzXCYX6u+olYUs98U/Wh0YkoLEkthRJp5KLefBxTgglhI7msjspZy3E5h0vGC72Yx4GPEw4mHE0494yBcR5gl/jgpyNVltZkStofL+pmApwk0XX2MIZfeWrQp+rdtGZqKu8keqv9k9avxnsKj1H2UuU1iYPAO75SZ+q51pjKzBjW57ztLEKQXBIlbxq1KlMs9XotK0rfiORsBwRtPEKk18W2aWOnClP9Xvb9BOSdER7hYOJE57e4uyevniW14ddqNZPxKoWXZiXy47098XPzcvwdFbCJO5LCZib2sx1giPuSx6dyH0/EmiY9ijkSshVTOVdiPkVhD8Db0MOekSbJzeT7QQYTZSTHC0iZgpyLMuVSD20o3plyabDHpi4i0hRtyrYfRxWwuyDT/O/xxbtW5zc/t/CxhW5HJlKr9dpiScRVaKrxmNXGoBdATEMxVYcHpHRHtlG3+Enr001q9VKamrfurqkycK2zzPB0D5UqUXtwLy4qjugEIYLmQriqJXBpzKiBGUtRFHiTYFEG8qmavZSuwVVe4VBoLa6gniNlebB7rZEQgnC5Lf44YPhvEtiozCbHw7rHnfLIOZwoCMhp6BG3fnXrnoSGfKOt9Oj97ECMq0Fljie0rREBoJdjcd2zD1aH/Dmqf8JBnEnenOYUiFSklui+CWFKkpSqkp7ARnfitKVOb5x9C1nBtwbsC5AecGTI5yFZSroEyOMhxgOMBwgOEAk6MMCxgWMDnK5CgjHkY8jHh2FPEwOcrkKJOjn44cvdtXidSESI/fXudK0HAj1SLpSLzKAgYorSokGiG12iNlna7EJDPVNIcJqcwkdwtZwv/JbNKgZVoXJlQYTzCeYDzBhApXTrhywoQKEyoMBxgOMBxgQoVhAcMCJlSYUGFChREPIx5GPEyoMKHChMoXIFQ2um4Zk3/f0bRIpYwJn2Uwmq5GRL/E5sGiCYvFeO+EW6Dq9x97ab7JkEKtTC/m1lQ6w9ilouF3h1mD0yQJn2zjk207kfrxyTauvHIewnkI5yFMxHLFlSuuTMQyHGA4wHCA4QATsQwLGBYwEctELCMeRjyMeBjxMBHLRCwTsXyyjU+2MZ5gPMF4ggkVrpxw5YQJFSZUGA4wHGA4wIQKwwKGBUyoMKHChAojHkY8jHiYUGFChQmVnT7Z1rInY/SlJyP6nK2fbIvGadK0KlU01pPRDOe2L560x94WIQrd7rBb9KUbI3aVrZGNj7vxcbedyAe/yuNutzzKxnwrpxucbnC6wXwrF1a/eCD95gqrzLcyHGA4wHBgh+EA860MCxgWMN/KfCsjHkY8jHh2APEw38p8K/Otn+4A2+ekUGNt8iYeFfWjqWP2MqrbDGhszjQo06A7kaZ9WRo0fHNvhK/mEmwuV8yBcgrAKQCnAMyBcrHzrxJFv7liJ3OgDAcYDjAc2GE4wBwowwKGBcyBMgfKiIcRDyOeHUA8zIEyB8oc6FfOgUaaJJipcpXMa+Yk0inIcZmyrdygojaEH3l2W5WE3dH/4DHRrgrEvnrVwJQyVX61LfKzKEBsEHZy1kY2vwTQ4kDszSq0L2+ldqXE/RmQHh/Wd0wp31QQ0K18G1DF4Q0IozROfUgQjjLXj3dRBIbB0li/L06Dbjj0BS0phWuLS2zF1HhvCppEvJHDzOMdq+YLvx2hwwM9+Es5L7HEHPet3tM4AGRzEDNrioBywsXYtJZ2eO260xrfaVFxFrcXkua8LmJYhs8nIC3v7SWk5hsihmufUUZMH28tISrUunwdK/700vXBMqf+gA+0InwUZaslc5uSb1vCAvq3sO4y3N+Y8EavsdHwo7ZpqTLfg5ZrOej2DWJQm4+RYiMMBZGG9Rr15e38Ngq/jfKtFcxueBulE+ujs7rmu9M/7i0RPrvPZRsu23DZ5i9StuH3VpigYoKK31thOMBwgOHAzsMBfm+FYQHDAn5vhd9bYcTDiIcRzw4gHn5vhd9b4fdWvvL3VgLOIivFdz1GLrVIlQZAPFN5XiNbjJW28Udd/ripUlJXfEafWdGdSMe+yq8qH4ZUqJTktghubf0ewS0pUZnnsXbA5CjnBpwbcG7A5ChXQb942P3mqqBMjjIcYDjAcGCH4QCTowwLGBYwOcrkKCMeRjyMeHYA8TA5yuQok6Ofjhy9EwBpf2d6229v/HZzplykWmRu9BxZvuB6rCokGiG12iNlna7EJDPVNIcJqUznt6UbtEzrwoQK4wnGE4wnmFDhyglXTphQYUKF4QDDAYYDTKgwLGBYwIQKEypMqDDiYcTDiIcJFSZUmFD5AoTKRtctY/LvO5oWqZQx4bMMRtPViOiXtV+UJSwW4339y5X9x14C2lfBbPD7lefWVDrD2KWi4XeHWYPTJAmfbOOTbTuR+vHJNq68ch7CeQjnIUzEcsWVK65MxDIcYDjAcIDhABOxDAsYFjARy0QsIx5GPIx4GPEwEctELBOxfLKNT7YxnmA8wXiCCRWunHDlhAkVJlQYDjAcYDjAhArDAoYFTKgwocKECiMeRjyMeJhQYUKFCZWdPtnWsidj9KUnI/qcrZ9si8Zp0rQqVTTWk9EM57YvnrTH3hYhCt3usFv0pRsjdpWtkY2Pu/Fxt53IB7/K4263PMrGfCunG5xucLrBfCsXVr94IP3mCqvMtzIcYDjAcGCH4QDzrQwLGBYw38p8KyMeRjyMeHYA8TDfynwr862f7gDb56RQY23yJh4V9aOpY/YyqtsMaGzONCjToDuRpn1ZGjR8c2+Er+YSbC5XzIFyCsApAKcAzIFysfOvEkW/uWInc6AMBxgOMBzYYTjAHCjDAoYFzIEyB8qIhxEPI54dQDzMgTIHyhzoV86BRpokmKlylcxr5iTSKchxmbKt3KCiNoQfeXZblYTd0f/gMdGuCsS+etXAlDJVfrUt8rMoQGwQdnLWRja/BNDiQOzNKrQvb6V2pcT9GZAeH9Z3TCnfVBDQrXwbUMXhDQijNE59SBCOMtePd1EEhsHSWL8vToNuOPQFLSmFa4tLbMXUeG8KmkS8kcPM4x2r5gu/HaHDAz34SzkvscQc963e0zgAZHMQM2uKgHLCxdi0lnZ47brTGt9pUXEWtxeS5rwuYliGzycgLe/tJaTmGyKGa59RRkwfby0hKtS6fB0r/vTS9cEyp/6AD7QifBRlqyVzm5JvW8IC+rew7jLc35jwRq+x0fCjtmmpMt+Dlms56PYNYlCbj5FiIwwFkYb1GvXl7fw2Cr+N8q0VzG54G6UT66OzujPs2ippHdWFq7BAze/OIpAWuXIUIBq9Id/caMSHrFcv4GzKMlgxpKGSYZIupNaQH2MD5N8qXADKRyA7usYnrM11Y6RMetnz1NUWRH8cbEechuwDqCdUR5LxOEvGyRz8KMrnRo2gI1pDN4oKTZowdzj23+kGjl6AX5jYBW6oRNeb3JOlund5eK/u8967ptOre6HXe22vDtLKEhA9e5dMpVPpUYXdnJ0PE2PnKOHZOW513fBFuoAi4q+2+Vbe9fxYXMCKvv3eallAAKcOUovfiY8FvKWxGaFTRz0m49Bfm1YsvC8JKgcxtmKKnUut/ggpZVvOojeb8P4CZEhscfhknLwdGTsfkY7Ue1uqf0LYXKVnhjIu5XOInp0y86PMiaPnx5SnWBdGvjyMWNkXkqByHOEX8OKWy742FfzVgfCq5Dg5QTNpqm9OtLkXGkgbWkDE7sUeKibgU6qArfod0s3Wi+9EbRdiqXRmlt38zcNbf6/MpdKhTJCjSEGbznCRcPKHrRWh7Yy7FhVExQZxfufDZGGcx8ffvZtKB69sfnWFl99UYFdBu8g68VfhUfMy5fDvrD/QdhdoL6YR2UAcb9Uwo1TXzq3eeL1KGkIhSYbJBaySccdLkOuLCoTihftHaQql7zwpyzJXoXp/73dnNPnExip/efIyubr6f4cS1r0= +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List the breaks currently playing for the channel (request time within the break start + duration window). + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-breaks.api.mdx b/ads/api/reference/get-channels-channel-id-breaks.api.mdx new file mode 100644 index 000000000000..14dfe9ebeef7 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-breaks.api.mdx @@ -0,0 +1,4103 @@ +--- +id: get-channels-channel-id-breaks +title: 'Get /channels/{channelId}/breaks' +description: 'List all breaks for a channel with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/breaks' +hide_title: true +hide_table_of_contents: true +api: eJztXW1zE7mW/iuqrv0Q19rBZpgZMEVRuQN3NrVh4AaYW3dDdi13H9uadEuNpI7xAP996xyp2227QxJeLgw584FJ3GrpSDovzzmPFL9NMnCpVaVXRifj5Eg5L2Sei6kFeebEzFghRbqQWkMulsovRCnnSkts3xczlXuwSs/7QupMOGO90vP9pJ+U0soCPFiXjE/ebo0yGkylgwy7AqGrYgpWeCMs+MrqffFEaVVUhRhhRwpfeF2BXSX9RMsCknGC7yX9xMLrSlnIkvFM5g76iUsXUMhkjOPNZJX7ZDzqJ4V8g90l43vD4c+je/du/3jn5zvDe/fwURiJmvlViX0r7WEONnn/vr8t9m9BUjMTykPh1iKLEixNpi+m4JcAWoxoQUbD4Yfm8Fz9edV53B62JjIaDq8r+1P6Qebi+Pk/juK+CXhTWnBOGS32cKfhjSzKHMTEeekr9+DB8eODR/+6n1WW9vvB3D/4YTjp7YvHMl0IC85UNgXsxjhwQnknzFKj/pjlIEdVMrM4lpzmIGYK8szRypgSrPTGuovWJ7z24dWJ03YeVfCDs05NUciBA1RLD5lYC0cSeUO6K6ar+6K0MFNvhAzPgs5PBhMyBewddKb0XBibgd0Xj8IGURcaluC8mCnrvNhLLeBQB771Vu+i2eLonzjXwwy0VzMVNNQvoDbbZsxS+sV6yPj0MNsY19vqg8OeYmNXGu3A4fPbwyH+LzXag/b4oyzLXKWkMLf+cCja21Z/MstU2JNnFnXAK+wnzrZsffQ2yaSPNtCe5osFBL9hZqiBuPY0QbTIaw6wXoGdUS5cTOEXygXvKKaQGz3HrUcJCqWPQM/9om2R9br1aYWsyS+X8QINLnO5msr0TNQdkUKiZCRMX7gqXQjphDtTZfDGWpb0xhQW8lwZS355YwWw7dPZzIHfXYK1t3OQGo1WsgBxrmAJVhSV82IpfboQU5gZC2tJxBRSU0AQpES7X3v0YVyo4LiGzTKFGIDLVAu9K88/F+AXYNtSKBd8DWRkwQBnwpxDa1X2xT8XoAVoFCPrC1m/iW3JijeaY4fBo4ce8YHz0vpaCUIrXFzcDvR4Qmkxq/L8vjA6hc2uMqOhv9441FZcF+mpmbEKA2ke5C6NI5WIEm8I6oTSUZq4134BKyEtCJk7cx2RWxL3hZxhEFguVLq4UMoYgOLHojRKe7EXfgua0xdtPRR1sBBLnIc2XjjwvTgt/BVDDmjfv95GJo2uTI3JQWp0gfVHZvoHpJ6srHa6HY5DFeC8LMog2VripXQivtdHA5JaHD5/Ku7+NByJTHrwqsA1tRHZ7Fh2PePdIf+2uSJK16Z0HYsAa419As4h6NkZ4r+qQuqBBZlRhLUgnWlPDrQHC5l4fHz89FiEuL4vnoU9EEbnq7Ac4QluBLXsnCicg/ZX85bUtNtX9oWaCalXnUOojt5favW6AqF2Bonbp/xC6e2Ad4k3LqQ9A/sIPKQ4Stek/o7Qt/JmkFEryCImDoq7K03oUmR1n8JCamwm/EKi0pusSlG9myXZFwdT2gT04xFuRzUU50pSnwfPDjuXKYx1XOXwGSW3VQ5B2gIdO2QhilQYz0lyEB6KMpcePkX24Pcukjt2tin+zJpCSLRBkEUU96LJhO7FcmEcuqs8Rzff9LSe7qdMoe3+dqcRPm9Zex2ySZTlAiyIiJc63C755O0AtuM3t3ytcqLChEqGIB2dtSFBuiMKuVfZMqEGV+w3uKEJmzt94oBqro2NStJy5TGaYZiopaI8Cd++FhDAIEZgSa+eziiJnBlbSJ+MERnCAN0yJZreg8V1/9+9h+O9h+NXr7JXr7KT23d+unt6Mrxz9/Rd/GT0w48/3zs9uf1T/cnwBJ+eDNdNh8N3rWbDYW8wvD24fQ/bv73zfhAGGFKTu6fvRifD26e9QfhocO/03cno9umrV9m7H06Go9PeO3pw56d7p+9Go85mw9DmdvvhCJ/cPhkO7p72er0XYUjsr/78h9Pe+GQ4+BE/2Hs4bv/86tX+q1fZf/Ye9h7uPRz/T6/3Hx3a+/ZD6366jT+foyOocsg6UMW+eKrFUuZ5mhsEpsH7fjCAIkwSz148bzWmX8P4GzaZVo3jEnIpFVYWyAmgGNjlflQTX7ldIzxSM0hXaQ51ZDOzWt3HYvLs+PGzg+PD336diL2mb3iDikSAzFdlry8mv7x8/Ggi9koLgwxShYkyyrQSvxozz0E8Ojjsd8uGb1PyPBF7kKu5ovSXMshcnYNdYYPnh7/+dnBEQ8SPg7GgUwDreoSsJhSPJ2JvJlUOGWWQoHH3TpJmGkk/QVmTfkKDJv2k7jvpJ9RBctrhx2p3frWYXrduh/UWdiIv3QR3cRCcwEBpslRhYQYWAkaW5BvQqZ1BGTzlSqfBDW2EmS7ney6tknrLNRgN8adr5H/SOfAdunNAn4dtyGKapZyIA++LAy9ykFhA0BBShpA9b+ShHyXRxVDyUe3q42aQ7K0Y0w8w7kybpb6Om60BVywzJcP434D+uYP/3K1/rf9Ltp3EhQgtSNlCaNFvPLPmXGXBlgi4Vc6bAt+LyGUOGkKlBgG5ePny8FGYoCmU92GpL4F4WAyzMq2X82Ny7lYXTRLdpN00t3XaLUWaq/Rs4BfWVPOFeHl8tJtvU5MXocXuHv+y3QFWydDjNAlLnS5FudzaZGS2L55gUj4FDPUyV1ktQhM2K6t2DaoriyogU/IFfbot4xN8JPAN8qg6LMNYTHA/zYQ8lirkHCZtR0UP0TrwSacrKlQBF4x4+ORxM+BaqUjGrbIlDXOrKO9Mepv2cIDJZcBGwbmim0VQaAulQVTlzBrt8RUqMSgvUqlDwkymT0PeFwafLpUDbLGQVPTzdtUXhaRqQpCstKHMiFrjMKm1nX7Md86WfE+YbqbwQYHFdmP3Q1FWpZOxkCJTFlLfoMi1b11rY1gfYwWtea0L9YaEvjp3ArWkG3Z16k//7UfV3ry0c8Cw+bG2mcG5wmBS9xPCioMcyC6CxSgnXh4f1kB01x5DJ9169ygOgFtBPYH2dhUHdA2qDnGwDA7NCQfnYGVeB4uYc0Wlq6WjPEVDyLOC7I1tB5Hae5WBO/OmxKVHPI514sJMVY7o15937GGXSZ/LvOqY5IvGnnCdmlAXprphXC2N+v3g+Qvh5RyVqnepJ37fLi+fREFOu7yO0odBk9adSGvlqgOWHpl0IxwGfa6dESgyYymc0ojT0JUGcQhSodfCfvFlfISzVeAEIKtBHtVcpGX7O/NRWD9fO8woeTCjjlkyHGA4wHCA4cCnw4Fz6TyBgbY7bs8J+dn8HEisGSBVg6UaCzqLFSZK3NT5RrDBXhkWMCz4a8KCRoQ84oPvBwvQdjxrnaq56O0dzv5CW5F4AqfuUJQ4ApZyQ7yJXOI56AyXyYX6O2plIct98fe1DvRJQWJJ7CATT6SW8+BiHBBLiR1NZPZCztcTmLS84HqzGfEw4mHEw4inG/GQLyLME34cFORqstrMiFpD5f1dwVKEhy4eYwhl9zVbFfxau43MRF3lj1R/s3vU+EOwaO0/ylymsDB5RofXtsJT7UxjZA1udNdzliZOKQgWsYpflSqVeb4SlaZtxTMaAcMZTROrNPFtmVnqwJXer89v0E5J0RLuCg4kTnt3i7J6+eJRsBa70awfCdQsO7Ev563p74tfKmtB+3wVTiFM5rKYiL2dxdggPOay6NyF0PNniY5hjwauhFTNVNqOkDtB8Hf0MuSk8QBoEOI+LUSYjRQTHG0SjxK2qAKxl25NvzTZpNcRE68IMeJe9aOP21mQXfhx+mFstXab29v/e8CwIpcrU/ndMiXhLLJSPGY0cKnFA7EBEM9UYMHpjIj2yjb+CD17aazfqFJSV93U1WdPFHZ5no+A8qVKz64E5MVB3QGFMFzItSiKjgw4lREjKGsjjhJtCyBeVzJXs5XYK6rcKwwEtdUTxG0+bV5oZ0cgnCxIfo8b3uvHUxQZhdl4Oqw5b5bBTGFARkPPwI3bc69cdKThAGwzPTqJEZRpI7DEc0rREBoJbm46tmXq0f76NU/5WTKIa9Od/ZAKlZLcFsEticepS6kp7ARnfiVKVOb5p9C1nBtwbsC5AecGTI5yFZSroEyOMhxgOMBwgOEAk6MMCxgWMDnK5CgjHkY8jHhuKOJhcpTJUSZHPx85er0/JVITIh1+e5MrQcONVIukK/EqCxigtKqQaITUao+UdboSk8xU0xwmpDKT3C1kCf8ns0mDlmldmFBhPMF4gvEEEypcOeHKCRMqTKgwHGA4wHCACRWGBQwLmFBhQoUJFUY8jHgY8TChwoQKEypfgVDZ6nrNmPz7rqZFKmVM+CyDwXQ1IPolNg8WTVgsxnsn3AJVv/vaS/OXDCnUyvRsbk2lM4xdKhp+e5gNOE2S8M02vtl2I1I/vtnGlVfOQzgP4TyEiViuuHLFlYlYhgMMBxgOMBxgIpZhAcMCJmKZiGXEw4iHEQ8jHiZimYhlIpZvtvHNNsYTjCcYTzChwpUTrpwwocKECsMBhgMMB5hQYVjAsIAJFSZUmFBhxMOIhxEPEypMqDChcqNvtq3ZkzH60qMB/Z5t3myLxmnStCpVNNajwQznti8er6+9LUIUutplt+hLt0ZsK1sjG1934+tuNyIf/Cavu13xKhvzrZxucLrB6QbzrVxY/eqB9LsrrDLfynCA4QDDgRsMB5hvZVjAsID5VuZbGfEw4mHEcwMQD/OtzLcy3/r5LrB9SQo11iYv41FRP5o6ZiejusuAxuZMgzINeiPStK9Lg4a/3BvhqzkHm8sVc6CcAnAKwCkAc6Bc7PyrRNHvrtjJHCjDAYYDDAduMBxgDpRhAcMC5kCZA2XEw4iHEc8NQDzMgTIHyhzoN86BRpokmKlylcxr5iTSKchxmXJduUFFbQg/8uy2Kgm7o//Ba6JtFYh9daqBKWWq/GpX5KdRgNgg7ORsHdn8EkCLodibVWhf3krtSon70yM9HtVPTClfVxDQrXwTUMXoEoRRGqc+JghHmevX2ygCw2BprN8Xx0E3HPqCNSmFa4tLbMXUeG8KmkR8kMPM4xOr5gu/G6HDCx34SzkvscQc963e0zgAZHMQM2uKgHLCh7FpLW3/wnWnNb7WouIsri4kzXlTxLAMX05AWt6rS0jNt0QMn31BGTF9vLKEqFCb8rWs+PNL1wXLnPoTPtKK8FWUrZbMbUu+awkL6N7CusvwfGvCW73GRv1P2qalynwHWq7loMeXiEFtPkWKrTAUROrXa9SVt/NpFD6N8r0VzC45jdKK9dFZXfC30z/tlAjf3eeyDZdtuGzzFynb8LkVJqiYoOJzKwwHGA4wHLjxcIDPrTAsYFjA51b43AojHkY8jHhuAOLhcyt8boXPrXzj51YCziIrxbMeA5dapEoDIJ6pPK+RLcZK2/ijNn/cVCmpK76jz6zojUjHvsk/Vd4PqVApyW0R3Nr5PoIrUqIyz2PtgMlRzg04N+DcgMlRroJ+9bD73VVBmRxlOMBwgOHADYYDTI4yLGBYwOQok6OMeBjxMOK5AYiHyVEmR5kc/Xzk6LUAyPp7pnf99tZ3N2fKRapF5kbPkeULrseqQqIRUqs9UtbpSkwyU01zmJDKtL5bukHLtC5MqDCeYDzBeIIJFa6ccOWECRUmVBgOMBxgOMCECsMChgVMqDChwoQKIx5GPIx4mFBhQoUJla9AqGx1vWZM/n1X0yKVMiZ8lsFguhoQ/bLxjbKExWK8r7+5svvaS0D7KpgN/n3luTWVzjB2qWj47WE24DRJwjfb+GbbjUj9+GYbV145D+E8hPMQJmK54soVVyZiGQ4wHGA4wHCAiViGBQwLmIhlIpYRDyMeRjyMeJiIZSKWiVi+2cY32xhPMJ5gPMGECldOuHLChAoTKgwHGA4wHGBChWEBwwImVJhQYUKFEQ8jHkY8TKgwocKEyo2+2bZmT8boS48G9Hu2ebMtGqdJ06pU0ViPBjOc2754vL72tghR6GqX3aIv3RqxrWyNbHzdja+73Yh88Ju87nbFq2zMt3K6wekGpxvMt3Jh9asH0u+usMp8K8MBhgMMB24wHGC+lWEBwwLmW5lvZcTDiIcRzw1APMy3Mt/KfOvnu8D2JSnUWJu8jEdF/WjqmJ2M6i4DGpszDco06I1I074uDRr+cm+Er+YcbC5XzIFyCsApAKcAzIFysfOvEkW/u2Inc6AMBxgOMBy4wXCAOVCGBQwLmANlDpQRDyMeRjw3APEwB8ocKHOg3zgHGmmSYKbKVTKvmZNIpyDHZcp15QYVtSH8yLPbqiTsjv4Hr4m2VSD21akGppSp8qtdkZ9GAWKDsJOzdWTzSwAthmJvVqF9eSu1KyXuT4/0eFQ/MaV8XUFAt/JNQBWjSxBGaZz6mCAcZa5fb6MIDIOlsX5fHAfdcOgL1qQUri0usRVT470paBLxQQ4zj0+smi/8boQOL3TgL+W8xBJz3Ld6T+MAkM1BzKwpAsoJH8amtbT9C9ed1vhai4qzuLqQNOdNEcMyfDkBaXmvLiE13xIxfPYFZcT08coSokJtytey4s8vXRcsc+pP+EgrwldRtloyty35riUsoHsL6y7D860Jb/UaG/U/aZuWKvMdaLmWgx5fIga1+RQptsJQEKlfr1FX3s6nUfg0yvdWMLvkNEor1kdndW3YtVPSOqgLV2GBmu+dRSAtcuUoQDR6Q7650YiPWa9OwNmUZbBiSEMl/SRdSK0hP8QGyL9VuACUj0B2cIFP2IKYpZwjbrw+OHrWvCgK8DKTXjZ1CQuuyrHm2+HTS0y/d+sOUcFHg6nEBApbieD5Woi8hejkHJ7HWLTZ02/UBreEqt+E98HVGQK+19mhN17mHWVY/DgKsu5zY/deV5TVptY4J2Se0xju4kGe4ePLR6JehDyXKpd1ctcM19H7ltLQMrfWqZ7hhhC7CrLVC+5qsqEkHa/sJHCPgmcVxyE3BeoWdYC6OMyScTIHP4ja6waNGg/Iwhz5h7lDAf4WPjjFjMsvTHyVRMKAnNySpbp1PrpV93XrbdPZ+1tNbw7SylJacvI2mUqn0oMKXz857SfGzlGik1M0/Lrh83QBRUTj6+Y7WfizQ3EGK/ouBKtlASFVcZBa/IYELOcujc0oV3HUYzIO/a23b+F9SYlTEGMHYdi51OrPYGfr4iadc8PnC5ChzIHDJ+PkzcDY+YA8Rm3ppfpvWNEWKD0zlH8rn0OM81SnOcicOHh2SFmrdWHk81HMnHwhyTfEEX4FLy5Z7o0p4HdPhAOz4+QInSWaSGhKOi1F7CIUEteq1hczlXsIPAGtq7E+loXi3Dy88bfKXCodCkF5cDC0tThxnNBo7SdRtnHbZ04b7VoY5/Glt2/R/7y0+fv3+DEZG2lNphyaYdbtDduT7HBhWPqx4CvbqouPLpzHGaywihUMONJDCZEVVxdi2ws2AjRecA1FRwGKDodXkCj6ko+UqgGWx8//cRS3V8Cb0oJDrdsqpYaI9uDB8eODR/+6XwfAB3P/4IfhpBf/1hVSrJVNAbsxCK6Ud4Iqc1hvHdThOYwVHClWglzIx8knGesumXl4+zPMOzVFIQcuFGfxQHojHsnkDSm5mK7uYwl3pt5gRkGVKzKOyWASi3wuBZ1hBCIQui8etYqMGpbgfESYew0caL3Vu2S+KMTGbE8j6pii37iWNezF8kjWE4c73Ey0xQulqV2YXrWlqaVcWzJBuugKUbzw/CBNoWzPQ5ZlrgIreesPZzTNq4krvz5+kbx///++hadj +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all breaks for a channel with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-detection-history-marker-detection-id.api.mdx b/ads/api/reference/get-channels-channel-id-detection-history-marker-detection-id.api.mdx new file mode 100644 index 000000000000..1a123bfe4ed5 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-detection-history-marker-detection-id.api.mdx @@ -0,0 +1,77 @@ +--- +id: get-channels-channel-id-detection-history-marker-detection-id +title: 'Get /channels/{channelId}/detection/history/{markerDetectionId}' +description: 'Get a detected ad-marker history entry by ID.' +sidebar_label: 'Get /channels/{channelId}/detection/history/{markerDetectionId}' +hide_title: true +hide_table_of_contents: true +api: eJytVktv40YM/ivEnBJAXic9FIV7Mpp0YWyBBE62F8NAaImyZiPNKDNUvKqh/15QGiuKraT76MmySPHjx/deJeRjp0vW1qiZ+kgMCAkxxUwJYDIp0D2Sg0x7tq4GMuxq2NSwuPqgIlWiw4KYnFez1f7I2CIhwzrV5MCmwBlBnKExlMuXWjRK5ExFymBBaqaCdJGoSDl6qrSjRM3YVRQpH2dUoJrtFdelKHt22mxV00T/DRs4dLS0NeAoti55w41O++qg/J3urEXZl9Z48iL/5eJCfmJrmAzLI5ZlrmMU29MvXlzeD+xhkmgRYX7rbEmOtdhJMfcUqXLwaq8w7hgfB+Cm4tgWFFhSAql1w6x2BGfw8Mfyen5/ffUAZwgbR/gIO/QgviRVTsl5BA93nxa3t62KsUFnKLcOHv6cL/5qNYJAmy2kqEVBIkymKtRspQKYilSwqSLVfarW0XEYI9ViLZJTdqfpPXILUmcL4Ez7l4xHoFOwhlqCsSNkatN/Ahtkcz4FvtcFecaihF1GZlhYYvQQ3QjQAxpY3N3Ab79eXEKCTKwLgg5kFFWP8Pxs9FM1Uru65z9qqtMf8T4jcLh7bY8S0B0Tz46wgAKNTsnzO6aXVU7flpcA5aqcgDNkKJAlSa3wqBrbBKGpR4Gt01ttvg2004VdZj1BafO2HHuwF7dGgRyhH+uoZfu+7yFJQ9spj7osKZEu6Ar+AywpJsOh9TxUngBBcJJX40fM/Q45bTGue+UCa4jRuRoQUkc0Sa0r3i6bZjiWVlJDg0hFh+nQV8Swtl8azm6+UMyqEWuvOV9RilXOsAzTrAWU8YNhKs7UlngShraf9NN70hOdhK0xGRupjFtZGqp/K14VxJkNptv1wpmaqSmWevp8OT1gTfc9WDPt0aYBbbo/gWtUpDzFldNct4tqg17H80qsr9YStq0QWq1lfB8U72Qmd5N2oH5cGvPbBTxSDWeVJycb5BzQJOApdsRwVqL3O+u6UdhOeYl6a+8loxlz2dX5dqzIb9wWjf4HR9q/XV8ZYdImOCywrxPrtpO2HgIAlvoT1W0GtUltu7c05yK6KVn/rWkH88TD/HahIvVMznfIz5fiVmk9F9i2RUCQM+HnsvGK4WA9fvcFEhgyfeVpmaM24nHlcrHalc9K6AutS+mB4LSK1Gx4b/R+q0gFJFE5Ldx1pDLrWczu9xv09NnlTSOvnypydVdPz+g0biS+chRpL89Jv8Xf5H62DP18Du/eTqOcD6k24vgz5pX8U5F6pPrVbdUeTP+PS+/cVT/g4mmsm3UTHapbItnpzeOYSh5YODmomuEk+Xh9r5rmX+zRx1c= +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get a detected ad-marker history entry by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-detection-history.api.mdx b/ads/api/reference/get-channels-channel-id-detection-history.api.mdx new file mode 100644 index 000000000000..b503fa809a81 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-detection-history.api.mdx @@ -0,0 +1,129 @@ +--- +id: get-channels-channel-id-detection-history +title: 'Get /channels/{channelId}/detection/history' +description: 'List detected ad-marker history for a channel with pagination, filtering, and sorting. Each entry records the detected marker and the action taken, plus (when applicable) the matched marker rule, the resulting break, and a reason for skipped/failed detections.' +sidebar_label: 'Get /channels/{channelId}/detection/history' +hide_title: true +hide_table_of_contents: true +api: eJztV1FPGzkQ/isjP4G0IUmvdz1S8RC1XIXaOzhoTzohJIbd2azLrr21vYQU5b+fxnY2S7JQaF/6cE+EtT3fzHjmm893IiObGlk7qZWYiA/SOsjIUeooA8wGFZprMlBI67RZQK4NIKQFKkUlzKUroMaZVMjnE8hl6chINUsAVQZWGyfVbA8OMS2AlDMLMJRqk1lwBa2BIgqf4e+YsjlweE0qgbpsLOzMC1KAdV3KFK9K2vUbK3RpsT5vmpISv2DINiVjw5UhvA7uIBhCq5WPwl7LuqZsmKMsKYuuSK3snkhEjQYrcmSsmJzfbeRoPLhCSxkHTqCa6ooMOA2GXGPUHvwplayaCsZsSPKBLw2ZhUiEworERPA5kQhDXxppKBOTHEtLibBpQRWKCePl2JROTMaJqPCWzYnJ/mj0ary//+LXl69ejvb3eSkg+W1uUbNtqRzNyIjlMtl0+6/gqc5BOqrs2mWoyfhgErgiNydSMPb5Go9Gj8VwJr8+NY4Xo04g49Houb4f+x9YwunZ3x9ilQHd1oas5UrZ4RulW6zqkuDSOnSNPTg4PZy+/fd11hhfnQczd/DL6HI3VqMhqxuTEpvRlixIZ0HPFWBZ6vmg5EbQecTiioNcUplZnxldk0GnjX0oP+HY49mJYVvHDfNo1KmuKhxY4rLkdlk75z1y2ncaXC1eQ20ol7eAYS106OXg0pc8WyeVcVdok5HZg7fhgrwJRXOyDnJprIOd1BBDTV3n1O5D0TL6D8Z6lJFyMpehQrmFI8m0mDW6Yg0ZV4+ye7jONI/CXvBmW2tlyfL6i9GI/6RaOVKOf0aGYa+Gny27dtexh1kmw52cGK4BJ9lOjLbufLoTGbrYA90wPxYUeEPnkaNCCXFHPhMgkOQ2xHHjUl1RJFrKImdvcO0ELt+cHk4/Hr69hB0MLAlztMDBZk1J2W4Cl2fvj05O/Bal457uujZw+cf06IPfERe4ugKn+nIhxU1+LiKYSES0KRIRjoqLZPOeEuGxjrLt6LbrZMMtyI2uwBXSrjk9AZmDVuQDjJXNzm3BtlXfc3OyIuuwqsFPojB9/NRho6vsJoDMEHB0dgy//zYaQ4aOnKwIAkgvquyJ85OSX5oWoo0EZBt/r6mwv7/uDM7v26MMZIjEOkNYQYVK5mTdI6ZPm5Kedi+dmQyuQNcO657J7y8I1aIXWBs5k+ppoGEvzAttCWpd+nJswdZu9QIFdbANcxpUA3auwXdKUBDcBaHg9+CUUlKu1TiNJUBgnI7AiCLkNZQ0w3QtiCpcQIrGLJi8DdEg16Z6uGyWXd475xrqZCpZsUNbEd3aXjecvvpMqePY4wc0Bhf8/1rVfZOW7ifrpD0IFTlkGvQMtFZlYMlX2H0686poK/VvGmM4oz2aq5OT8CG6HXTJlqVN+cPJI8tVsZI/vQaddlj29BN/Xom/1qavcK44DtbPSMDUaGtZVHgM+zDICS9/G8lbAbxBWQZVEnPr4Xqsb9RJFJ8d/RYivOfEdoFsWPHD7V6R9BxZbpZGVBtwGkewNxuklNS+wcWM3CCOdjtoZ/ygbZ5BfIiwvzhjdS7ertbYh4pcoaMh76ArxEQMsZbDm/FwZXl415peDlvbw7VtS2ljpFt49X+FVqbThi2dX3CTzdjV8wtWE6uNZywRwvV1tm/e5fTkCK5pATuNJcNCZjc8kyg15GCnRmvn2oTB6UUH59PbW99r4VwdWHHWR4nHZoZKfsWeYeFVVEGYeTqIOup2oM1s4NljRQG1fE8LfzdS5drLKOlKioL0H0lzmGYWpidHIhE3ZGxAvhn7BtTWVehJIyK8IwdPz/y9aDrK7P+Xqepyh6NbN6xLlIqT3pgyUKivUb5Bvpkxk37Mu0jEpCuZW6MiEavkXySi0Naxhbs7pttPplwu+XOQ+/4lLC3HmPWTf/e+nvNK7g3qmhbrx/INlg1vEf7l8GQnvvvN+w2PInV+p1c/9Wv2kcjbR+2Pxv0zvWcfiTc+a9fRXvA/RnK4z+yGndM4PXfh0ZdurzcrYlaLrjcrL9dtvbxYJiuCZ/fC+jRNqe7GsfXEXXYH57vDj2K5/A+6dvoM +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List detected ad-marker history for a channel with pagination, filtering, and sorting. Each entry records the detected marker and the action taken, plus (when applicable) the matched marker rule, the resulting break, and a reason for skipped/failed detections. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events-event-id-breaks-active.api.mdx b/ads/api/reference/get-channels-channel-id-events-event-id-breaks-active.api.mdx new file mode 100644 index 000000000000..768a5f3843cc --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events-event-id-breaks-active.api.mdx @@ -0,0 +1,4061 @@ +--- +id: get-channels-channel-id-events-event-id-breaks-active +title: 'Get /channels/{channelId}/events/{eventId}/breaks/active' +description: 'List the currently active breaks for the event within the channel DVR window.' +sidebar_label: 'Get /channels/{channelId}/events/{eventId}/breaks/active' +hide_title: true +hide_table_of_contents: true +api: eJztXVtz27iS/iso1j5YtZQtZ3JmM5qHlHeSM+s6ziTlXE7tOt4VRLQkjEmAAUApGsf/fasBkKIkenyJc5KJeh4yFgkCDaAvX/dHSJeJAJsZWTqpVTJMTqR1zM2AZZUxoFy+ZDxzcg5sbIBfWDbRxt+HOSjHFtLNpAoPzLhSkLNn707ZQiqhF/tJmpTc8AIcGJsMzy43BjsWoJycSDBMT9qd4JMSW5TczZI0UbyAZJjEu8ciSRMDHyppQCRDZypIE5vNoODJ8DJxyxIbW2ekmiZXV+nNw/rJXDOov3fHIc+xsS21smDx/qPBAP+XaeVAOfyTl2UuM44SHfxuUazLVn9cCIm3eP7K6BKMk9jPhOcW0qRsXbpMBHf+EemgsHd8drWew1tvDXMzaYMysDHkWk0tcxrXrpDqBNTUzZLhYbq5JKmfvNH5zTKuC/KyDA1ZmfPlmGcXrO6oUUUvTMpslc0Yt8xeyJJxJZhVvPRPjGHG51Ibr5BrK4BtX04mFtz2EvxWFeMwfQuZVsL6weYSFmBYUVnHFtxlMzaGiTawkoSNIdMFBEFKPs5hn72QShZVwQZxofBDMhw0y6T8WLhMtdDb8vxzBm4Gpi2FtIznuV6AYE4zC3DB9Bxaq7LP/jkDxUChGCJlvH4S20o13WiOHRpwlVGhR7xhHTeuVoLQChcXt8My6ZhUbFLl+c9MqwzWuxJaQbraOAO2wnXhwcNoI6cSd9bLXWrrVSJKvCaoZVJFaeJeuxksGTfAeG71XURuSZwyPnFg2GIms9m1UgqY8Cp38TIrtVSO7YVPQXNS1tZDJirjzZotcB5KO2bB9eK08GNpwIJy6d02Mml0Zax1DlyhZ6sv6fHvkDlvZQa4A3HUoc9vZAHW8aIMkq0kXnDL4nMpGhBX7Pj1S/bkx8EhE9yBkwWuKRpyS4yVZdcz3h7yP9dXRKralO5iEWCMNi/AWj6F7SH+qyq46hvgAlWcGeBWtycHyoEBwZ6fnr48Rc1wld1nr8IeMK3yZViOcAc3wrfsnGgdCm7hLUN47PSVKZMTxtWycwjZ0ftbJT9UwOTWIHH7tmLwLbxxwc0FmGfgIMNRuib1d20Yr5zuC98KRIQAQXG3pQldMlH3yQxk2gjmZhyVXosqQ/VulmSfHY39JqAfj+giqiGbS+77PHp13LlMYazTKocHlNxUOQRpC3TsIEIUqTBUe8mBOSjKnDv4HNmD37tO7tjZuvgTowvG0QaBF1Hc6yYTumeLmbborvIc3XzT02q6nzOFtvvbnka43rL2OmR7URYzMMAiFOpwu94nbwawLb+54WulZZXFDQtBOjpr7QXpjijevfKWCTW4Yr/BDU3Y3OoTB5RTpU1UkpYrj9EMw0QtldPx6TsBAQxiHiyp5cuJR88TbQrukiGCPuijW/YI2zkwuO7/u/d0uPd0+P69eP9enD16/OOT87PB4yfnn+KVwx/+9h8/nZ89+rG+MjjDu2eDVdPB4FOr2WDQ6w8e9R/9hO0vH1/1wwAD3+TJ+afDs8Gj814/XOr/dP7p7PDR+fv34tMPZ4PD894nf+Pxjz+dfzo87Gw2CG0etW8e4p1HZ4P+k/Ner/cmDIn91dd/OO8Nzwb9v+GFvafD9t/v3++/fy/+vfe093Tv6fB/er1/69Deyz9b9/NN/PkaHUGVg+hAFfvspWILnudZrhGYBu/7pwEUYRJ79eZ1q7H/GMZfs8msahwX4wsuHVoPj2Jgl/tRTVxlt43wRE4gW2Y51JFNT2p1H7LRq9Pnr45Oj3/7dcT2mr7hIyqSB2SuKnspG/3y9vmzEdsrDfQFZNJKjShrvGS/aj3NgT07Ok67ZcOnT58fPfvvEduDXE4lBmeclYBczsEsscHr419/OzrxQ8TLwVjQKYCxPY+sRj4ej9jehMscRA8NBxTu3lnSTCNJE5Q1SRM/aJImdd9JmvgOkvMOP1a789vF9Lp1O6y3sJP30k1wZ0fBCfSl8pbKDEzAQMDI3PsGdGoXUAZPuVRZcENrYabL+c65kVxtuAatIP51h/yPWwuuQ3eO/PWwDSKmWdKyOPA+O3IsB24RPkFIGUJi7DPoOg+9l0TXQ8lntauPm+Flb8WYNMC4C6UX6i5utgZcHuUnw2QQ/+v7fx7jP0/qj/V/yaaTuBahBSlbCC36jVdGz6UIthSqLdbpAp+LyGUKCozXKgTk7O3b42dhgrqQzoWlvgHiSUS+PKuX8z45d6uLJolu0m4/t1XazVmWy+yi72ZGV9MZe3t6sp1v+yZvQovtPf5lswOmS0CP0yQsdboU5bIrk+Fin73ApHwMGOp5LkUtQhM2KyO3DaoriypASP7GX92U8QXeYviE96gqLMOQjXA/9ch7LFnwKYzajsrfROvAO52uqJAFXDPi8YvnzYArpfIysj3cDfjIizKHKMNBUT4e9dbt4QiTy4CNgnNFN4ug0BRSAavKidFYzoslBulYxlVImL3p+yF/ZhrvLqQFbDFDsKWZM8uUFdxXE4JkpQEs+3mtsZjUmk4/5jpn631PmK6QeKOQijtt9tkIA5nMRkPGmZAGMtegyJVvXWljWB9tmF/zWhfqDQl9de4Eakk37OrUn/R+tTfHzRQwbN7XNgXMJQaTup8QVizk4O0iWIy07O3pcQ1Et+0xdNKtd8/iALgVvidQzizjgLZB1SEOlsGhWWZhDobndbCIOVdUulo6n6coCHlWkL2x7SBSe68E2AunS1x6xOMOXZ8eyxzRr5t37GGXSc95XnVM8k1jT7hOTagLU10zrpZGvTt6/YY5PkWl6t3oia/aleOzKMh5l9eR6jho0qoTbgxfdsDSE52thcOgz7UzAunNmDMrFeI0dKVBHA+p0Gthv/gw3sLZSrAMeDYLHlVfp2X7W/ORWBpfOcwoeTCjjlkSHCA4QHCA4MDnw4E5t86DgbY7bs/JgNX5HLxYE0CqBks1BpSIFSafuMn5WrDBXgkWECz4a8KCRoQ84oPvBwv47XjVep3guqe36PhrbYULtno/gZU4ApZyQ7yJXOIclMBlsqH+jlpZ8HKf/X2lA6lXkFgSOxLsBVd8GlyMBc9SYkcjLt7w6WoCo5YXXG02IR5CPIR4CPF0Ix7vizzmCX/2C+9qRG1mnlpD5X0nYcHCTRtfYwhl9xVbFfxauw0XrK7yR6q/2T3f+M9g0cp/lDnPYKZzAWbLTbyrnWmMrMGNbnvOUscpBcEiVnHLUmY8z5esUn5b8R2NgOG08hOrlOfbhF6owJX+XL+/4XeKs5Zwt3AgcdrbWyTq5YtvebXYjWb9vEDNsnv2Zd6a/j77pXnDzr+FMJryYsT2thZjjfCY8qJzF0LPDxIdwx71bQmZnMisHSG3guA79DLeSZdg4vR+9gsRZsPZCEcbsYmEXLSpAraXbUy/1GLU64iJt4QYca/S6OO2FmQbfpz/ObZauc3N7X8XMCzL+VJXbrtM6XGWt1J8zahvMwOgIiCeyMCC+3dElJOm8Ufo2Utt3FqV0nfVTV09eKKwzfPcA8qXMru4FZBnR3UHPoThQq5Ekf6VASuFZwR5bcRRok0B2IeK53KyZHtFlTuJgaC2eg9xm6vNA+3sCJjlhZff4Yb30vgWhfBhNr4d1rxvJmAiMSCjoQuww/bcKxsd6UQa61bT829iBGVaCyzxPaVoCI0Eu5uObZh6tL+05ikfJIO4M92ZhlSo5N5tebjFWaaLkisfdoIzvxUlyvP8c+hayg0oN6DcgHIDIkepCkpVUCJHCQ4QHCA4QHCAyFGCBQQLiBwlcpQQDyEeQjw7iniIHCVylMjRhyNH7/ZVIjUh0uG317kSNNxItXB/JF6KgAFKIwuORuhb7XllHS/ZSOhqnMPIq8wotzNewv9xMWrQsl8XIlQITxCeIDxBhApVTqhyQoQKESoEBwgOEBwgQoVgAcECIlSIUCFChRAPIR5CPESoEKFChMpXIFQ2ul4xJv+6o2mRShl6fCagP172Pf0SmweL9lgsxnvL7AxVv/vYS/NNhj7U8uxianSlBMYuGQ2/PcwanPaS0Mk2Otm2E6kfnWyjyivlIZSHUB5CRCxVXKniSkQswQGCAwQHCA4QEUuwgGABEbFExBLiIcRDiIcQDxGxRMQSEUsn2+hkG+EJwhOEJ4hQocoJVU6IUCFCheAAwQGCA0SoECwgWECEChEqRKgQ4iHEQ4iHCBUiVIhQ2emTbSv2ZIi+9KTvP4v1k23ROHWWVaWMxnrSn+Dc9tnz1bG3WYhCtzvsFn3pxohtZWtko+NudNxtJ/LBb/K42y2PshHfSukGpRuUbhDfSoXVrx5Iv7vCKvGtBAcIDhAc2GE4QHwrwQKCBcS3Et9KiIcQDyGeHUA8xLcS30p868MdYPuSFGqsTd7Eo6J+NHXMTkZ1mwGNzYkGJRp0J9K0r0uDhm/ujfBVz8HkfEkcKKUAlAJQCkAcKBU7/ypR9LsrdhIHSnCA4ADBgR2GA8SBEiwgWEAcKHGghHgI8RDi2QHEQxwocaDEgX7jHGikSYKZSlvxvGZOIp2CHJcuV5UbVNSG8POe3VSlx+7of/CYaFsFYl+daqBLnkm33Bb5ZRQgNgg7OVlFNrcAUGzA9iYV2pczXNmS4/70vB4f1nd0yT9UENAt/xhQxeENCKPUVt4nCEeZ68fbKALDYKmN22enQTcs+oIVKYVri0ts2Fg7pws/iXgjh4nDO0ZOZ247QocHOvCXtI5jiTnuW72ncQAQU2ATo4uAcsLF2LSWNr123f0a32lRcRa3F9LPeV3EsAxfTkC/vLeX0DffEDFc+4IyYvp4awlRodbla1nxw0vXBcus/APuaUX4KMpWS2Y3Jd+2hBl0b2HdZbi/MeGNXmOj9LO2aSGF60DLtRz+9g1i+DafI8VGGAoipfUadeXt9DYKvY3yvRXMbngbpRXro7O65rvTP+8tETq7T2UbKttQ2eYvUrah91aIoCKCit5bIThAcIDgwM7DAXpvhWABwQJ6b4XeWyHEQ4iHEM8OIB56b4XeW6H3Vr7x91YCzvJWiu969G1mkCoNgHgi87xGthgrTeOP2vxxU6X0XdEZfWJFdyId+ya/qjwNqVDJvdvycGvr9whuSYnyPI+1AyJHKTeg3IByAyJHqQr61cPud1cFJXKU4ADBAYIDOwwHiBwlWECwgMhRIkcJ8RDiIcSzA4iHyFEiR4kcfThy9E4AZPU709t+e+O3m4W0kWrhuVZTZPmC6zGy4GiEvtWeV9bxko2ErsY5jLzKtH5bukHLfl2IUCE8QXiC8AQRKlQ5ocoJESpEqBAcIDhAcIAIFYIFBAuIUCFChQgVQjyEeAjxEKFChAoRKl+BUNnoesWY/OuOpkUqZejxmYD+eNn39MvaL8p6LBbjff3Lld3HXgLal8Fs8PuVp0ZXSmDsktHw28OswWkvCZ1so5NtO5H60ck2qrxSHkJ5COUhRMRSxZUqrkTEEhwgOEBwgOAAEbEECwgWEBFLRCwhHkI8hHgI8RARS0QsEbF0so1OthGeIDxBeIIIFaqcUOWECBUiVAgOEBwgOECECsECggVEqBChQoQKIR5CPIR4iFAhQoUIlZ0+2bZiT4boS0/6/rNYP9kWjVNnWVXKaKwn/QnObZ89Xx17m4UodLvDbtGXbozYVrZGNjruRsfddiIf/CaPu93yKBvxrZRuULpB6QbxrVRY/eqB9LsrrBLfSnCA4ADBgR2GA8S3EiwgWEB8K/GthHgI8RDi2QHEQ3wr8a3Etz7cAbYvSaHG2uRNPCrqR1PH7GRUtxnQ2JxoUKJBdyJN+7o0aPjm3ghf9RxMzpfEgVIKQCkApQDEgVKx868SRb+7YidxoAQHCA4QHNhhOEAcKMECggXEgRIHSoiHEA8hnh1APMSBEgdKHOg3zoFGmiSYqbQVz2vmJNIpyHHpclW5QUVtCD/v2U1VeuyO/gePibZVIPbVqQa65Jl0y22RX0YBYoOwk5NVZHMLAMUGbG9SoX05w5UtOe5Pz+vxYX1Hl/xDBQHd8o8BVRzegDBKbeV9gnCUuX68jSIwDJbauH12GnTDoi9YkVK4trjEho21c7rwk4g3cpg4vGPkdOa2I3R4oAN/Ses4lpjjvtV7GgcAMQU2MboIKCdcjE1radNr192v8Z0WFWdxeyH9nNdFDMvw5QT0y3t7CX3zDRHDtS8oI6aPt5YQFWpdvpYVP7x0XbDMyj/gnlaEj6JstWR2U/JtS5hB9xbWXYb7GxPe6DU2Sj9rmxZSuA60XMvhb98ghm/zOVJshKEgUlqvUVfeTm+j0Nso31vB7Ia3UVqxPjqrO8OurZLWUV24CgvU/O4sAmmWS+sDRKM33jc3GnGf9eoEnE1ZBiuGfqgkTbIZVwryY2yA/FuFC+DzERBH1/iEtblujCS44x1PXW1B9GfBdthpyD7A94Tq6GU8FskwmYLrR/lsvxG0D3NQzob/HYu+X1LbR58591rApxYlee6boSwFuJmOHeL2cnTEyQEv5cH88KAe4eCyGeLqIIxxcBkHuToIoxw0o1jIKuNh6tllMuZWZkcVdnt2nibaTFH+s3NUhLrh62wGRURnq+ZbWdmrY3YBS//d+EbxAgJ0tZAZ/MZ8LO8ttBEeu1rfYzIM/a2SjplzpQfSQYytiGOmXMk/QsK5Knb5957w/gx4SHtx+GSYfOxrM+17Dap3vpT/gLD1Uk20z8ekyyH6fZ+3HwnLjl4d+yzG2DDy/DAiaVdwD6TjCL+CY/fchrWp4W8UhBcrh8kJGlXL7+VLFh4KJmibApjvug3L4/Ds2btTtpBK6EUroXPw0R2UOZcq1A1yHDUo1BmuC873cGVWaEzDtomFCeHVOKUkTYJA6IDCrM7TZKatwx4vL8fcwluTX13h5Q8VmGXQMW/B+MvxqH9CWvxbdAfj9rLsxVRD9NjxVp0zCnrtdOvtV8ukIR2SJE0uYJkMW54Ei+IPJJJfpXsKVK+w99ZRq3G1wt2jLIPStZ7jZZnLQDgc/G618m68cR2/Pn+TXF39P3uOME8= +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List the currently active breaks for the event within the channel DVR window. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events-event-id-breaks-current.api.mdx b/ads/api/reference/get-channels-channel-id-events-event-id-breaks-current.api.mdx new file mode 100644 index 000000000000..a23bcc960538 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events-event-id-breaks-current.api.mdx @@ -0,0 +1,4061 @@ +--- +id: get-channels-channel-id-events-event-id-breaks-current +title: 'Get /channels/{channelId}/events/{eventId}/breaks/current' +description: 'List the breaks currently playing for the event (request time within the break start + duration window).' +sidebar_label: 'Get /channels/{channelId}/events/{eventId}/breaks/current' +hide_title: true +hide_table_of_contents: true +api: eJztXVtzG7eS/iuoqX0QK6REOT5Zh3lwaWOfrGrl2CXbOXVW1i7BmSaJaGYwBjCkGVn//VQ3MBeSo+hi+dgxOw+OOIMBGkBfvu5vQF5GCdjYqMIpnUej6ERZJ9wcxMSAvLAiLo2B3KUrUaRypfKZmGpDDWABuRN7Bt6XgM+oDMRSubnKm+eFddI48Z1ISiNxBLFUeaKXvf2oHxXSyAwcGBuNzi435DhOIHdqqsAIPaUO47nMc0jxSYUtCunmUT/KZQbRKAp3j5OoH6FIykASjZwpoR/ZeA6ZjEaXkVsV2Ng6o/JZdHXVv3lYmuY1g9K9Ow55jo1toXMLFu8/Gg7xf7HOHeQO/5RFkaqYluvgd4tiXbb6k0mi8JZMXxldgHEK+5nK1EI/KlqXLqNEOnpEOcjsHZ9t1nN0660Rbq5s2PgJpDqfWeE0rl2m8hPIZ24ejQ77m0vSp8kbnd4s47ogLwvfkFRzIuMLUXVUKykJ0xe2jOdCWmEvVCFkngiby4KemMBcLpQ2pJBrK4BtX06nFtz2EvxaZhM/fQuxzhNLgy0ULMGIrLROLKWL52ICU22gZQ8TiHUGXpBCTlLYFy9UrrIyE8OwUPghGg3rZcppLFymSuhtef4xBzcH05ZCWSHTVC8hEU4LC3Ah9AJaq7Iv/jGHXECOYiR9IasnsS0a+npz7NCAK03ue8Qb3rqDEvhWuLi4HVYoJ1QupmWa/iR0HsN6V4nOod9snAFb4rpI73y0UTOFO0tyF9qSSgSJ1wS1QuVBmrDXbg4rIQ0ImVp9F5FbEveFnDowYjlX8fxaKROYyjJ14bIotPIOET95zemLth62vCDOI9dOWHC9MC38WBiwkLv+3TYyqnVlonUKMkfPVl3Sk98hdmRlBqSD5KhDn9+oDKyTWeElayReSivCc300IJmL49cvxZMfhocikQ7I63tDbonRWHY14+0h/2t9RVRemdJdLAKM0eYFWCtnsD3Ef5eZzAcGZIIqLgxIq9uTg9yBgUQ8Pz19eYqa4Uq7L175PRA6T1d+Ofwd3Ahq2TnRKhTcwlv6wNnpK/tCTYXMV51DqI7e3+bqfQlCbQ0Stq+Jx63weYM3zqS5APMMHMQ4Stek/q6NkKXTg4RaQRLgglfcbWl8lyKp+hQGYm0S4eYSlV4nZYzqXS/Jvjia0CagH6+QiFdDsVCS+jx6ddy5TH6s0zKFB5TclCl4aTN07JD4KFJiqCbJQTjIilQ6+BTZvd+7Tu7Q2br4U6MzIdEGQWZB3Osm47sXy7m26K7SFN183VMz3U+ZQtv9bU/DX29ZexWySZTlHAyIAIU63C755M0AtuU3N3ytsqK0uGE+SAdnrUmQ7ohC7lW2TKjGFfs1bqjD5lafOKCa5doEJWm58hDNMExUUjkdnr4TEMAgRmApX72cEnqeapNJF40Q9MEA3TIhbOfA4Lr/397T0d7T0bt3ybt3ydmjxz88OT8bPn5y/jFcOfz+b//54/nZox+qK8MzvHs2bJoOhx9bzYbD3mD4aPDoR2x/+fhq4AcYUpMn5x8Pz4aPznsDf2nw4/nHs8NH5+/eJR+/Pxsenvc+0o3HP/x4/vHwsLPZ0Ld51L55iHcenQ0HT857vd4bPyT2V13//rw3OhsO/oYX9p6O2n+/e7f/7l3yXe9p7+ne09H/9nr/0aG9l3+27ueb+PM1OoIyhaQDVeyLl7lYyjSNU43A1HvfPw2gCJPEqzevW43pox9/zSbjsnZcQi6lcmg9MoiBXe4HNXGl3TbCEzWFeBWnUEU2Pa3UfSTGr06fvzo6Pf71l7HYq/uGD6hIBMhcWfT6Yvzz2+fPxmKvMDBIIFZWaURZk5X4RetZCuLZ0XG/WzZ8+vT50bN/jsUepGqmMDjjrBJI1QLMChu8Pv7l16MTGiJc9saCTgGM7RGyGlM8Hou9qVQpJJRVQo67dxbV04j6Ecoa9SMaNOpHVd9RP6IOovMOP1a589vF9Kp1O6y3sBN56Tq4iyPvBAYqJ0sVBqZgwGNkSb4BndoFFN5TrvLYu6G1MNPlfBfSKJlvuAadQ/jrDvmftBZch+4c0XW/DUlIs5QVYeB9ceRECtIifAKfMvjEmDLoKg+9l0TXQ8lnlasPm0Gyt2JM38O4i1wv87u42QpwEcqPRtEw/Degfx7jP0+qj9V/0aaTuBaheSk3KyaIP/VCJd6WCLiV1ukMnwvIZQY5GNIqBOTi7dvjZ36COlPO+aW+AeIpRL4yrpbzPjl3q4s6ia7Tbppbk3ZLEacqvhi4udHlbC7enp5s59vU5I1vsb3HP292IHQB6HHqhKVKl4JctjEZmeyLF5iUTwBDvUxVUolQh83SqG2D6sqiMkiUfENXN2V8gbcEPkEeNffLMBJj3E89Jo+lMjmDcdtR0U20DrzT6YoylcE1Ix6/eF4P2CgVySj2cDfgg8yKFIIMB1nxeNxbt4cjTC49NvLOFd0sgkKTqRxEWUyNzh0+QiUG5UQsc58wk+nTkD8JjXeXygK2mCPY0sKZVV9kkqoJXrLCAJb9SGssJrWm04+5ztmS7/HTTRTeyFQunTb7YoyBTMXjkZAiUQZiV6PIxrc22ujXRxtBa17pQrUhvq/OnUAt6YZdnfrTv1/tzUkzAwyb97XNBBYKg0nVjw8rFlIgu/AWo6x4e3pcAdFte/SddOvdszAAbgX1BLkzqzCgrVG1j4OFd2hWWFiAkWkVLELOFZSuko7ylBx8nuVlr23bi9TeqwTshdMFLj3icYeuT09UiujXLTr2sMukFzItOyb5prYnXKc61PmprhlXS6N+O3r9Rjg5Q6Xq3eiJr9qV47MgyHmX11H5sdekphNpjFx1wNITHa+FQ6/PlTMCRWYshVU54jR0pV4cglTotbBffBhv4WwVWAEynnuPqq/Tsv2t+SgsjTcOM0juzahjlgwHGA4wHGA48OlwYCGtIzDQdsftORmwOl0AiTUFpGqwVGMgT0KFiRI3tVgLNtgrwwKGBX9NWFCLkAZ88O1gAdqOV63XCa57eouOv9ZWZCKa9xNEgSNgKdfHm8AlLiBPcJmsr7+jVmay2Bd/b3SgTwoSSmJHiXghcznzLsYCsZTY0Vgmb+SsmcC45QWbzWbEw4iHEQ8jnm7EQ76IMI//c5CRq0kqMyNqDZX3NwVL4W/a8BqDL7s3bJX3a+02MhFVlT9Q/fXuUeM/g0WN/yhSGcNcpwmYLTfxW+VMQ2T1bnTbcxY6TMkLFrCKWxUqlmm6EmVO24rvaHgMp3OaWJkT35boZe650p+q9zdop6RoCXcLBxKmvb1FSbV84S2vFrtRrx8JVC87sS+L1vT3xc/1W3f0FsJ4JrOx2NtajDXCYyazzl3wPT9IdPR7NLAFxGqq4naE3AqCv6GXISddgAnT+4kWws9GijGONhZTBWnSpgrEXrwx/UIn415HTLwlxAh71Q8+bmtBtuHH+Z9jq8Ztbm7/bx7DilSudOm2y5SEs8hK8TWjgY0NQB4A8VR5FpzeEcmdMrU/Qs9eaOPWqpTUVTd19eCJwjbPcw8oX6j44lZAXhxVHVAIw4VsRFH0yoBVCTGCsjLiINGmAOJ9KVM1XYm9rEydwkBQWT1B3Ppq/UA7OwJhZUbyO9zwXj+8RZFQmA1vh9XvmyUwVRiQ0dATsKP23EsbHOlUGeua6dGbGF6Z1gJLeE8pGEItwe6mYxumHuyvX/GUD5JB3Jnu7PtUqJDktghuSRHrrJA5hR3vzG9Fico0/RS6lnMDzg04N+DcgMlRroJyFZTJUYYDDAcYDjAcYHKUYQHDAiZHmRxlxMOIhxHPjiIeJkeZHGVy9OHI0bt9lUhFiHT47XWuBA03UC2SjsSrxGOAwqhMohFSqz1S1slKjBNdTlIYk8qMUzuXBfy/TMY1WqZ1YUKF8QTjCcYTTKhw5YQrJ0yoMKHCcIDhAMMBJlQYFjAsYEKFCRUmVBjxMOJhxMOEChMqTKh8AUJlo+uGMfn3HU0LVMqI8FkCg8lqQPRLaO4tmrBYiPdW2Dmqfvexl/qbDCnUyvhiZnSZJxi7VDD89jBrcJok4ZNtfLJtJ1I/PtnGlVfOQzgP4TyEiViuuHLFlYlYhgMMBxgOMBxgIpZhAcMCJmKZiGXEw4iHEQ8jHiZimYhlIpZPtvHJNsYTjCcYTzChwpUTrpwwocKECsMBhgMMB5hQYVjAsIAJFSZUmFBhxMOIhxEPEypMqDChstMn2xr2ZIS+9GRAn5P1k23BOHUcl4UKxnoymOLc9sXz5tjb3Eeh2x12C750Y8S2stWy8XE3Pu62E/ngV3nc7ZZH2Zhv5XSD0w1ON5hv5cLqFw+k31xhlflWhgMMBxgO7DAcYL6VYQHDAuZbmW9lxMOIhxHPDiAe5luZb2W+9eEOsH1OCjXUJm/iUVE/6jpmJ6O6zYCG5kyDMg26E2nal6VB/Tf3BviqF2BSuWIOlFMATgE4BWAOlIudf5Uo+s0VO5kDZTjAcIDhwA7DAeZAGRYwLGAOlDlQRjyMeBjx7ADiYQ6UOVDmQL9yDjTQJN5MlS1lWjEngU5BjksXTeUGFbUm/Mizm7Ig7I7+B4+JtlUg9NWpBrqQsXKrbZFfBgFCA7+T0yayuSVALoZib1qifTkjc1tI3J8e6fFhdUcX8n0JHt3KDx5VHN6AMApt1X2CcJC5eryNIjAMFtq4fXHqdcOiL2hIKVxbXGIjJto5ndEkwo0Upg7vGDWbu+0I7R/owF/KOokl5rBv1Z6GASCZgZganXmU4y+GppW0/WvXndb4TouKs7i9kDTndRH9Mnw+AWl5by8hNd8Q0V/7jDJi+nhrCVGh1uVrWfHDS9cFy6z6A+5pRfgoylZJZjcl37aEOXRvYdWlv78x4Y1eQ6P+J23TUiWuAy1XctDtG8SgNp8ixUYY8iL1qzXqytv5bRR+G+VbK5jd8DZKK9YHZ3XNd6d/2lsifHafyzZctuGyzV+kbMPvrTBBxQQVv7fCcIDhAMOBnYcD/N4KwwKGBfzeCr+3woiHEQ8jnh1APPzeCr+3wu+tfOXvrXicRVaK73oMbGyQKvWAeKrStEK2GCtN7Y/a/HFdpaSu+Iw+s6I7kY59lV9V3vepUCHJbRHc2vo9gltSojJNQ+2AyVHODTg34NyAyVGugn7xsPvNVUGZHGU4wHCA4cAOwwEmRxkWMCxgcpTJUUY8jHgY8ewA4mFylMlRJkcfjhy9EwBpfmd6229v/HZzomygWmSq8xmyfN71GJVJNEJqtUfKOlmJcaLLSQpjUpnWb0vXaJnWhQkVxhOMJxhPMKHClROunDChwoQKwwGGAwwHmFBhWMCwgAkVJlSYUGHEw4iHEQ8TKkyoMKHyBQiVja4bxuTfdzQtUCkjwmcJDCarAdEva78oS1gsxPvqlyu7j714tK+82eD3K8+MLvMEY5cKht8eZg1OkyR8so1Ptu1E6scn27jyynkI5yGchzARyxVXrrgyEctwgOEAwwGGA0zEMixgWMBELBOxjHgY8TDiYcTDRCwTsUzE8sk2PtnGeILxBOMJJlS4csKVEyZUmFBhOMBwgOEAEyoMCxgWMKHChAoTKox4GPEw4mFChQkVJlR2+mRbw56M0JeeDOhzsn6yLRinjuOyUMFYTwZTnNu+eN4ce5v7KHS7w27Bl26M2Fa2WjY+7sbH3XYiH/wqj7vd8igb862cbnC6wekG861cWP3igfSbK6wy38pwgOEAw4EdhgPMtzIsYFjAfCvzrYx4GPEw4tkBxMN8K/OtzLc+3AG2z0mhhtrkTTwq6kddx+xkVLcZ0NCcaVCmQXciTfuyNKj/5t4AX/UCTCpXzIFyCsApAKcAzIFysfOvEkW/uWInc6AMBxgOMBzYYTjAHCjDAoYFzIEyB8qIhxEPI54dQDzMgTIHyhzoV86BBprEm6mypUwr5iTQKchx6aKp3KCi1oQfeXZTFoTd0f/gMdG2CoS+OtVAFzJWbrUt8ssgQGjgd3LaRDa3BMjFUOxNS7QvZ2RuC4n70yM9Pqzu6EK+L8GjW/nBo4rDGxBGoa26TxAOMlePt1EEhsFCG7cvTr1uWPQFDSmFa4tLbMREO6czmkS4kcLU4R2jZnO3HaH9Ax34S1knscQc9q3a0zAAJDMQU6Mzj3L8xdC0krZ/7brTGt9pUXEWtxeS5rwuol+GzycgLe/tJaTmGyL6a59RRkwfby0hKtS6fC0rfnjpumCZVX/APa0IH0XZKsnspuTbljCH7i2suvT3Nya80Wto1P+kbVqqxHWg5UoOun2DGNTmU6TYCENepH61Rl15O7+Nwm+jfGsFsxveRmnF+uCs7gy7tkpaR1Xhyi9Q/buzCKRFqiwFiFpvyDfXGnGf9eoEnHVZBiuGNFTUj+K5zHNIj7EB8m8lLgDlI5AcXeMT1ua6MVIinex46moLoj/ztiNOffYB1BOqI8l4nESjaAZuEOSzg1rQASwgd9b/7zgZ0JLaQdBvUoyZRVGeUzsUJgM316FH3F+Jnjg6kIU6WBweVEMcXNZjXB34QQ4uwyhXB36Yg2YYC3FpCKieXUYTaVV8VGK/Z+f9SJsZzuDsHFWhavg6nkMW8FnTfCsve3UsLmBF345vcpmBB68WYoPfmY8FvqU2CaFXSz1GI99fk3bMnSsISnsxtmKOmclc/eFTzqbcRW8+4f05SJ/44vDRKPow0GY2IB2q9r5Q/wN+81U+1ZSRKZdC8PyUuR8lVhy9OqY8xlg/8uIwYGmXSYLSYYRfwIn77sPa3PBnCvy7laPoBO2qLtdZ0SRraFFNLAJBnYs91GPAZ1QGW+U+ZKeNE9+JyozEUuWJXrbTPQcf3EGRSpX7qkKKAnltO8M1w7U4bIwOTW3UNkA/Wbwaphv1Iy88PhRmfN6P5to67PLyciItvDXp1RVefl+CWXkFJAPHH5ZH5UyUxb+T7ljdXrK9kIkkPXG8VQYNkl4730o38lVUcxJR1I8uYBWNWo4Ga+YPJBIt0z0FqpaYnHlQeVwtf/cojqFwredkUaTK8xEHv1udk5evHcsvz99EV1f/Aj0ORms= +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List the breaks currently playing for the event (request time within the break start + duration window). + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events-event-id-breaks.api.mdx b/ads/api/reference/get-channels-channel-id-events-event-id-breaks.api.mdx new file mode 100644 index 000000000000..c1b6987cbaac --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events-event-id-breaks.api.mdx @@ -0,0 +1,4104 @@ +--- +id: get-channels-channel-id-events-event-id-breaks +title: 'Get /channels/{channelId}/events/{eventId}/breaks' +description: 'List all breaks associated with the event, with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/events/{eventId}/breaks' +hide_title: true +hide_table_of_contents: true +api: eJztXW1z2ziS/iso1n2w6iRHymRmEqVSKd8kO+s6Z+J1ktnac3wniGxJGJMEA4BWNE7++1U3wBdJdPwSZ5OJez5kLBIEGkC/PN0PKJ1HCdjYqMIpnUfj6EBZJ2SaiqkBeWqFtFbHSjpIxFK5hXALEHAGuev7z4Wcq1ziw30xU6kDo/J5X8g8EVYbp/L5btSPCmlkBg6MjcbH5xtDjgZTaSHBrkDkZTYFI5wWBlxp8l3xQuUqKzMxwo4UPvCuBLOK+lEuM4jGET4X9SMD70plIInGM5la6Ec2XkAmozGON5Nl6qLxqB9l8j12F40fDYc/jx49uv/jg58fDB89wlt+JGrmVgX2rXIHczDRx4/9TbF/85LqmVAOMtuILAowNJm+mIJbAuRiRAsyGg4/NYdX6s+rzuP+sDWR0XB4Xdlf0h8yFUev/nEQ9k3A+8KAtUrnYmem8bPMihTExDrpSvvkydHzvWf/epyUhvb7ydw9+WE46e2K5zJeCANWlyYG7EZbsEI5K/QyR2XSy0GKeqVnYSw5TUHMFKSJpZXRBRjptLEXrY9/7NOrE6ZtHargJ2cd6yyTAwuolqjZjXAkkdOku2K6eiwKAzP1Xkh/z+v8ZDARuEDYO+SJyudCmwTMrnjmN4i6yGEJ1omZMtaJndgADrXnWk/1Lpotjv6Zc91PIHdqpryGotXGC5nnkNZjFtItmiHD3f1kbVxnys8dlpzFBYPSvWsOeYKNbaFzCxbv3x8O8X+xzh3kDv+URZGqmHT03h8WxTpv9SeTRHk1ODSodk5hP2GBi9al8yiRLphde4qvF+BdlZ6h0uN20/TQCVxzgGbRt0a5cP+EWyjrvbOYQqrzOWobSpCp/ADyuVu0nUC1bn1aIaPTy2W8wGiKVK6mMj4VVUdkAygZCdMXtowXQlphT1XhA0AuC3piCgt5prShULC2Atj25WxmwW0vQeNgLcQ6R8NcgDhTsAQjstI6sZQuXogpzLSBRhIxhVhn4AUp0NU0QWQYFsr7ymG9TD7s4DJVQm/L888FuAWYthTKevcGCTkNgFOhz6C1KrvinwvIBeQoRtIXsnoS25LjWGuOHfog4nvEG9ZJ4yol8K1wcXE70MkKlYtZmaaPhc5jWO8q0Tn0m41DbcV1kY6aaaMwdqde7kJbUokg8ZqgVqg8SBP22i1gJaQBIVOrryNyS+K+kDOMO8uFihcXShliXrgsCq1yJ3b8J685fdHWQ1HFJ7HEeeTaCQuuF6aFHzHKEYC51kZGta5MtU5B5uj+qkt6+gfEjqys8vMdjkNlYJ3MCi9ZI/FSWhGe66MByVzsv3opHv40HIlEOnAqwzU1AUxtWXY14+0h/2t9RVRemdJ1LAKM0eYFWIs4a2uIv5eZzAcGZEJB3YC0uj05yB0YSMTzo6OXR8JDiV1x6PdA6Dxd+eXwd3AjqGXnRKt4cQVvSU27fWVfqJmQ+apzCNXR+5tcvStBqK1BwvYpt1D5Zoy9xBtn0pyCeQYOYhyla1J/00bI0ulBQq0gCZjcK+62NL5LkVR9CgOxNolwC4lKr5MyRvWul2RX7E1pE9CPB7gf1FCcKUl97h3udy6TH+uoTOEWJTdlCl7aDB07JD6KlBjPSXIQDrIilQ4+R3bv9y6Su8p71sSfGZ0JiTYIMgviXjQZ371YLrRFd5Wm6Obrnprpfs4U2u5vexr+esvaq5BNoiwXYEAEvNThdsknbwawLb+54WuVFSXmcNIH6eCsNQnSHVHIvcqWCdW4YrfGDXXY3OoTB1TzXJugJC1XHqIZholKKkrN8OlrAQEMYgSW8tXLGeWtM20y6aIxIkMYoFum3NY5MLju/7vzdLzzdPz2bfL2bXJ8/8FPD0+Ohw8ennwIV0Y//Pjzo5Pj+z9VV4bHePd42DQdDj+0mg2HvcHw/uD+I2x//uDjwA8wpCYPTz6Mjof3T3oDf2nw6OTD8ej+ydu3yYcfjoejk94HuvHgp0cnH0ajzmZD3+Z+++YI79w/Hg4envR6vdd+SOyvuv7DSW98PBz8iBd2no7bf799u/v2bfKfvae9pztPx//T6/1Hh/aef2rdTzbx5yt0BGUKSQeq2BUvc7GUaRqnGoGp976fDKAIk8Th61etxvTRj79mk3FZOy4hl1JhMYOcAIqBXe4GNXGl3TbCAzWDeBWnUEU2PavUfSwmh0fPD/eO9n/7dSJ26r7hPSoSATJXFr2+mPzy5vmzidgpDAwSiBXm5ijTSvyq9TwF8Wxvv98tGz5N+fpE7ECq5ooybkpaU3UGZoUNXu3/+tveAQ0RLntjQacAxvYIWU0oHk/EzkyqFBJKWiHH3TuO6mlE/QhljfoRDRr1o6rvqB9RB9FJhx+r3PnVYnrVuh3WW9iJvHQd3MWedwIDlZOlCgMzMOAxsiTfgE7tFArvKVd53FS46jDT5XzPpFEy33ANOofw1zXyP2ktuA7d2aPrfhuSkGYpK8LAu2LPiRQk1ixy8CmDz57X8tAbSXQxlHxWufqwGSR7K8b0PYw7zfUyv46brQBXqGxFw/DfgP55gP88rD5W/0WbTuJChOalbCG04DcOjT5TibclAm6ldTrD5wJymUMOvjiEgFy8ebP/zE9QZ8o5v9SXQDysvxkZV8t5k5y71UWdRNdpN82tSbuliFMVnw7cwuhyvhBvjg62821q8tq32N7jXzY7wMIcepw6YanSpSCXbUxGJrviBSblU8BQL1OVVCLUYbM0atugurKoDBIlX9PVTRlf4C2BT5BHzf0yjMUE91NPyGOpTM5h0nZUdBOtA+90uqJMZXDBiPsvntcDNkpFMm5USmmYe1nxYNJbt4c9TC49NvLOFd0sgkKTqRxEWcyMzh0+QiUG5UQsc58wk+nTkI+FxrtLZQFbLCTVGZ1Z9UUmqZrgJSuMr2yi1lhMak2nH3OdsyXf46ebKLyRYX1fm11fB1bxZCykSJSB2NUosvGtjTb69dFG0JpXulBtiO+rcydQS7phV6f+9M9vVHtz0swBw+ZNbTOBM4XBpOrHhxULKZBdeItRVrw52q+A6LY9+k669e5ZGAC3gnqC3JlVGNDWqNrHwcI7NCssnIGRaRUsQs4VlK6SjvKUHHye5WWvbduL1N6rBOyp0wUuPeJxLE1neqpSRL/urGMPu0z6TKZlxyRf1/aE61SHOj/VNeNqadTve69eCyfnqFS9Sz3xx3Z5+TgIctLldVS+7zWp6UQaI1cdsPRAx2vh0Otz5YxAkRlLYVWOOA1dqReHIBV6LewXH8ZbOFsFVgASKeRR9UVatrs1H4X188ZhBsm9GXXMkuEAwwGGAwwHPh8OnEnrCAy03XF7TkgJp2dAYs0AqRos1RjIk1BhosRNna0FG+yVYQHDgr8mLKhFSAM++H6wAG3HYesgz0VPb3H2F9qKxEM/VYeiwBGwlOvjTeASzyBPcJmsr7+jVmay2BV/a3SgTwoSSmJ7iXghczn3LsYCsZTY0UQmr+W8mcCk5QWbzWbEw4iHEQ8jnm7EQ76IMI//c5CRq0kqMyNqDZX3dwVL4W/acIzBl90btsr7tXYbmYiqyh+o/nr3qPGnYFHjP4pUxrDQaULn5TbCU+VMQ2T1bnTbcxY6TMkLFrCKWxUqlmm6EmVO24pnNDyG0zlNrMyJb0v0Mvdc6ePq/AbtlBQt4a7gQMK0t7coqZYvHAVrsRv1+pFA9bIT+3LWmv6u+KU0BnKXrvwphMlcZhOxs7UYa4THXGadu+B7vpXo6PdoYAuI1UzF7Qi5FQR/Ry9DThrPnHohHtNC+NlIMcHRJuH0YosqEDvxxvQLnUx6HTHxihAj7FU/+LitBdmGHyefxlaN29zc/t89hhWpXOnSbZcpCWeRleIxo4GNDZ7B9YB4pjwLTmdEcqdM7Y/QsxfauLUqJXXVTV3deqKwzfPcAMoXKj69EpAXe1UHFMJwIRtRFB0ZsCohRlBWRhwk2hRAvCtlqmYrsZOVqVMYCCqrJ4hbX60faGdHIKzMSH6HG97rh1MUCYXZcDqsPm+WwExhQEZDT8CO23MvbXCk/sxtPT06ieGVaS2whHNKwRBqCe5uOrZh6sH++hVPeSsZxLXpzr5PhQpJbovglsQT3IXMKex4Z34lSlSm6efQtZwbcG7AuQHnBkyOchWUq6BMjjIcYDjAcIDhAJOjDAsYFjA5yuQoIx5GPIx47ijiYXKUyVEmR2+PHL3eV4lUhEiH317nStBwA9Ui6ZV4lXgMUBiVSTRCarVDyjpdiUmiy2kKE1KZSWoXsoD/k8mkRsu0LkyoMJ5gPMF4ggkVrpxw5YQJFSZUGA4wHGA4wIQKwwKGBUyoMKHChAojHkY8jHiYUGFChQmVr0CobHTdMCb/vlfTApUyJnyWwGC6GhD9Epp7iyYsFuK9FXaBqt/92kv9TYYUamV8Oje6zBOMXSoYfnuYNThNkvCbbfxm251I/fjNNq68ch7CeQjnIUzEcsWVK65MxDIcYDjAcIDhABOxDAsYFjARy0QsIx5GPIx4GPEwEctELBOx/GYbv9nGeILxBOMJJlS4csKVEyZUmFBhOMBwgOEAEyoMCxgWMKHChAoTKox4GPEw4mFChQkVJlTu9JttDXsyRl96MKDPyfqbbcE4dRyXhQrGejCY4dx2xfPmtbeFj0JXe9kt+NKNEdvKVsvGr7vx6253Ih/8Jl93u+KrbMy3crrB6QanG8y3cmH1qwfS766wynwrwwGGAwwH7jAcYL6VYQHDAuZbmW9lxMOIhxHPHUA8zLcy38p86+29wPYlKdRQm7yMR0X9qOuYnYzqNgMamjMNyjTonUjTvi4N6r+5N8BXfQYmlSvmQDkF4BSAUwDmQLnY+VeJot9dsZM5UIYDDAcYDtxhOMAcKMMChgXMgTIHyoiHEQ8jnjuAeJgDZQ6UOdBvnAMNNIk3U2VLmVbMSaBTkOPSRVO5QUWtCT/y7KYsCLuj/8HXRNsqEPrqVANdyFi51bbIL4MAoYHfyVkT2dwSIBdDsTMr0b6ckbktJO5Pj/R4VN3RhXxXgke38r1HFaNLEEahrbpJEA4yV4+3UQSGwUIbtyuOvG5Y9AUNKYVri0tsxFQ7pzOaRLiRwszhHaPmC7cdof0DHfhLWSexxBz2rdrTMAAkcxAzozOPcvzF0LSStn/hutMaX2tRcRZXF5LmvC6iX4YvJyAt79UlpOYbIvprX1BGTB+vLCEq1Lp8LSu+fem6YJlVf8INrQgfRdkqyeym5NuWsIDuLay69Pc3JrzRa2jU/6xtWqrEdaDlSg66fYkY1OZzpNgIQ16kfrVGXXk7n0bh0yjfW8HsktMorVgfnNUF353+eadE+N19Lttw2YbLNn+Rsg2fW2GCigkqPrfCcIDhAMOBOw8H+NwKwwKGBXxuhc+tMOJhxMOI5w4gHj63wudW+NzKN35uxeMsslI86zGwsUGq1APimUrTCtlirDS1P2rzx3WVkrrid/SZFb0T6dg3+VXlfZ8KFZLcFsGtrd8juCIlKtM01A6YHOXcgHMDzg2YHOUq6FcPu99dFZTJUYYDDAcYDtxhOMDkKMMChgVMjjI5yoiHEQ8jnjuAeJgcZXKUydHbI0evBUCa35ne9tsbv92cKBuoFpnqfI4sn3c9RmUSjZBa7ZCyTldikuhymsKEVKb129I1WqZ1YUKF8QTjCcYTTKhw5YQrJ0yoMKHCcIDhAMMBJlQYFjAsYEKFCRUmVBjxMOJhxMOEChMqTKh8BUJlo+uGMfn3vZoWqJQx4bMEBtPVgOiXtV+UJSwW4n31y5Xdr714tK+82eD3K8+NLvMEY5cKht8eZg1OkyT8Zhu/2XYnUj9+s40rr5yHcB7CeQgTsVxx5YorE7EMBxgOMBxgOMBELMMChgVMxDIRy4iHEQ8jHkY8TMQyEctELL/Zxm+2MZ5gPMF4ggkVrpxw5YQJFSZUGA4wHGA4wIQKwwKGBUyoMKHChAojHkY8jHiYUGFChQmVO/1mW8OejNGXHgzoc7L+ZlswTh3HZaGCsR4MZji3XfG8ee1t4aPQ1V52C750Y8S2stWy8etu/LrbncgHv8nX3a74KhvzrZxucLrB6QbzrVxY/eqB9LsrrDLfynCA4QDDgTsMB5hvZVjAsID5VuZbGfEw4mHEcwcQD/OtzLcy33p7L7B9SQo11CYv41FRP+o6Ziejus2AhuZMgzINeifStK9Lg/pv7g3wVZ+BSeWKOVBOATgF4BSAOVAudv5Vouh3V+xkDpThAMMBhgN3GA4wB8qwgGEBc6DMgTLiYcTDiOcOIB7mQJkDZQ70G+dAA03izVTZUqYVcxLoFOS4dNFUblBRa8KPPLspC8Lu6H/wNdG2CoS+OtVAFzJWbrUt8ssgQGjgd3LWRDa3BMjFUOzMSrQvZ2RuC4n70yM9HlV3dCHfleDRrXzvUcXoEoRRaKtuEoSDzNXjbRSBYbDQxu2KI68bFn1BQ0rh2uISGzHVzumMJhFupDBzeMeo+cJtR2j/QAf+UtZJLDGHfav2NAwAyRzEzOjMoxx/MTStpO1fuO60xtdaVJzF1YWkOa+L6JfhywlIy3t1Can5hoj+2heUEdPHK0uICrUuX8uKb1+6Llhm1Z9wQyvCR1G2SjK7Kfm2JSygewurLv39jQlv9Boa9T9rm5YqcR1ouZKDbl8iBrX5HCk2wpAXqV+tUVfezqdR+DTK91Ywu+Q0SivWB2d1bdi1VdLaqwpXfoHq351FIC1SZSlA1HpDvrnWiJusVyfgrMsyWDGkoaJ+FC9knkO6jw2QfytxASgfgWTvAp+wATELOUfceH1wdFg/KDJwMpFO1nUJA7ZMsebb4dMLTL+36w5BwUeDqcQEClsJ7/laiLyF6OQcXoVYtN7Tb9QGt4Sq34T3wVYZAj7X2aHTTqYdZVi8HARp+lzbvXclZbWx0dYKmaY0hr14kEO8fflI1IuQZ1Klskru6uE6et9QGlrm1jpVM1wTYltBNnrBXY3WlKTjka0E7pn3rOLI56ZA3aIOUBf7STSO5uAGQXvtoFbjAZxB7qz/334yIIOz5C7mFuV5TvdRiAzcQoeeSEKMz9E9Wah7Z6N7Vdf3zuu+P97znd87D71/vFd3byEuDaUtx+fRVFoV75XY3/FJP9JmjhIfn6BjqBq+iheQBbTeNN/K0g/3xSms6LcSTC4z8KmMhdjgLyhguXepTUK5jKUeo7Hvr9nehXMFJVZejC0EYuYyV396O2yKn3QODu8vQPoyCA4fjaP3A23mA/IolSco1H/DirZI5TNN+blyKQQcQHWcvcSKvcN9ymqN9SOfjUJm5TJJviOM8Cs4cd31X5sT/liFP2E7jg7Qu6JN+aZYuNCxony/LjtSd33/uVHUvpip1IFnGWjVtXGhqBRm7uC9u1ekUuW+jJR690Qbj8uC0x01XhYFHbc9rp8PXg0zivpRmNJJP1po67Cj83P0aG9M+vEjXibzJT1LlEXDTrr9a3sVOpwiFpMMuNK0Ku2jC+d2Ciusi3mXEAiniOiPqwux6VdrAWq/2oDbkQe3w+EVJAre6YZS1VD16NU/DsKWC3hfGLCopxvFWR8jnzw5er737F+Pq5D6ZO6e/DCc9MK3ZyFpW5oYsBuNcE05K6jWhxXcQRXw/VjeNWNtyfoMn7ycNvaSmfunb2Hesc4yObC+3ItH3GvxSCanSfHFdPUYi8Iz9R5zFKqFkcFMBpNQNrQx5AnGNIK1u+JZq2yZwxKsC5h1pwYYrad6l8wXhVib7UnAMVP0NNeyhp1QcEl6Yn+L7Qn2eaE0ldPLV21pKikb677ebnxSJHIONxSociyEWYMvx9Xyd/fiGIr2ssqiSJWnXe/9YXVOy1xHyl+fv44+fvx/8K4ikw== +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all breaks associated with the event, with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events-event-id-templates-template-id-breaks.api.mdx b/ads/api/reference/get-channels-channel-id-events-event-id-templates-template-id-breaks.api.mdx new file mode 100644 index 000000000000..11c54331856f --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events-event-id-templates-template-id-breaks.api.mdx @@ -0,0 +1,4109 @@ +--- +id: get-channels-channel-id-events-event-id-templates-template-id-breaks +title: 'Get /channels/{channelId}/events/{eventId}/templates/{templateId}/breaks' +description: 'List breaks created from a template during an event, with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/events/{eventId}/templates/{templateId}/breaks' +hide_title: true +hide_table_of_contents: true +api: eJztXW1zGzeS/iuoqfsg1pES6TiJTZfLpYu9WdXJsVe2s7Un647gTJNENDMYAxjRjOz/ftUNzAvJkfViee1YnQ+OxMEADaBfnu4HEM+jBGxsVOGUzqNxdKisE1MD8tSK2IB0kIiZ0ZmQwkFWpNKBSEqj8rmQuYAzyF1fLJVbiELOVS6xm76YqdQBNuoLmSfCauNUPt+N+lEhjczAgbHR+Ph8Y/DRYCotJNgViLzMpmCE08KAK02+K56rXGVlJkbYkcIX3pVgVlE/ymUG0TjC96J+ZOBdqQwk0XgmUwv9yMYLyGQ0xvFmskxdNB71o0y+x+6i8cPh8OfRw4f3frz/8/3hw4f4yI9EzdyqwL5V7mAOJvr4sb8p9m9eUj0TykFmG5FFAYYm0xdTcEuAXIxoQUbD4afm8Er9edV53Bu2JjIaDq8r+wv6Qabi6NU/DsO+CXhfGLBW6VzszDT+LrMiBTGxTrrSPn589Gz/6b8eJaWh/X48d49/GE56u+KZjBfCgNWliQG70RasUM4KvcyFTFO9HKSoYXoWxpLTFMRMQZpYWhldgJFOG3vR+vjXPr06YdrWoQp+ctaxzjI5sIBqiareCEcSOU26K6arR6IwMFPvhfTPvM5PBhOBC4S9Q56gVWiTgNkVT/0GURc5LME6MVPGOrETrGrftd7qXTRbHP0z53qQQO7UTHkNdQsQ8ULmOaT1mIV0i2bI8PQgWRvXmfJzhyVnccGg9Oz2h6xc1gWjVo+vOfAJNraFzi1YfH5vOMT/xTp3kDv8URZFqmIyjr0/LAp33upPJony+vfSoL47hf2EnS1aH51HiXTB3tsTfb0A7yP1DK0N9YxmiN7nmgM0u701yoWKI9xCWR8kxBRSnc9RzVGCTOWHkM/dou19qnXr0woZnV4u4wXWWqRyNZXxqag6IuNDyUiYvrBlvBDSCnuqCh95clnQG1NYyDOlDcWgtRXAti9mMwtuewkaz24h1jl6hAWIMwVLMCIrrRNL6eKFmMJMG2gkEVOIdQZekAJ9XBO9hmGhvJMe1svk4x0uUyX0tjz/XIBbgGlLoaz3q5CQtwI4FfoMWquyK/65gFxAjmIkfSGrN7Eteay15tihj16+R3xgnTSuUgLfChcXtwO9u1C5mJVp+kjoPIb1rhKdQ7/ZONRWXBfpqJk2CkFD6uUutCWVCBKvCWqFyoM0Ya/dAlZCGhAytfo6Irck7gs5w4C3XKh4caGUIdiGj0WhVe7Ejv/Na05ftPVQVIFRLHEeuXbCguuFaeGvGF4JOV1rI6NaV6ZapyBzdILVR3r6B8SOrKwKMB2OQ2VgncwKL1kj8VLWcK+PBiRzcfDqhXjw03AkEunAqQzX1AQUt2XZ1Yy3h/yv9RVReWVK17EIMEab52AtArytIf5eZjIfGJAJoQkD0ur25CB3YCARz46OXhwJj2F2xUu/B0Ln6covh3+CG0EtOydaBaoreEtq2u0r+0LNhMxXnUOojt7f5OpdCUJtDRK2T7mFyjeD+yXeOJPmFMxTcBDjKF2T+ps2QpZODxJqBUlIDbzibkvjuxRJ1acwEGuTCLeQqPQ6KWNU73pJdsX+lDYB/fhG1nGmJPW5//Kgc5n8WEdlCrcouSlT8NJm6Ngh8VGkxHhOkrcwxWfI7v3eRXKHztbFD0mYdQZkFsS9aDK+e7FcaIvuKk3Rzdc9NdP9nCm03d/2NPznLWuvQjaJslyAARHwUofbJZ+8GcC2/OaGr1VWlJg8Sh+kg7PWJEh3RCH3KlsmVOOK3Ro31GFzq08cUM1zbYKStFx5iGYYJiqpKCfEt68FBDCIEVjKVy9mlDDPtMmki8aIDGGAbpmSaufA4Lr/786T8c6T8du3ydu3yfG9+z89ODke3n9w8iF8Mvrhx58fnhzf+6n6ZHiMT4+HTdPh8EOr2XDYGwzvDe49xPbn9z8O/ABDavLg5MPoeHjvpDfwHw0ennw4Ht07efs2+fDD8XB00vtAD+7/9PDkw2jU2Wzo29xrPxzhk3vHw8GDk16v99oPif1Vn/9w0hsfDwc/4gc7T8btn9++3X37NvnP3pPek50n4//p9f6jQ3vPP7XuJ5v48xU6gjKFpANV7IoXuVjKNI1TjcDUe99PBlCESeLl61etxvSrH3/NJuOydlxCLqVyVHcJYmCXu0FNXGm3jfBQzSBexSlUkU3PKnUfi8nLo2cv948Ofvt1InbqvuE9KhIBMlcWvb6Y/PLm2dOJ2CkMDBKIFRYFUKaV+FXreQri6f5Bv1s2fJsKBROxA6maK0r1KVtO1RmYFTZ4dfDrb/uHNET42BsLOgUwtkfIakLxeCJ2ZlKlkFC2DDnu3nFUTyPqRyhr1I9o0KgfVX1H/Yg6iE46/FgrB7xCTK9rYK2w3sJO5KXr4C72vRMYqJwsVRiYgQGPkSX5BnRqp1B4T7nKY++GNlPXLaHPpFEy33ANOofw0zXyP2ktuA7d2afP/TYkIc1SVoSBd8W+EylILJbk4FMGnz2v5aE3kuhiKPm0cvVhM0j2Vozpexh3mutlfh03WwGuUFKLhuG/Af1zH/95UP1a/RdtOokLEZqXsoXQgt94afSZSrwtEXArrdMZvheQyxxy8FUpBOTizZuDp36COlPO+aW+BOJh4c/IuFrOm+TcrS7qJLpOu2luTdotRZyq+HTgFkaX84V4c3S4nW9Tk9e+xfYe/7LZAVYE0ePUCUuVLgW5bGMyMtkVzzEpnwKGepmqpBKhDpulUdsG1ZVFZZAo+Zo+3ZTxOT4S+AZ51Nwvw1hMcD/1hDyWyuQcJm1HRQ/ROvBJpyvKVAYXjHjw/Fk9YKNUJONGiZaG2cuK+5Peuj3sY3LpsZF3ruhmERSaTOUgymJmdO7wFSoxKCdimfuEmUyfhnwkND5dKgvYYiGpwOnMqi8ySdUEL1lhfEkVtcZiUms6/ZjrnC35Hj/dROGDDIkFbXZ9AVrFk7GQIlEGYlejyMa3Ntro10cbQWte6UK1Ib6vzp1ALemGXZ360z+/Ue3NSTMHDJs3tc0EzhQGk6ofH1YspEB24S1GWfHm6KACotv26Dvp1runYQDcCuoJcmdWYUBbo2ofBwvv0KywcAZGplWwCDlXULpKOspTcvB5lpe9tm0vUnuvErCnThe49IjHsSae6alKEf26s4497DLpM5mWHZN8XdsTrlMd6vxU14yrpVG/7796LZyco1L1LvXEH9vl5eMgyEmX11H5gdekphNpjFx1wNJDHa+FQ6/PlTMCRWYshVU54jR0pV4cglTotbBffBkf4WwVWAHI4JBH1Rdp2e7WfBTWzxuHGST3ZtQxS4YDDAcYDjAc+Hw4cCatIzDQdsftOSEXnZ4BiTUDpGqwVGMgT0KFiRI3dbYWbLBXhgUMC/6asKAWIQ344PvBArQdL1sniC56e4uzv9BWJJ42qjoUBY6ApVwfbwKXeAZ5gstkff0dtTKTxa74W6MDfVKQUBLbT8Rzmcu5dzEWiKXEjiYyeS3nzQQmLS/YbDYjHkY8jHgY8XQjHvJFhHn8j4OMXE1SmRlRa6i8vytYCv/QhmMMvuzesFXer7XbyERUVf5A9de7R40/BYsa/1GkMoaFThM6qLcRnipnGiKrd6PbnrPQYUpesIBV3KpQsUzTlShz2lY8o+ExnM5pYmVOfFuil7nnSh9V5zdop6RoCXcFBxKmvb1FSbV84ShYi92o148Eqped2Jez1vR3xS+lMZC7dOVPIUzmMpuIna3FWCM85jLr3AXf861ER79HA1tArGYqbkfIrSD4O3oZctJ42NUL8YgWws9GigmONgnHJltUgdiJN6Zf6GTS64iJV4QYYa/6wcdtLcg2/Dj5NLZq3Obm9v/uMaxI5UqXbrtMSTiLrBSPGQ1sbPDwrwfEM+VZcDojkjtlan+Enr3Qxq1VKamrburq1hOFbZ7nBlC+UPHplYC82K86oBCGC9mIoujIgFUJMYKyMuIg0aYA4l0pUzVbiZ2sTJ3CQFBZPUHc+tP6hXZ2BMLKjOR3uOG9fjhFkVCYDafD6vNmCcwUBmQ09ATsuD330gZH6g/71tOjkxhemdYCSzinFAyhluDupmMbph7sr1/xlLeSQVyb7uz7VKiQ5LYIbkk8Ol7InMKOd+ZXokRlmn4OXcu5AecGnBtwbsDkKFdBuQrK5CjDAYYDDAcYDjA5yrCAYQGTo0yOMuJhxMOI544iHiZHmRxlcvT2yNHr/SmRihDp8NvrXAkabqBaJF2JV4nHAIVRmUQjpFY7pKzTlZgkupymMCGVmaR2IQv4P5lMarRM68KECuMJxhOMJ5hQ4coJV06YUGFCheEAwwGGA0yoMCxgWMCEChMqTKgw4mHEw4iHCRUmVJhQ+QqEykbXDWPy77uaFqiUMeGzBAbT1YDol9DcWzRhsRDvrbALVP3uay/1XzKkUCvj07nRZZ5g7FLB8NvDrMFpkoRvtvHNtjuR+vHNNq68ch7CeQjnIUzEcsWVK65MxDIcYDjAcIDhABOxDAsYFjARy0QsIx5GPIx4GPEwEctELBOxfLONb7YxnmA8wXiCCRWunHDlhAkVJlQYDjAcYDjAhArDAoYFTKgwocKECiMeRjyMeJhQYUKFCZU7fbOtYU/G6EsPB/R7sn6zLRinjuOyUMFYDwcznNuueNZce1v4KHS1y27Bl26M2Fa2Wja+7sbX3e5EPvhNXne74lU25ls53eB0g9MN5lu5sPrVA+l3V1hlvpXhAMMBhgN3GA4w38qwgGEB863MtzLiYcTDiOcOIB7mW5lvZb719i6wfUkKNdQmL+NRUT/qOmYno7rNgIbmTIMyDXon0rSvS4P6v9wb4Ks+A5PKFXOgnAJwCsApAHOgXOz8q0TR767YyRwowwGGAwwH7jAcYA6UYQHDAuZAmQNlxMOIhxHPHUA8zIEyB8oc6DfOgQaaxJupsqVMK+Yk0CnIcemiqdygotaEH3l2UxaE3dH/4DXRtgqEvjrVQBcyVm61LfKLIEBo4Hdy1kQ2twTIxVDszEq0L2dkbguJ+9MjPR5VT3Qh35Xg0a1871HF6BKEUWirbhKEg8zV620UgWGw0MbtiiOvGxZ9QUNK4driEhsx1c7pjCYRHqQwc/jEqPnCbUdo/0IH/lLWSSwxh32r9jQMAMkcxMzozKMc/2FoWknbv3DdaY2vtag4i6sLSXNeF9Evw5cTkJb36hJS8w0R/WdfUEZMH68sISrUunwtK7596bpgmVV/wg2tCF9F2SrJ7Kbk25awgO4trLr0zzcmvNFraNT/rG1aqsR1oOVKDnp8iRjU5nOk2AhDXqR+tUZdeTufRuHTKN9bweyS0yitWB+c1QV/O/3zTonw3X0u23DZhss2f5GyDZ9bYYKKCSo+t8JwgOEAw4E7Dwf43ArDAoYFfG6Fz60w4mHEw4jnDiAePrfC51b43Mo3fm7F4yyyUjzrMbCxQarUA+KZStMK2WKsNLU/avPHdZWSuuI7+syK3ol07Jv8U+V9nwoVktwWwa2t7yO4IiUq0zTUDpgc5dyAcwPODZgc5SroVw+7310VlMlRhgMMBxgO3GE4wOQowwKGBUyOMjnKiIcRDyOeO4B4mBxlcpTJ0dsjR68FQJrvmd722xvf3ZwoG6gWmep8jiyfdz1GZRKNkFrtkLJOV2KS6HKawoRUpvXd0jVapnVhQoXxBOMJxhNMqHDlhCsnTKgwocJwgOEAwwEmVBgWMCxgQoUJFSZUGPEw4mHEw4QKEypMqHwFQmWj64Yx+fddTQtUypjwWQKD6WpA9MvaN8oSFgvxvvrmyu5rLx7tK282+PeV50aXeYKxSwXDbw+zBqdJEr7Zxjfb7kTqxzfbuPLKeQjnIZyHMBHLFVeuuDIRy3CA4QDDAYYDTMQyLGBYwEQsE7GMeBjxMOJhxMNELBOxTMTyzTa+2cZ4gvEE4wkmVLhywpUTJlSYUGE4wHCA4QATKgwLGBYwocKEChMqjHgY8TDiYUKFCRUmVO70zbaGPRmjLz0c0O/J+s22YJw6jstCBWM9HMxwbrviWXPtbeGj0NUuuwVfujFiW9lq2fi6G193uxP54Dd53e2KV9mYb+V0g9MNTjeYb+XC6lcPpN9dYZX5VoYDDAcYDtxhOMB8K8MChgXMtzLfyoiHEQ8jnjuAeJhvZb6V+dbbu8D2JSnUUJu8jEdF/ajrmJ2M6jYDGpozDco06J1I074uDer/cm+Ar/oMTCpXzIFyCsApAKcAzIFysfOvEkW/u2Inc6AMBxgOMBy4w3CAOVCGBQwLmANlDpQRDyMeRjx3APEwB8ocKHOg3zgHGmgSb6bKljKtmJNApyDHpYumcoOKWhN+5NlNWRB2R/+D10TbKhD66lQDXchYudW2yC+CAKGB38lZE9ncEiAXQ7EzK9G+nJG5LSTuT4/0eFQ90YV8V4JHt/K9RxWjSxBGoa26SRAOMlevt1EEhsFCG7crjrxuWPQFDSmFa4tLbMRUO6czmkR4kMLM4ROj5gu3HaH9Cx34S1knscQc9q3a0zAAJHMQM6Mzj3L8h6FpJW3/wnWnNb7WouIsri4kzXldRL8MX05AWt6rS0jNN0T0n31BGTF9vLKEqFDr8rWs+Pal64JlVv0JN7QifBVlqySzm5JvW8ICurew6tI/35jwRq+hUf+ztmmpEteBlis56PElYlCbz5FiIwx5kfrVGnXl7XwahU+jfG8Fs0tOo7RifXBW14ZdWyWt/apw5Reo/t5ZBNIiVZYCRK035JtrjbjJenUCzrosgxVDGirqR/FC5jmkB9gA+bcSF4DyEUj2L/AJGxCzkHPEjdcHRy/rF0UGTibSybouYcCWKdZ8O3x6gen3dt0hKPhoMJWYQGEr4T1fC5G3EJ2cw6sQi9Z7+o3a4JZQ9ZvwPtgqQ8D3Ojt02sm0owyLHwdBmj7Xdu9dSVltbLS1QqYpjWEvHuQlPr58JOpFyDOpUlkld/VwHb1vKA0tc2udqhmuCbGtIBu94K5Ga0rS8cpWAvfUe1Zx5HNToG5RB6iLgyQaR3Nwg6C9dlCr8QDOIHfW/+8gGTjI0OOBrX86SAZkhZZ8yNyikM/oJZQsA7fQoXsSG4N2tCcLtXc22qvG2zuvB/y450fcOw9Dftyrx9w7bwb9uFePaiEuDaU4x+fRVFoV75c4zPFJP9JmjrM7PkEnUjV8FS8gC8i+ab6V0b88EKewou9VMLnMwKc9FmKD37aApeGlNgnlPZZ6jMa+v0YVFs4VlIR5MbbQipnLXP3pbbYplNKZOXy+AOlLJjh8NI7eD7SZD8j7VF6jUP8NK9pOlc805fLKpRAwA9V89hMr9l8eUAZsrB/5bBSyMJdJ8jNhhF/BiVvalrWp4vdd+EO64+gQHbRvJoJr9D5aiqojkZTG10sEjdf3Nc1G6/tiplIHnrKgbdHGhQpVWBoH791ekUqV+5pU6n0daQauG67HqHHZKPK47b79hPHTMGXsupozftzMOupHYdon/WihrcMhzs/Rcb4x6ceP+DF5CVLRRFn0H0m3G2+vVIfvxZqVAVeaVkF/dOGsT2GF5TfveQKvFRHLcnUhNt13LUDtvhsMPfIYeji8gkTBCd5QqhoRH736x2FQBgHvCwMWVXyjBuxD8ePHR8/2n/7rURW5H8/d4x+Gk174I13IDZcmBuxGIypUzgoqKWKheFDhCj+WjwBYwrK+kEDOVBt7ycz927cw71hnmRxYX1XGk/S1eCST02QSYrp6hLXnmXqPqRCV3MiUJoNJqE7aGPIEjY3Q86542qqO5rAE6wI03qlxTOut3iXzRSHWZnsS4NIUndS1rGEn1HWSnjjYIpWC5V4oTeUv81VbmkrKxu6vtxufFIncxg0FqlzOLYpTuasbStTydoTXQ2zCLfQN9uMYivZey6JIlaec9/6wOqe9rwHBr89eRx8//j9TialR +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List breaks created from a template during an event, with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events-event-id-templates.api.mdx b/ads/api/reference/get-channels-channel-id-events-event-id-templates.api.mdx new file mode 100644 index 000000000000..ae30e5ef526f --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events-event-id-templates.api.mdx @@ -0,0 +1,4066 @@ +--- +id: get-channels-channel-id-events-event-id-templates +title: 'Get /channels/{channelId}/events/{eventId}/templates' +description: 'List all templates associated with the event, with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/events/{eventId}/templates' +hide_title: true +hide_table_of_contents: true +api: eJztXVtzG7mx/iuoeZKqSF02e05iuvygip09qiPHji+bSrlcITjTJLGaAcYAhjRX5f+e6gbmQs7IuliOvWbvg1fiYIAG0Jev+wPEqyQDl1pVemV0MkkulPNC5rnwUJS59OCEdM6kSnrIxFr5pfBLELAC7Ufh91IulJb4/kjMVe7BKr0YCakz4Yz1Si+OklFSSisL8GBdMnl3tTPq6XgmHWTYFQhdFTOwwhthwVdWH4nnSquiKsQpdqTwhQ8V2E0ySrQsIJkk+F4ySix8qJSFLJnMZe5glLh0CYVMJjjeXFa5Tyano6SQH7G7ZPLo5OTPp48e/fQ/P//555NHj/BRGIma+U2JfSvtYQE2+fRptCv234OkZi6Uh8K1IosSLE1mJGbg1wBanNKCnJ6cfG4Or9Xvt53HTyediZyenNxV9hf0g8zFq9f/uIj7JuBjacE5ZbQ4mBv8XRZlDmLqvPSVe/Lk1bOzp/96nFWW9vvJwj/508n08Eg8k+lSWHCmsilgN8aBE8o7YdYa9cmsxzmqlpnHseQsBzFXkGeOVsaUYKU31l23PuG1z69OnLbzqIKfnXVqikKOHaBaoma3wpFE3pDuitnmsSgtzNVHIcOzoPPT8VTgAmHvoDOlF8LYDOyReBo2iLrQsAbnxVxZ58VBagGHOvOdtw6vmy2O/oVzPc9AezVXQUPRatOl1BryZsxS+mU7ZHx6nm2N6231pcOSs7hmUHp2xyHfY2NXGu3A4fOfTk7wf6nRHrTHH2VZ5iolHT3+zaFYV53+ZJapoAYvLaqdV9hPXOCy89FVkkkfza47xTdLCK7KzFHpcbtpeugE7jhAs+iuP0y7km5nB53wS+UaHy2UE7nSl5AJb7Yk2Vm6xjFIa+UGf8dFsya/Wexr7KjM5WYm00tRd0RmgaLOLMjLkXBVuhTSCXepyhATtCzpjRks5UoZS9Fha1Gw7Yv53IHvL0rrcx2kRqOtLkGsFKzBiqJyXqylT5diBnNjoZVEzCA1BQRBSvQ+bVwhn9y4z5NmlUIkwmWqhe7L888l+CXYrhTKBY9H2yEcwKUwK+isypH45xK0AI1iZCMh6zexLfmSrebYYYgroUd84Ly0vtaK0AoXF7cD/a5QWsyrPH8sjE5hu6vMaBi1G4cKjOsiPTUzVmE4z4PcpXGkElHiLUGdUDpKE/faL2EjpAUhc2fuInJH4pGQcwxF66VKl9dKGcNg/FiURmkvDsJvQXNGoquHog5ZYo3z0MYLB/4wTgt/xcBHmOZOG5k0ujIzJgep0SPWH5nZb5B6srLa9Q/4ElWA87Iog2TYdWPWa+lEfHWENiS1OH/9Qvzlf09ORSY9eFXgstoIsXrGXk+6P2qMUruLo3RjVWjG9LQRQcytKbYdz11MKHr62/k5avxwXk5l/VHfavWh6iy2aqSIU7kAvfDLLpxqBwjRa7fL/6sKqccWZEboJlOOlBsbN26xWbqhDesqcL/78Hl3k6LTzdFnrJdgQcQgOGA4ZFW7Lqin+bsK4USFwFwGNxvNzZAgwz6BDETGfggr1ZHhqPH8jePr9YkDqoU2FsfUWdcYoz9CQ6+lIryNb99FD1fSKhlhgt68mFM6YjTEn+4Qu6Vz4Af0+Yw+py1Aq6GNV07EgY/EmRc5SMSbGoJvD8hnS6fvJdFnDL7e0WhgJHtHlUbB/Vxqs9Z3Wc3asmJWkpzE/8b0z8/4z1/qX+v/kl00EU1R9ZBjkBK1SOmu7r60ZqUyyMRsE2BR5bwp8D0rZOXNeAEaArBHtynevj1/GiZoCuV9WOobTBxzJyvTejnvA446XTRop3EENLcWH0mR5iq9HPulNdViKd6+uugDI2ryJrTo7/FfdzvApAoDcBNZ6rgW5XJtQi+zI/Ec0dMM0KJlrrJahLmxhcS9razqO62hcFdApuQb+nRXxuf4SOAbuMdSh2WYiCnup5niBk5VIRcwxaFBo969S+ghWgc+Sd4P7FahCrhmxPPnz5oBW6UiGXeyXBrmuCh/nh5u28MZooDgAsmqqTqRYTWjUBpEVc6t0R5fISyovEilDsiGTJ+GfCwMPl0rB9hiKSlH9HYzEoUk2BckK23ISlFrHKIPOxgr/OBsyfeE6WYKHxRYmzH2KOTwKp1OhBSZspD6JlhYmIMFBIqtNob1MVbQmte6UG9I6GtwJ1BLtnzr5/VndHWvvMlLuwCsLd3XNjNYKUTGdT/CLyWCwhzILoLFKCfevjqv403fHkMnw3r3NA6AW0E9gfZ2Ewd0TfAMgbIMDs0JByuwMq+DhRt1la6WjnC6BlFgphNkb2w7iNTdqwzcpTclLj2GXSwrFGamcqw0+dXAHg6Z9Erm1cAk3zT2hOvUhLow1S3j6mjUr2ev3wgvF6hUhzd64k/d0sC7KMj7Ia+j9HnQpNNdBPh+Vw0uTLoVDoM+184IFJmxFE7pRU7KH2E2ZRXotbBffBkf4WwVOAFYBCOPaq7TsqPefBTWPlqHGSUPZjQwS4YDDAcYDjAc+HI4sJLOExjouuPunLCcn6+AxJoD1tQwI7Ogs5hIUl1ArbaCDfbKsIBhwR8TFjQi5BEf/DhYgLbjZYeEve7tgXLaNbYikbCtOxQljoAVmxBvYtF3BTrDZcKIFjoUhSyPxN9aHRiRgvxiDC7vWSaeSy0XwcU4oHIydjSV2Ru5aCcw7XjBdrMZ8TDiYcTDiGcY8ZAvIswTfhwX5Gqy2syogo7K+6uCtQgPXeSbcrUCu2mL0sGvddvITGSQKjw9EQmZZveo8edgUes/ylymsDR5RmcddsJT7UxjZA1utO85SxOnFASLWMVvSpXKPN+IStO2IpkWMJzRNLFKU1k9M2vtvAVZPK6JNtopKTrC3cKBxGn3tyirly/S+IrOgtBximb9SKBm2dFU2lhC5MNfK2tB+3wjjM43YrqQxVQc9BbjsLsRC1kM7kLo+UGiY9ijsSshVXOVdiNkLwj+il6GnDSeFwpCPKaFCLORYoqjTePJkw5VIA7SnemXJpseDsTEW0KMuFej6ON6C9KHH+8/j61at7m7/b8GDCtyuTGV75cpCWeRlSIfPHapxfNTARDPVSC7iCPUXtnGH6FnL431W1VK6mpwxx8+UejzPPeA8qVKL28F5MVZ3QGFMFzIVhRFzKBTGRCPVhtxlGhXAPGhkrmab8RBUeVeYSCorZ4gbvNp80I3OwLhkN5EThM3/HAUTxFkFGYjjd8cDMhgrjAgo6Fn4CbduVcuOtJwXqqZ3tI48g6F9FuBxegIfcgQGgn2Nx3bMfVof6Oap3yQDOLOdOcopEKlJLdFcEvi6btSago7wZnfihKVef4ldC3nBpwbcG7AuQGTo1wF5Sook6MMBxgOMBxgOMDkKMMChgVMjjI5yoiHEQ8jnj1FPEyOMjnK5OjDkaN3uwZeEyIDfnubK6lvFaJh5kYvkOULrseqQqIRUqsDUtbZRkwzU81ymJLKTHO3lCX8W2bTBi3TujChwniC8QTjCSZUuHLClRMmVJhQYTjAcIDhABMqDAsYFjChwoQKEyqMeBjxMOJhQoUJFSZUvgGhstN1y5j8966mRSplQvgsg/FsMyb6JTYPFk1YLMZ7J9wSVX/42ktA+yqYDf5hxIU1lc4wdqlo+N1htuA0ScI32/hm216kfnyzjSuvnIdwHsJ5CBOxXHHliisTsQwHGA4wHGA4wEQswwKGBUzEMhHLiIcRDyMeRjxMxDIRy0Qs32zjm22MJxhPMJ5gQoUrJ1w5YUKFCRWGAwwHGA4wocKwgGEBEypMqDChwoiHEQ8jHiZUmFBhQmWvb7a17MkEfenFmH7Ptm+2ReM0aVqVKhrrxXiOczsSz9prb8sQhW532S360p0Ru8rWyMbX3fi6217kg9/ldbdbXmVjvpXTDU43ON1gvpULq988kP5whVXmWxkOMBxgOLDHcID5VoYFDAuYb2W+lREPIx5GPHuAeJhvZb6V+daHu8D2NSnUWJu8iUdF/WjqmIOMap8Bjc2ZBmUadC/StG9Lg4a/3Bvhq1mBzeWGOVBOATgF4BSAOVAudv5RougPV+xkDpThAMMBhgN7DAeYA2VYwLCAOVDmQBnxMOJhxLMHiIc5UOZAmQP9zjnQSJMEM1WuknnNnEQ6BTkuU7aVG1TUhvAjz26rkrA7+h+8JtpVgdjXoBqYUqbKb/oiv4gCxAZhJ+dtZPNrAC1OxMG8QvvyVmpXStyfQ9Lj0/qJKeWHCgK6lR8Dqji9AWGUxqn7BOEoc/16F0VgGCyN9UfiVdANh76gJaVwbXGJrZgZ701Bk4gPcph7fGLVYun7ETq8MIC/lPMSS8xx3+o9jQNAtgAxt6YIKCd8GJvW0o6uXXda4zstKs7i9kLSnLdFDMvw9QSk5b29hNR8R8Tw2VeUEdPHW0uICrUtX8eKH166IVjm1O9wTyvCV1G2WjK3K3nfEpYwvIV1l+H5zoR3eo2NRl+0TWuV+QG0XMtBj28Qg9p8iRQ7YSiINKrXaChv59MofBrlRyuY3XAapRPro7O65m+nf9kpEb67z2UbLttw2eYPUrbhcytMUDFBxedWGA4wHGA4sPdwgM+tMCxgWMDnVvjcCiMeRjyMePYA8fC5FT63wudWvvNzKwFnkZXiWY+xSy1SpQEQz1We18gWY6Vt/FGXP26qlNQV39FnVnQv0rHv8k+Vj0IqVEpyWwS3et9HcEtKVOZ5rB0wOcq5AecGnBswOcpV0G8edn+4KiiTowwHGA4wHNhjOMDkKMMChgVMjjI5yoiHEQ8jnj1APEyOMjnK5OjDkaN3AiDt90z3/fbOdzdnykWqReZGL5DlC67HqkKiEVKrA1LW2UZMM1PNcpiSynS+W7pBy7QuTKgwnmA8wXiCCRWunHDlhAkVJlQYDjAcYDjAhArDAoYFTKgwocKECiMeRjyMeJhQYUKFCZVvQKjsdN0yJv+9q2mRSpkQPstgPNuMiX7Z+kZZwmIx3tffXDl87SWgfRXMBv++8sKaSmcYu1Q0/O4wW3CaJOGbbXyzbS9SP77ZxpVXzkM4D+E8hIlYrrhyxZWJWIYDDAcYDjAcYCKWYQHDAiZimYhlxMOIhxEPIx4mYpmIZSKWb7bxzTbGE4wnGE8wocKVE66cMKHChArDAYYDDAeYUGFYwLCACRUmVJhQYcTDiIcRDxMqTKgwobLXN9ta9mSCvvRiTL9n2zfbonGaNK1KFY31YjzHuR2JZ+21t2WIQre77BZ96c6IXWVrZOPrbnzdbS/ywe/yutstr7Ix38rpBqcbnG4w38qF1W8eSH+4wirzrQwHGA4wHNhjOMB8K8MChgXMtzLfyoiHEQ8jnj1APMy3Mt/KfOvDXWD7mhRqrE3exKOifjR1zEFGtc+AxuZMgzINuhdp2relQcNf7o3w1azA5nLDHCinAJwCcArAHCgXO/8oUfSHK3YyB8pwgOEAw4E9hgPMgTIsYFjAHChzoIx4GPEw4tkDxMMcKHOgzIF+5xxopEmCmSpXybxmTiKdghyXKdvKDSpqQ/iRZ7dVSdgd/Q9eE+2qQOxrUA1MKVPlN32RX0QBYoOwk/M2svk1gBYn4mBeoX15K7UrJe7PIenxaf3ElPJDBQHdyo8BVZzegDBK49R9gnCUuX69iyIwDJbG+iPxKuiGQ1/QklK4trjEVsyM96agScQHOcw9PrFqsfT9CB1eGMBfynmJJea4b/WexgEgW4CYW1MElBM+jE1raUfXrjut8Z0WFWdxeyFpztsihmX4egLS8t5eQmq+I2L47CvKiOnjrSVEhdqWr2PFDy/dECxz6ne4pxXhqyhbLZnblbxvCUsY3sK6y/B8Z8I7vcZGoy/aprXK/ABaruWgxzeIQW2+RIqdMBREGtVrNJS382kUPo3yoxXMbjiN0on10VndGXb1SlpndeEqLFDzvbMIpEWuHAWIRm/INzcacZ/16hfmqOtkFKAn5RuQnV1j8zsQspQLxIV3Bz8vmxdFAV5m0sum7mDBVTnWdAd8donpdb+uEBX4dDyTmCBhKxE8WwdxdxCbXMDrGGu2e/o7tcElp+o24XlwdQaA7w126I2X+UCZFT+OgrR9bu3Oh4qy1tQa54TMcxrDXT/IS3x880jUi5ArqXJZJ2/NcAO97ygFLXNnneoZbgnRV5CdXnBXky0lGXill6A9DZ5TvAq5J1C3qAPUxXmWTJIF+HG6lFpD7uofzrMxrEB7F/53no09FOjRwJFHWDgU6Rk1QTkK8EsTOyMhMQQnx7JUx6vT47r346um+0/Hof/jqzjAp+PuCA7SylJy8u4qmUmn0rMKu3z3fpQYu0C5371H868bvk6XUERM3jbv5eIvz8UlbOgbEayWBYSExUFq8XsSsKi7NjajjMVRj8kk9Ndu8tL7ktKnIEYPZ9iF1Or3YI1tiZNOu+HzJchQ7MDhk0nycWzsYkzeovYHpfp/2NBGKT03lIUrn0OM9lStOcucOHt5TrmrdWHk1WnMn3whyYPEEX4BL+6xBVvTwm+lCEdpJ8kFulE0rqY1FilMqii3b0qM1Oko/N4q7UjMVe4hMAq09sb6WECK8/fw0R+XuVQ6lIzy4Kpo+3FxcNKn6FzjlJJRMmkmhREsaOUomcR5YdfNxN6PkqVxHvu6ukIH99bmnz7hx2TNpHCZcmjn2bC77a7FgI/E2pEFX9lOYf302uldwgbLYMFDRH4pIbbj9kLsutlGgMbNtlj2NGDZk5NbSBSd1T2lapDpq9f/uIi7LuBjacGhwu7UYvFISuWePHn17Ozpvx7XxMaThX/yp5PpYfxjWcjRVjYF7MYgOlPeCSrtYcF2XMf3MFbw1FhKciGhJ6dnrLth5uHtB5h3aopCjl2o7uKJ9kY8kskb0n0x2zzGGvBcfcSUhEpfZDPT8TRWCV0KOsMQRyj2SDztVCk1rMH5CFEPGrzReevwhvmiEFuzfT8KMGaGLudO1nAQ6yvZoTjvkTvRRK+VpvZ+etOVppayNfC77cZnRSL/cE+Bat9CEDU6dVyt8PQsTaHsLqssy1wFlvX4N2c0LXMTNX959ib59Ok/k10MIQ== +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all templates associated with the event, with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events-event-id.api.mdx b/ads/api/reference/get-channels-channel-id-events-event-id.api.mdx new file mode 100644 index 000000000000..b2a34f66d4cb --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events-event-id.api.mdx @@ -0,0 +1,66 @@ +--- +id: get-channels-channel-id-events-event-id +title: 'Get /channels/{channelId}/events/{eventId}' +description: 'Get /channels/{channelId}/events/{eventId}' +sidebar_label: 'Get /channels/{channelId}/events/{eventId}' +hide_title: true +hide_table_of_contents: true +api: eJytVUtv2zAM/isCTy2gLO0Ow5BbgO4R7NCie1yCHBiLibXasirRyTLD/32g7SSOs61rsVMckfo+Pj5SFXgMmBNTiDCZV2AoJsF6toWDCcwMObYrS0EVK8UpqSRF5yh7BRqseHjkFDQ4zAkm0FlnBjQEeixtIAMTDiVpiElKOcKkAt55cY4crFtDXeunaWlDjv9A2tieSbkQ5+gLFymK/fXVlfwkhWNyLJ/ofWYTlIjG36OEVfXw0BgrJszuQuEpsBWcFWaRNPjeUQVJIGQy0wb1NM8vNqfImHu1TckdE1VbjKq7pxVGhU7NPt+qt2+urpVBJrY5qTYZKcogO31KM2R9H4hGTD9Y9c7PCn2GSc7cINM53rsmZHJGSVgviteac9ivzj6W+4LYoyK2llPrhmI8g2zFMQT9WOboRoHQ4DIjZWz0Ge6UOKtVEZ4oQWQM/LciNA4vLUPdF/BcatJl0Sc+9kH3lLU4gBXL75Qw1PVQBXBDKywzVved7htCEWqj8ZmBCayJR11N4+gwy6OmIHF0nDPGtWyLNuko7KdUH4jVeA80rg5I9biFGlcdVg0acuK06NhBt7M9gTF6O95c/zNKpKQMlnfNEltitMm0FKD5QkMR1pLefCFjv3f8LLPcTmjPfdjW6d1MPdBOXZSRgjTjUqEzKlISiNWFxxi3RTCX0s5mO0gPGrxjf1NmL+rpwhhS3IY1Ovuz6UJP54dllxIaCsd192NUhPWoUUdHgN5+ol3TT+tWRbPvLGdiuvVsv1naqqmJano3Aw0bCrFl3lxLWL6InGOzJzqGZ7VvsGq6kGS9jH2G1glFGTKxta2dS7wSx7VIuGMBDZP+49ESyeledQsNaRFZ7lfVEiN9DVldy/FjSWHXdnqDwcpgt0+ZjfJtDnt5EOph2cPFfTd3l+qvL95vk9s3we0kKcxK+QcaHmh38iI2z9z/CWm4oZ4T0L6e9aLWe21JtVrrNEnIc+/e2TMoM3QY2Q/vvkBd/wLeBdaH +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get /channels/\{channelId\}/events/\{eventId\} + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-events.api.mdx b/ads/api/reference/get-channels-channel-id-events.api.mdx new file mode 100644 index 000000000000..2ecf82adb84b --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-events.api.mdx @@ -0,0 +1,118 @@ +--- +id: get-channels-channel-id-events +title: 'Get /channels/{channelId}/events' +description: 'List all events for a channel with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/events' +hide_title: true +hide_table_of_contents: true +api: eJzNV99v2zYQ/lcOfEoAOba7bl1c5MFYsy5Yu2ZJO2AIAuQsnS22EqmSpziu4f99OFK2Fdt1mnQPfYpDkd993/F+ca4y8qnTFWtr1EC90Z4BiwLolgx7GFsHCGmOxlABU805VDjRBmV/AmNdMDltJgmgycBbx9pMjlSiKnRYEpPzanA137DS74zQUyZQBKYuR+SALTji2pkjeKuNLusS+gKk5cDnmtxMJcpgSWqg5JxKlKPPtXaUqcEYC0+J8mlOJaqB2BtjXbAa9BNV4p3AqcFxr/eif3z87OfnL573jo/lU7QUtvGsEmxtmCbk1GKRbNL+KzK1Y9BMpV9ThopcEJPAiHhKZKAfHNLv9fZpuNRfvlXHs15LSL/Xeyz3d+EHFnBx+feb5t6A7ipH3mtr4EBumu6wrAqCG8/ItT85uTgdvvr3ZVa7cN8nEz75qXdzeASnmObgyNvapSQw1pMHzR7s1Ej82GmnkFCy48YWjgqCsaYi88EztiKHbJ3/mn/isf3eaWR7lhDcqzq1ZYkdTxKWTBmsyQVGbEPswmj2EipHY30HGL/FmL/p3IRUEHQymTYTsC4jdwSv4gUFCENT8gxj7TzDQepITA25derwa2rF+ndqPcvIsB7rGKGc0zJtVzYr5Hxtsvl6lt2zy67ea/ZaNvvKGk9evj/r9eRPag2TYfmJVVXoNARM96MXavMWHmaZjndy7iQGWAtOo7ZqLc1VhtzkQFvm+5xi3bBjiUDxfRAoGflIA6sb2mFFl+QZywqmOZngzVARYYoemnMJoMQynF2+g19/6fUhQybWJUH0ltDacF9y38ym1d8dUYfpLoZMs768zWB/JyaZ7BUybeOdBspkMhBaT+Krs23YD0Z/rpcO0euwk1TRZjP0tiBj/G2C/lGXaDqOMAulItO+KnAGsjmk3n4XeEbH+5wQNjzVDYt2hlyJTxoVbcPre0hakXW9ArOjj5SykG0W0Dmcyf/rjvpgAN+Xdr46CCUxSsKsfBVzAzwFh90P/NA/txz1W+2cuGpHd275JC40tGMH20LabJTiPPJSd5eNcicgW8ZiRy7K8nJMWGGWyGkuhVjEhmoKmDrrfRhfxIb/upFz+fywpYACeIu6iP2r8W0wtwN9I06aMaXV6aPCeyS2A2QDJZTBe0Gy48hmZVFNX4KLplgH2Nh0tTVnmRqoCXGnyVPfWXWDTpz8hCROZHiLCRSIlsS5bY4GSpyrgepipbu3/e4SqztfgS26KzRPae00z8I4OEKv02Etx6+uE2XdRBhdXUt7WW68lJ4Rb6m1ffPKhudn8IlmcFB7cpKTh3ESpdQRw0GF3k+ty0LjDV1I3Bbw1teXM1cSGg2NrSHCTdDoLzHP1uVu1VZzwixMKk1jvetYN+mEIrHM9Er/SbNwBdqMbeirmgtqJpR/NE1hmHkYnp+pRN2S89HybT/kmfVcYqgNjYXXxPCAuzf6zKo//38TfqNN2lW3KlAb4Vq7IhaYcLUiXAT1pSQ2dFWiBu3Rg1bRlVvPcmg+l/rzwRWLhSzHSSk8IrSXNMx2V8O2yMc8MHbq+ESz9TvjFotatqgwdH0ziSc/Fx5g1NSSJ7L6oR8Ce5Sv3gPfq/tHegrs0du8CNZqr+Ufp0XuI7Ph4KJpJ4ew95Gwk82yhJlZm82S5TqTF9eLZFkKhV78PkxTqto6tl4Hi3ZfeX36Xi0W/wEBCbiD +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all events for a channel with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-integrations-channel-integration-id.api.mdx b/ads/api/reference/get-channels-channel-id-integrations-channel-integration-id.api.mdx new file mode 100644 index 000000000000..edb6c0a278ff --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-integrations-channel-integration-id.api.mdx @@ -0,0 +1,69 @@ +--- +id: get-channels-channel-id-integrations-channel-integration-id +title: 'Get /channels/{channelId}/integrations/{channelIntegrationId}' +description: 'Get a channel integration by ID.' +sidebar_label: 'Get /channels/{channelId}/integrations/{channelIntegrationId}' +hide_title: true +hide_table_of_contents: true +api: eJytVU1v20YQ/SuLOdkAFdk5FAVvRFwYQg424qQXQWhG5EjchNyld4ZSWIH/vRjqayXLrYvkRHJ3+N6b7w0UxHmwjVjvIIV7EoMmL9E5qox1QsuAemfmnZncvYMEGgxYk1BgSKebs/8nBTmxC0vB+IWRkvZY+qdViwalhAQc1gQp7G4nBSQQ6Lm1gQpIJbSUAOcl1QjpBqRr1JglWLeEvk/eTBu78B8Sjob/U81Mjbnxjon1/v3NjT5y74Sc6Cs2TWXzAXv8jVXxJsLDorB6hdVj8A0FsYqzwIopgSY62kThSt8eAiktn6aSKu+WbMRrSM7cSSAPhEJFJi9JPtuaWLBuzLok91qgzRrZ7FASg2zQmcnTg/n9t5tbU6CQ2JrMlvCiggJtxkzykTp+KeLe+2VF5i6bGFQr8506NgsfBj1MYUVhxLYgc/X0lE2ujeZ7SL5QzRcyeFCAIWCn3/ZCgL84+9xe9tceY7+2Ulp3XvmvEJ5TfLiArZbvzIc2BHJSdca7qjNf1bG/7rLJV3MVhSP2HQtjHWvpeHetGsi1NaRT2P8Ksxe6+rjspxqF5KRDB/O4QI4Qfv6NcoFeMU6duqMFtpWYT7seGWi0qPe9lsKSZLTj4dGBcBSF4Xh81qaCS51DEJ2zyqpJSr/DHoaWlJDCGBs7Xt2O92TjzYGtH8d0x4uYr4cEmPI2WOmG4TdHtnnWKvZ0loAPS/VnOtOZsDd80kbftm9kfp767HGidWyuWqagk+naoCsMUx5IzFWDzGsfiiGTw+jQoA94x/IqRRotrp2Mc4qHsERn/z4v2cNYLAkLCsfB+GPkw3JkiyMBNvYjdUMCrVv4oZWsVHr10Ij909LaZAWb7HECCawo8JZ5dauyGs9S4zD8dgy6bX4mFyf+RRP3LWts55LQDxk3FVqnEttQKdC2Wqbqr/pxe2wDhgTSuCViofHdSZnOEig9i0JuNnNk+hKqvtfj55ZCty2eFQaLcw2mblXL+l4c9sCrrl592nXstfnX5XvR331eXad+YtXqFyTwnbqT5Txs3F8q6Xwx/4S8k1D3sz7ZV7IGcmua5Tk1EoG82Mh9PDPu//gMff8P0hMosw== +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get a channel integration by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-integrations.api.mdx b/ads/api/reference/get-channels-channel-id-integrations.api.mdx new file mode 100644 index 000000000000..0d20f4a5f9c5 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-integrations.api.mdx @@ -0,0 +1,121 @@ +--- +id: get-channels-channel-id-integrations +title: 'Get /channels/{channelId}/integrations' +description: 'List all channel integrations for a channel with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/integrations' +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHfnIAOba7bl1c5IPRFIXRbs2SdsAQGAstnSW2EqmSpziu4f8+HCVbsqy4SYsB/RRHJO+e5/jcC9ciQhdalZMyWozFO+UIZJpCmEitMQWlCWMrednBwliQu6WlogRyGSvtlwNYqJTQKh0HIHUEzlhSOj4VgcillRkSWifGN+uWz1F/Lh1GbApBF9kcLZABi1RYfQp/KK2yIoMRG1J84EuBdiUCoWWGYiz4nAiExS+FshiJ8UKmDgPhwgQzKcbsbyGLlMR4FIhM3rM5MT4bDl+Mzs6e/fr8xfPh2RkvlZ78NlrlbNvTRys2m6AN+88SqVmAIsxcDRlytJ5MAHOkJaKGkQ/IaDg8xuFafX0sj2fDBpHRcPhU7O/9D5nC1fVf76p7A7zPLTqnjIYe3zTeyyxPEW4dSSrc+fnV68nFPy+jopTDeUznvwxvT07htQwTsOhMYUNkM8ahA0UOzFKzmsyyn7KwzKLyJecpwkJhGjkfGZOjlWSseyg+5bHj0aloO2IJHmUdmiyTfYcsS8IIanAeERmvXZivXkJucaHuQZZrpeZv+7c+Fdg66kjpGIyN0J7CRXlB3oTGJTqChbKOoBdaZFcTapw6eYgte/9BrtMINamFKhVKCW7Tduczl5TULqvVabTnl2xx1O2MN7vcaIeO158Nh/wnNJpQE/+UeZ6q0Atm8MkxtHXDnowiVd7JpWUNkGI7Fdu88WktIklVDjRpfkiwrBtmwQrk2HuCnJFPdFBH4MDLg8EESpRr1kiYY2p0zAJgHK14BWIngw4qKkNHMsthmaDe89J0sJQOKisBSE4fmF6/h99/G44gkoSkMoTSYSeCSKqJc0hvceUOQbwxJk4RLiZTkLwLPuOqrPuMx6G9Q9t3KkLoXV9PpifAKtqL+IHD6oO0Vq74f9UR4I9afSm6+ao69px8SrfF/IDDtotXHbZ55ym8KqxFTekKjE5XcMvE/r2YTG+h1whHk7uMQGnH0jHaJzFqLr03YntUzA5wbZp5dcNRCPaSzm9vCqQ2YeafMKSuWNbd95ti34/G5e4gZEiSk2t3y2UegUPyrXsvSXyvPYxtGUHo6OSNGyo/VLDLbndgqd1UOWTouEZvm2qnQTIk046U4s/bkWJnM5MUJly0mayvvCBDa5zzgw/7cA87ueTlb3vyVkDeSZWWva6KrXfXYb2ljmqkaUwFJcM9EIcCaVnxJXNPJB1HNm1pVD0MrqrC7s2WDVoZzeVRxEj9SruuvxNxvzkrMlQZ87gnps3Ps0BkSImpzHh4lIixGMhcDe5Gg63dwXpneDNoWXYYFlbRyg+Tc+lUOCnYyM0sEMbGjPFmxs1pu/GaO055b43t7UucXE653kGvcGi5L56UcyyGFgl6uXRuaWzkM973MA6kt1dfaEKUs1gqGAcjiI2lVl/bpW3XlBOUkZ9zqrZ83zc27quodiBz9RZX/lKUXhhfchWlWM03fytcwiRyMLmcikDcoXWl57uRzzzjKJO+WlQe3iDBo4K+R6TR4/+vN0PFl/CeBnkqlWb8hU3LMuSvm4PBJEd1LWWk42ZdVS31JcYRH12vuVZ9tOlmw5/LCcw/TpTjlI26K2eT+FMeLp1sPuOqfr/cybTgLcIPc48G8d3PkG8gqurOd6L6qR8YR5jv3hk/yvtnemIc4Vu9NGq2M/7HKqb7xGzoXVWt5wSOPj460WyLm1410WxR1vm8mW2CbZFkeOX6JAwxb/I4eHVsmn3nzesPYrP5Dwzk4Q8= +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all channel integrations for a channel with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-marker-rules-marker-rule-id.api.mdx b/ads/api/reference/get-channels-channel-id-marker-rules-marker-rule-id.api.mdx new file mode 100644 index 000000000000..3a35a244fc9c --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-marker-rules-marker-rule-id.api.mdx @@ -0,0 +1,80 @@ +--- +id: get-channels-channel-id-marker-rules-marker-rule-id +title: 'Get /channels/{channelId}/markerRules/{markerRuleId}' +description: 'Get a marker rule by ID.' +sidebar_label: 'Get /channels/{channelId}/markerRules/{markerRuleId}' +hide_title: true +hide_table_of_contents: true +api: eJytVt9P40YQ/ldG+wSSc4E+VFXeIkAQHS2IwPWkKFIm9iTew941u2M4N/L/Xs3aIY4Truq1TwTv7HzffPNrNyohHztdsLZGjdQ1MSDk6J7JgSszgmUFk8tPKlIFOsyJyXk1mm169yYJGdYrTQ7sCjgliFM0hjK5qcWiQE5VpAzmpEaqPZ0kKlKOXkrtKFEjdiVFyscp5ahGG8VVIcaenTZrVdfRP8N2qH8A3Vg8lBn9S/S5GPvCGk9ezn85O5M/sTVMhuUnFkWmYxRyw29eGG46/jBJtBxhdu9sQY61+Flh5ilSRefTRqH3xPcdwT+6fcAy6il0VzSXILiEXRIhJ7emBLRhG5RjyosMmRpLD28pGUBYOsJn0B4kkKTMKIGVszlwqn2QOQL0gNAQgBwL0b1lZZffKGZhFVvT8P8vwXymavCKWUmwcwcICTHFTMk2+XnpGTyy9qsKVtbtuAJbyJHj9DhHR8iUjEMu95EfdU6eMS8aWXqVBm/oob3dyGFgMr2D3349O4cEmVjn1CrUQd6FSQaXmdRgH/fPlDilbgTaA4kGggVJGURvctTIoK3pQCytzQiNYOgj7p+Mfin3Q9G7lnrTnGrT7+YD8p4dYf4YPvcBpuEM5E5vroReIQ9sP8FF6RwZziqwJqtgcXM7XQgUmTJXo5m6uZ2q+RHkbclOjoR2OBp2BR6gk20qt8qGwiB/NEY+Gt3N7XQbU4hwW10jWFw8XS3gZHH19XHwdRD+YVz7U7AOFpfjx6uH8R/XHYvOp2DXjf7i6UpF6t3iiBJ1d4zNJNN7WWnt95pwT7xdAXabYH7QIvVBR17SCsuM4aEdjIGLdHQYgpIXtSYetOXjB+9zf7Abw37QG8migMTxeyNtsBE2OXFqW5dhIXGqRmqIhR6+ng+3GMPNO0g97KAMN12YWiSiuHSaq7DPluh1PC7F5WweKevWwn42l7G/NZzKLG8mVce8XxXj+wk8UwUnpScnS+cU0CTgKXbEcFKg92/WJSHHYTuERhV/u8pLmQupu5ZGH+LOrdHov4LInY5933gpYUJut/O+D6xbD0JdtABY6M9UhXRps7Jh+GrOqF0ZXzS9wTjxML6fqEi9kvMN8uu50Cqs5xzDfmsR5OHwEynYC6uzS3/0EGkjYPrOwyJDHaZb6TJx0NTETMIT2udS0C0pFalR99nR4SVHezU4j1RqPYunzWaJnp5cVtfy+aUkVzUl8opOS9c0zyHt2xHeLvQPIzt5aFv1FH74ajoa5jZ7ppLwZBWqkVKReqZq71UVnkr/D6Xei+onaO1JW8/raFufIlxjMo5jKrhz+eApVXcHwPXVo6rrvwHdDLRM +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get a marker rule by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-marker-rules.api.mdx b/ads/api/reference/get-channels-channel-id-marker-rules.api.mdx new file mode 100644 index 000000000000..b98be6e3a0e0 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-marker-rules.api.mdx @@ -0,0 +1,133 @@ +--- +id: get-channels-channel-id-marker-rules +title: 'Get /channels/{channelId}/markerRules' +description: 'List all marker rules for a channel with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/markerRules' +hide_title: true +hide_table_of_contents: true +api: eJzNV01v2zgQ/SsDnhJATuxud7txkYPRBm3QtM3GyW4XgQHT0thiI5EqOYrjBv7vi6FoS7aVtGn30FNiipyZNx+Pj/ciQRdbVZAyWvTFmXIEMssgl/YGLdgyQwdTY0FCnEqtMYO5ohQKOVNa8qkIpiojtErPIpA6AWcsKT07EJEopJU5Elon+tf3W756nYl0mLApBF3mE7RABixSafUBvFda5WUOPTak+MCXEu1CRELLHEVf8DkRCYtfSmUxEf2pzBxGwsUp5lL02d9UlhmJfi8Subxjc6J/1O2+6B0dPfv9+Yvn3aMj/lR58ttoUbBtpQlnaMVyGW2H/aGK1ExBEeauDhkKtB5MBBOkOaKGnk9Ir9t9DMNQff1eHM+6DSC9bvepsX/0/8gMLoZ/nYW6Ad4VFp1TRsMeVxrvZF5kCGNHkkp3fHxxMnj978uktL7exzM6/q073j+AExmnYNGZ0sbIZoxDB4ocmLnmLjLzTsYNZabBl5xkCFOFWeJ8ZkyBVpKx7qH8VMcez06A7Yhb8FHUsclz2XHIbUmYQB2cj4iM712YLF5CYXGq7kBW36qeH3fGfhTYOupE6RkYm6A9gNdVgbwJjXN0BFNlHcFebJFdDahxav8htOz9J7GeJqhJTVXVoZTiamzXPgtJae0yfD1NNvySLR91O+LNrjDaoePvz7pd/hMbTaiJ/5VFkanYN8zhZ8eh3TfsySRRVU3OLfcAKbYT0BaNpXuRSAoz0IR5mWLFG2bKHci59wB5Ip/oQDqHdN4gqodO76QheqjPvEmoyQ9ytDNMQGkyviaEeZFJwmqng3mKGiRMLMobUA44U0mZYQJTa3KgVDlPxRFIBxKqACCXBYMOUZnJZ4yJo4qNruL/GTDvcNG5lVmJUJsDCQkSxjw74YLIS0fgJCk3XfjhWMfKs5BLitP2GFdz0VJblaMjmRdVWjhfjdsI5tJBOF2lQ8Pp8CP8+Ue3B4kkJJVjyFDDcw0TNbNQsuv3nxQpxSYC5QA5B54sktInvapRlQZldMPFxJgMpWYfqsX8lVZfyk0oqh5WJhiltwd2J3hHFmV+6Ze3HQz9N+AzIDf8+GFEZqcDeFVai5qyBRidLWD89mw4Zleo+Ra5Fm/PhmLU4nnVsqct0HZJp25w7zpZlXKVWd8Y6FoxUiu6t2fDFSaPcNVdfRi/ujoZw9745NNl51PH/yA5c/tgLIxfDy5PLgYf3jR2NJb8vib6V1cnIhLrHS2ZWDZ58porvVGVsH9jCDeSVzdgcwhGLSMSFqS1csG/a8n1TYbbTN35+iDkSJIZNYwqBvIEh+T12gZDeIG1U4jQQNAi3xrlrBZC2JXE2bG0raQ4r+h41lZKqtUgGZJZC23w8kpHrm36HuG5ZbD+ugUZW+OcV7nswz3s5Jw/f9uTtwLyVqqsEjght95di/WtFgo6tiEFK4QbQew2yJYVf09uNEnLkR2WD8IFLsJt7s1WqkwZzbMuZkidQEmus5YLnWoWL/h9wJHKGUt88b6a0Gp5FIkcKTXBio+OUtEXh7JQh7e9w5XZw/u13eXhpmGHcWkVLfz7YSKdigcl27geRcLYGUd4PWI9sto4ZJFRVa2xfbuEg/NTuMEF7JUOLUuh/erpgrFFgr1COjc3NvHc4GWLJ3i2V5czJSq4VUIYO6rTzqRWX6u5q5l+rcNSlImXtkGJ3XWMnXU8n6wmv1DvcOFLovTU+EtbUYZBavytcA6DxMHg/FRE4hatqzzf9vzcGUe59FwRPLxBgu/J+QaOhqr7v1+HASbhHR0WmVT+6ixtVnGPrzLngLH1mC1D5CIS/aZsbQY/ikRqHPHJ+3vmpyubLZe8XElt/wpVLiiANrZs4n3KC7UVzA0u6oeqV1OiL4RX7d8dxA+/N78RUeCaH4zql35JPoJ8/aD8Wdy/0lvyEbzhSVmjHfEPqxjuE6dh7yJcN/vw6CuzNZoVpelFM5pVlPU4L0fLaEWNHF71fRDHWDRx7Dwvl83L5s3JpVgu/wMVhYbP +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all marker rules for a channel with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-origins-origin-id.api.mdx b/ads/api/reference/get-channels-channel-id-origins-origin-id.api.mdx new file mode 100644 index 000000000000..3a888ad94e0f --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-origins-origin-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-channels-channel-id-origins-origin-id +title: 'Get /channels/{channelId}/origins/{originId}' +description: 'Get an origin by ID within a channel.' +sidebar_label: 'Get /channels/{channelId}/origins/{originId}' +hide_title: true +hide_table_of_contents: true +api: eJytVttu2zgQ/ZUBnxJArpN9WCy8TwaSrY1mkSBudh8MAx5LY4uNRDLkyK5X0L8XI8m2fGm3Afrii0iec+Z2qFIlFGKvHWtr1EB9JAY0YL1eaQOLLYzvYKM51QYQ4hSNoeyDipRDjzkx+aAG0/IEZJyQYb3U5MEugVPqntSywyGnKlIGc1ID1a6OExUpT2+F9pSoAfuCIhXilHJUg1Lx1snmwF6blaqq6P9pmzC+w9osvpN0JpuDsyZQkPXfbm7kK7aGybD8ROcyHaNo6n8JIqzs4GGSaFnC7MlbR5614CwxCxQp13lUdrIy+OkEA6c67KtHmTWrAGwlAyeRRCr2hEzJkM/xP+ucAmPuYJOS6aQSNhigPRgBBumV8eQR/vj95hYSZGKdEzQcF0nJ4CKjCyH9mxKn5I8CcOhZx9ohUwBtQHPYB7rwhK+9hJhiQYAl6syuyXdYF9ZmhEZo9QXGF6Pfin1gep/Si7qbnjmFGBU5mp4nTCQqSHRwGW5BNsPS+pMePAN1XluveXsO/FcbDVifkN9NYKfQf0JmN+QhJzQBUr2S3O3wPsAdLbHIWGoPNx1uU+QL8sLdPDjl/RuNXlJgUZ8jS3ehlJMwbwMZwPxuOBnNI5iPHibzCKyH+eh+8jQXGjJFrgZTJVtUpEYPE/m8nzyp2YX4C5/9QMLL8wM4m2WUiA9J7HXN4VDzQH6tY7qQ26o701Mpf3TkMsLcHjr0ZKcg3ek4KLeLLxSzqgT+WHSbb3huvaFWIMNc+4CMsFoR91oJobfX0muyGnodN2Jciauqx2ZJBOTEqW1RavflVA1UH53ur2/7O9h+ucet+i1wv9whVypSgeKi6bhpqRYYdDwsBGo6i5T1KxE6nYnJ7TZOxLkaP+psP63Z8GkMr7SFqyKQl+6/BjQJBIo9MVw5DGFjfXItlaq9sB5PwTuULmV20hStjFOKR79Co/+r83kyrLW3p4QJ+YO7f+1Zv+rVhW8J0OlPtK0ro83S1u6uOZOlR8f6H00bGCYBhk9jFak1+dAwr2/rWbWBc6zdvGWQq/IdqT8Kp3Nj/PSV24bB9JX7LkNtOiPUNMRUYhTtt4d2DypSg27rt+Lk8b7nZpFKbWBBKMsFBnrxWVXJ47eC/LbpjzV6LYPSXPg6tEbe3l3fDe/quR3Ea/jhe8HF8HalMzKSa8wK+aci9Urbo/eG+mXg10g68+v3KNpntJpV0a4nJV/N8jCOyXHn4NnLQtUd9o/3n1VVfQMen08F +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get an origin by ID within a channel. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id-origins.api.mdx b/ads/api/reference/get-channels-channel-id-origins.api.mdx new file mode 100644 index 000000000000..a6fea9bc815a --- /dev/null +++ b/ads/api/reference/get-channels-channel-id-origins.api.mdx @@ -0,0 +1,124 @@ +--- +id: get-channels-channel-id-origins +title: 'Get /channels/{channelId}/origins' +description: 'List all origins for a channel with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels/{channelId}/origins' +hide_title: true +hide_table_of_contents: true +api: eJzNV9tu20YQ/ZXBPtkAZUtp2tQK/CA0bmzUqV0raVEYAjQiR+Im5C6zu7SsCPr3YpYrkZJpOU76kBdfSO6cOXM5M7sUCdnYyMJJrURfXErrALMMtJEzqSxMtQGEOEWlKIO5dCkUOJMK+UAEU5k5MlLNIkCVgNXGSTU7EpEo0GBOjowV/dvlDkyvM0FLCZsiUGU+IQNOgyFXGnUE76SSeZlDjw1JPvC5JLMQkVCYk+gLPiciYehzKQ0loj/FzFIkbJxSjqLPeFMsMyf6vUjkeM/mRP+k233VOzl58fPLVy+7Jyf8qkLyn7lFwbalcjQjI1araNftPytP9RSko9zWLkNBxpOJYEJuTqSg5wPS63b3cRjKL1/L40W3QaTX7T7X9yv/B2ZwM/zrMuQN6L4wZK3UCg4403SPeZERjK1DV9rT05uzwZt/Xyel8fk+nbnTn7rjwyM4wzgFQ1aXJiY2oy1ZkM6CnisuID3vZFxLehqwcJIRTCVlifWR0QUZdNrYx+JTHdsfnUDbOi7BvaxjnefYscRl6SiB2jnvkdO+dmGyeA2Foam8B6zeVTU/7ox9K7B1UolUM9AmIXMEb6oEeROK5mQdTKWxDg5iQww1cI1Th4+xZfTv5HqRkHJyKqsKdSmt23aDWaBLa8jw9iLZwnWm3As74o9toZUly+9fdLv8K9bKkXL8JxZFJmNfMMcfLbu2bNjDJJFVTq4N14CTbCewLRqPliJBF3qgSfN9SpVu6ClXIMfeE+SOfCZAHYEHKI8GE1wqbZBHmFCm1Yxzzy7shCoSmwpoYSFzsg7zAuYpKQ8QbM7RQjgYAXKzwMXwCn79pduDBB05mRNUGK2gpLjVWij9k5JLWWgbBAo0TsayQMftq3wHr4lODOGnTkKOYrYAU5SZviPTQJ1onREqhpUtiB+U/FxuiMlNSFv9rqpy18R5maPqGMLEC0gibZHhAvhj35B14FqNFkZqI93ioeHfA5uqj32XS9VM9GvI9JwM5ITKQipnHLu1ve2+7zawq2nG2NWDXdx3qOTUq4Q2OXoNQk4nYR6I9GH8ZjA8H0cwPr8cjiPQBsbnZ8PrMcOQYsm/FfyJiMT55ZB/ng2vxaiFf2myPS58uLmEQmcZJTBZeO4+51Dn3JK5kzG1xHbVFI1bTn+0pSiMHA7VNdlISLM7as/15CPFro6eQGNw4TO52TqebPJtttebg5CTQxaVTeVU+gGWnF9ZtsTB7xgPYvdbaQwpBy0bTGsRbKb8A0u7ywRHkyzPpvUy0V5V2mFLTt/z4/UqtbGZo4tTHlZM1k8cwNhoa/2Oxxj2cZBrfv00krcCeIcyq2Z8iK2Ha7G+UzhhlWtsQxXDLSceFsiOFT8qtoqk5chqtzRCD8NNGGjebLWYSK14LIgZuU4oa9vZ1HcnrMfsJc54wxVX4ckoEjm5VIfD3imXir44xkIe3/WO19aOlxtzq+PanqW4rBTrdikmaGU8KPn87SgS2szYqdsRT+H1h0MerVWiGp/vZm1wfQGfaAEHpSXD6nlYLewUG3JwUKC1c20Sv5/4Ye3lne3VGUydK7g6ghsPdi0zQyW/VK22LfZ++0gJE7/Qhf3jvqPNrOOFY93shfyDFj4LUk21Xz+kyygscn9LmsMgsTC4vhCRuCNjK+S7nm81bV2OXh4Cwlty8FS8tzg09pj/8SoU2Dm6d8dFhlI1lLkqjlumzpR6tYqyc/2mouq6wlJtHZ9aLlmFPphsteLH1U7pr1vShi2gTRObNJ9zFWsl8okW9Y3sDrOSPxF+Pf1qJ775YvWER0FRvtGrH/rKtIf55ub0vbx/pEvTHr7h7lSzHfE/RjLdZ3bDwU0YKoew9zrV6s1axdSi6c3ay7qVV6NVtFZDdq96P4hjKpo8HtyjVs3Z8vbsvVit/gPyVCFi +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all origins for a channel with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels-channel-id.api.mdx b/ads/api/reference/get-channels-channel-id.api.mdx new file mode 100644 index 000000000000..17fecde069a7 --- /dev/null +++ b/ads/api/reference/get-channels-channel-id.api.mdx @@ -0,0 +1,101 @@ +--- +id: get-channels-channel-id +title: 'Get /channels/{channelId}' +description: 'Get a channel by ID.' +sidebar_label: 'Get /channels/{channelId}' +hide_title: true +hide_table_of_contents: true +api: eJy1Vk1zGjkQ/StdOkHVOEA22azZE7tOeandLafsfBxcrnIzakCxRppIPYNZiv++1ZoBxkByiy8G1JLee93qfhulKebBlGy8U2N1TQwI+RKdIwuzNUyvXqlMlRiwIKYQ1fh+c7RnqsmxmRsK4OfAS9rtl51GIkrkpcqUw4LUWLWrU60yFehbZQJpNeZQUaZivqQC1XijeF1KcORg3EJttw8SHEvvIkVZfz0cyr/cOybH8hHL0pocBdXgaxRom855qLWRJbQfgi8psJFz5mgjZars/LRReSBk0pN06kuuH01BkbEoYbUk1yULK4zQ7swAI6CD6d0N/PbrcAQamdgUBA0dEeaIX6byKrIvJjES/03r06uvvV9YgqvJFJpQQImFJ1pDFUnD3IcEKFKoKVwsKqNJQ+/uejLtg6TgFdy2cqfYmpz2AUqvYRYIn+JZWJqYcoHw3uHMSqaOgX1ZEi8pAFbsC2STN8fBfieEysUWnon76oBbQn3hnV2Dd610gE5DVYpevwP7hTA2DLXBRO1wJCU0A22i/AdyuvTGcXwFVzTHynIE9pDS26E1894SusSrDl+M0371bzyldPX5FnqBVsbpPqxSGBgHhbHWRMq90zEDKb3grTVuAUu/gjkGmGH+lJCWFnnuQwHW+6eGfCOywNJkTU1BPpYW1xSOYP8ylD/ovYXCuIop9ptyc54hEgshes5tFU1N/xpniqrYPaACn5uvl8Phu9Hl5eu3b969GV5ejvYaGMe0oCAamDPZ/OTMt+pQ1Wb/uM9Wh/C4mc8j8TkZ/zE1gUUml6/Bp7BjGcd76VrV1hRATk2fl4QaOKCxEQKhhfSIvDsqpD9SvUXGwCkiAgYCqtFW8hwBF2hcZHB+lRSNzf4G0Uvph9Bzvl3pC+UfCFrspB+eE7fpdseS/FUV6C4CoU51q00UniDB+wfcaZ8ngpdNwU1yNjXdNRqe3tIIUqAzc4oM7SYQdKFGK0lo9QfUtXQ+aSCHcgRdyYXSwzDd1BTvS6lGP6coW7BTbX8ivxZ526lMbGkeERz+HIZSojOMZ6pDxgsEmlMgl9OhrcsY01Xi2HYR7w5zegyPK7Q2tz5/eoTeydTpgw/wWHJ8hJ6rCgomhzJQJMdpWjZvRqZaqnhyQuRe7c8UA8BRPZyU47Y7wO+lnXTInRkdWWe0Hk7zs6+Us9pu07R50YabZMBtO/jTjTKpE+ypVmO1IL5oZYgXXWfBuBCzov5sF+XCgnjp213J1fBSjdUASzOoR4PdMYPN/pytylSkvAqG18n5zDCafFLJvvuHTPmwEBT3D2JPdoF34jkaJ9EJP0715MM0je5eFSnI8++n2RcpD8TQKzHGlQ86ZSS5mDS/5LxDW1gyl1JQLYzjK27CAp35r8nxy0aebJl0VwoHY/Z84cPioslicwGWRryIyG7c3CdfZtjK0k3J5rOhFUx0hMmHqcpUTSE2N9ej5iVHLjD5sPYGsZff0/kF9o6x+54nbSEyPfOgtGjSVK+Clc1NZu8Fv+AaSeXt6iBT40OdPGRq6SNL7GYjZfsp2O1Wfv5WUVg3Wa4xGCngxvs2jkPvveN3cfd2bqsPP7TIZ4nsEuDWQgBtJd9Upp7EGnYs9PZhm+0SKfCa9UmeU8mdnSfeeNt9DtfvP6rt9n9XPCnj +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get a channel by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-channels.api.mdx b/ads/api/reference/get-channels.api.mdx new file mode 100644 index 000000000000..e8d069ebfc66 --- /dev/null +++ b/ads/api/reference/get-channels.api.mdx @@ -0,0 +1,157 @@ +--- +id: get-channels +title: 'Get /channels' +description: 'List all channels with pagination, filtering, and sorting.' +sidebar_label: 'Get /channels' +hide_title: true +hide_table_of_contents: true +api: eJzNWGtvG7cS/SuD/SQDK1tKH7lWkA+6TZBrNGl87T5QGAY8Ws5KrLnkhpyVrBr678WQK2n1iJO0CNB8ibxLzpxzODOc2cdMUSi8rlk7m42ytzowoDFQzNBaMgEWmmdQ41RblDU5lNoweW2nOaBVEJxnbaenWZ7V6LEiJh+y0c3jnuVhf4KBlJgisE01IQ/swBM33p7CO2111VQwFENaNnxoyC+zPLNYUTbKZF+WZ54+NNqTykYlmkB5FooZVZiNxF+JjeFsNMyzCh/EXDY6HwyeD8/Pn3337fNvB+fn8ip5ist4WYttbZmm5LPVKt+H/VNC6krQTFXYQoaafCSTw4R4QWRhGAUZDgZPcbjWf34uj2eDDpHhYPCl2N/HH2jg6vr/b9tzA3qoPYWgnYVe6eRvrGpDcBcYuQkvX169Hr/6/YVqfDzvl1N++c3g7uQUXmMxA0/BNb4gMeMCBdAcwC2sxIxb9I2EjytbXzgxBKUmo0JUxtXkkZ0PH9MnbXtanZZ2YAnBJ1kXrqqwH0jCkknBFlxExC7GLkyWL6D2VOoHwPQuxfxd/w5EILFOVmk7BecV+VN4lQ4omrC0oMBQah8YeoUncTXmzq6Tj7EV71/G9VZWh9rZQEHePxsM5L/CWSbL8hPr2ugintzZH0H0eOzYQ6V0EufSy2GwFjut27rz6DFTyG0wdrX9eUYpgV0poSAiRHaSGl/oYCPVES+6osBY1bCYkQWe0bocwQIDtDtzQAkruLh+D//5fjAEhUysK4KklwDbEzDPiiawq8YhEP9Iy0PXb5ybGoJX4wtISwFlLdzTEhopXxIRAiiQn5PvTxutSEHv+s344gRq5NkpXLUHGtfOySrnoXYKJp7wPhyFpYipEAivrSSNOgT224x4Rh6wYVch6yKZg81O8I0NLTwd1oIJGlR9Z80SnG2li8nY1KLXC2A3FcaaYa4xUtuapIjmTOkQU5msqp22HHZTIB5vh9bEOUNoI6+5/01b5RbvwiGlV79eQc/TQlt1Aou4DLSFShujAxXOqpCDxLZ3xkj6zdwCSvQwweI+Iq0Ncul8Bca5+0Q+iSywFBk9T5dMbXBJfg/2NwP5B73voNK2YQonKdysYwjEQogeCtMEPad367rLvqEnb5f9qpxn+shp/mL1h2Yb1VqRZV1q8kejQ3i8L8tAfEzGt3pOYJDJFktwcdm+jKONdK1qS/IgVuPvGaEC9qhNAE9oICaRs3uB9N8Yb4HRc1wRAD0BzdE0sbziFLUNDNYtoqIh7U+IdqUfQM+69k0sj59zXQ+OiZtK6b4k/2sqtH1PqGLcKh2EJ8jiTQKveR0TvE4BNy5Yz+k6aXjoJQlSodWlXAHtJhB0fo5GDqHVH1DNpfJJAdmGI6hGHEoNw+gpBe+uVMOvE5Qt2AtlviK/FnlbqXRoae4RHHwdhhKi0nEev17AU0mebEHbsi73pGoix7aKOAu4DpQR3C3QmMK44v4Oege3zgk4D3c1hzvo2aYirwtpKwJZjtdxyhm51WLEkxUiN9nGpvTPHLLbg3BcdVuEGyknHXJHro68c7VurbnJH1RwFCY9QO9xGUNh09t/8gbf1fFysxEqYpSOYZNdqTlYH+juzR87+YNT+aHxnizDkTmhk6PpQQs79dIHlvZbdlGPgpSodct+1CA7RnMkWuTxemDZ2KyQi5lEipCNfR1g4V0IcXgSH+HjTi7l9ac9RSuAc9QmddKtttHdEet7gdIOTJ2ZIzHcAXEYIHtWYh+4EyRHtqz2Q6NNcLhqu9VoNrX/2tkLlY2yKXF/PWQKJpzK1Jj9sH50m2cV8cy1ayMGnmWj7AxrfTYfnnU2Byoar3kZx84JBl2MG1l7c5tnzk/F382tdM/rhdfSEqcz6CzfP5Dx5UVs/HpNIC+Xx0maeKnwxNCrMYSF8yrmc2yyY/cj9raHM2Ou5eBbGAfDip+i1X+mLNptA+LIIHdznIjameGh7/y0n2pAm8e1lk5WBNa2dHFs0GyonYR+1bSAsQowvrzI8mxOPiTP82G6BwJXGDO/9fCGGLra7uDtzBr/7FNBC57pgc9qgzp2i403qT7EsxNmgngoFa0TFTMXWF4/Pkqh+MWb1Uoep+EqfndI7ao6Xra6FL7km8RRxPcyQ6wzTTohWZLFmfSzQfztLwyfQNQm/d9E9a/+dvAE880nhH/K+9/09eAJvu1HhC3bW/nDa6Ebq16+riGSGmnPuCio7u46+Gqw6lbfN69/zlarvwCGRP1J +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all channels with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-origins-origin-id.api.mdx b/ads/api/reference/get-origins-origin-id.api.mdx new file mode 100644 index 000000000000..b9cdc2480045 --- /dev/null +++ b/ads/api/reference/get-origins-origin-id.api.mdx @@ -0,0 +1,65 @@ +--- +id: get-origins-origin-id +title: 'Get /origins/{originId}' +description: 'Get an origin by ID.' +sidebar_label: 'Get /origins/{originId}' +hide_title: true +hide_table_of_contents: true +api: eJyFVU1v4kgQ/SulOiWSGZI9rFbsCSnZAU1WQWGye0BIFHaBe2J3d7rLMCzyf1+V7SQOYWYuGLvr41W9qtdHzDimwXgxzuIIP7MAWXDBbI2F9QGmN58wQU+BShYOEUeL44nPNGMrZmM4gNuA5Ny5q6NRA0+SY4KWSsYRtofTDBMM/FyZwBmOJFScYExzLglHR5SDV9sowdgt1vVSjaN3NnLU89+urvSROitsRf+S94VJSTENv0UFduzFoywzekTFLDjPQYzG2VAROUHf+3TENCdruZhm+vKrSjtjkNzE165x4ew2gjjtwEklCaaBSTgby8f4X03JUaj0sM/Z9loJe4rQOSZAUTmazu/hj9+vriEjYTElQ5vjbFK2tC74TEn/5iw5h3cFeApiUuNJOIKxYCS+FroOTE+DjIVTjQAbMoXbcehlXTtXMFlNa85kfLTmuXotzLy29CzudmZOQ0yqkuwgMGVaFWQm+oIOoMawceFkBj8E9cG4YOTwMfBfXTXgQsYB9kZyY/tE/wmF23OAkslGyM1We/cS7xPc8IaqQpR7uOrltlW55qC52w+nef8mazYcRdGXJDpdpHQylV0hI1jdjOeTVQKryd18lYALsJrczmcrTcO2KnG0QDXBBCd3c/29nc9weab+KhQ/gfD4cAfeFQVnuv9ae8M5vHEeOexMymd6W/d3eqH0J719ajN3Tm8z2SOkvx1vyN36G6eCtYZ/D7rrNzx02tAg0GVudEBXGLcsg7aFcdCTHqGtahnet0earWTJXefSaJ7kOMIheTPcXQ+7GMPjS5AaE4ycVu0kLY64pmjScaVei2WCLmwVwGKp4vViOFdFanWmZ37KxXg2hSc+wEUVOehUXwLZDCKngQUuPMW4dyG7VAYajWvWTuO9UZKLeCW7g3Ga4j5syZr/mj6dLGGj2TlTxuFNtb8PXNgOGkK7BOTNFz40HTd24xrVNlLo0b0X84/hPYyzCOPZFBPccYht5t11s4MuSkmNSncZ9Oo53+V3yHui/6PbqgMo/F2GviBje0PfsrpQ9IrqGpPuQoqY4Oh1QJYJ5i6KWh6Pa4r8GIq61s/PFYdDy/COgtERbu9EEzuJ7W6VH6K+eOhW5BJ+dnWereKl91Z3ZUdFpW+Y4BMf+ldrvayTFwoVXHs8TlP20nP8cGfW/TX4fPsV6/p/ctzJGA== +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get an origin by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-origins.api.mdx b/ads/api/reference/get-origins.api.mdx new file mode 100644 index 000000000000..9b27b40f99bb --- /dev/null +++ b/ads/api/reference/get-origins.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-origins +title: 'Get /origins' +description: 'List all origins with pagination, filtering, and sorting.' +sidebar_label: 'Get /origins' +hide_title: true +hide_table_of_contents: true +api: eJzNV9tu20YQ/ZXBPjkAZUtp2tQK/CA0bmzUSVwraVEIBjQih+Im5C6zO5SsGPr3YpaURMuMEycvedGF3JkzZ+57qxLysdMla2vUUF1oz4B5DtbpuTYelpozKHGuDcqRCFKdMzlt5hGgScBbx9rMD1WkSnRYEJPzaji53VM86M3QUyKqCExVzMgBW3DElTOH8FobXVQFDESRFoFPFbmVipTBgtRQiZyKlKNPlXaUqGGKuadI+TijAtVQ8FKsclbDQaQKvBF1anjc7z8fHB8//fXZ82f942N5VSOFY7wqRbc2THNyar2O9s1+U1tqU9BMhd+ZDCW5QCaCGfGSyMAgOGTQ7z/EYaw/fyuPp/0WkUG//1jb34YfmMPV+O+LJm5AN6Uj77U1cJBa+Y9FmRNMPSNX/uTk6nT08r8XSeVCvE/mfPJLf/rkEE4xzsCRt5WLSdRYTx40e7BLIyljl71cssemDRbOcoJUU5744BlbkkO2zn/JP7XYw95paHuWFHyQdWyLAnueJC2ZEtgZFyxiG3IXZqsXUDpK9Q1g/a7O+WlvCuIg0U4m0WYO1iXkDuFlHaCgwtCSPEOqnWc4iB0J1IhbUk++xFbQH8f1Wk770hpPXt4/7fflK7aGybD8xLLMdRwid/TBiz9uW/owSXTtnEsnwWAtehrYsvXoViXITTK2ffsuo7qAbSqpIE4I7KQ0HgkQZ2gM5efJfZTzhAzrVNd1xxlBcxg4077pTDCj3Jq5BEFM2HNVpLah6GChC/KMRQnLjEwAaHQu0UMjGAFK1sL5+C38/lt/AAkysS4IaoxOUDKS8x2U/s2IM+l4LQIlOtaxLpGljkwopQ3RmSP82EuIKRYNkKLO7YJcC3VmbU5oBFZ3IL43+lO1Jaa3Lu20u87IfRVnVYGm5wiTUMmJ9mWOK5DDoTJ2jutUWjptnebVfcV/Nmzqggrlpk070C8gt0tyUBAaD5mei+82+u4WYL+FXY8Vwa4f7OO+RqPTUK7WFRiaAUo4CYuGyBCmL0fjs2kE07OL8TQC62B6djq+nAoMGem9EyVHVKTOLsbyeTq+VNcd/CuXP2DC+6sLKG2eUwKzVeAeYg67mHtyCx1Th2/X7a4xkfBHrXqqkRuhXU62AtKujp3ldvaBYt55T6FzuAqR3I7/rxb5XbaXW0EoiFGayjZz6v4BnjjsDneaQxj293z3R+UcGYaOVaIzCbbj9p6m/aku3iQvQ2Iz1buzyjJ2xPSdPN7sNFudBXKcydQQsqH1A8bOeh/WK8HwXwa5lNdfRwpaABeo83rYNr4NcB3a9xKn2alaa0nN8I4R9xNkT0sYFXeSpENkvZ8aTQ3DVTPQgtp6Q9DWyFhQc+Jes4aKSTiXvVK9bZ5cR6ogzmxzMljAmRqqIyz10WJwtBP1FFd1J5rcqhl6HY8qOTq5jpR1cwGbXMt03Rwcy8isA9A6vh+N0eU5fKQVHFSenHTFJ/VGTLEjhoMSvV9al4QFIAzh0LZF3y4yGXMpUW/MuLfMuDka/bkuobtNPKwUGWESNqZmp7jpWTfvhYawKeJS/0Wr4F1tUhvWCs05NZvSP5qWMEo8jC7PVaQW5HyNvBiEErKeCwxl3yC8IoaWa++Y21pFfugi0ZjOdMNHZY7atNppHeSJ8BJ7B0p8t82IzHqWt7e30iLeu3y9lsf15hUuJdo3I7qrYbUJPObC0mnwR1rt7i0LzCs5osLC+s1GfPf14ysWNeX+nVb91BeLB5hv7xc/yvtnulo8wLe5YezYXssfp4VuaHnRpoFIadQyozimsi1170qxbnfeV6fv1Hr9PzC9njk= +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all origins with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/get-templates-template-id.api.mdx b/ads/api/reference/get-templates-template-id.api.mdx new file mode 100644 index 000000000000..7865f6a5507f --- /dev/null +++ b/ads/api/reference/get-templates-template-id.api.mdx @@ -0,0 +1,3941 @@ +--- +id: get-templates-template-id +title: 'Get /templates/{templateId}' +description: 'Get a template by ID.' +sidebar_label: 'Get /templates/{templateId}' +hide_title: true +hide_table_of_contents: true +api: eJztXd9v2zi2/lcIPaWAnTYXi4uF5ynYzs4Gt70tZtruQ1Fc09KxzYlEqiTl1BPkf784JCXLljJJ2nTbqb956CQWRR3y/PrO+UTnOivI5VbVXhmdzbJfyAspPFV1KT2JxVZcPD/NJlktrazIk3XZ7P31wU0XBWmvloqsMEvh19RNwLcqHlJLv84mmZYVZbOsvXxRZJPM0sdGWSqymbcNTTKXr6mS2ew689uaRztvlV5lNzcfeLCrjXbk+Pp/PXvG/8uN9qQ9/yjrulS5ZLme/u5YuOvefLIoFF+S5WtrarJe8TxLWTqaZHXvo+ssX0utqbwowm+3Lde1603DnfBr5Xbbp5wolb6kQngTtsJT5UZWNmk/kNbKLf/Oa7KmdHeKvS/aqzoOFHUptwuZX4p2IrE0Noi6sCQvJ8I1+VpIJ9ylqoXUhXBa1uGOBa3lRhkb1L63KTz21XLpyA835X+bahH17yg3unDhYRtFV2RF1TgvrqTP12JBS2NpJ4lYUG4qioLUclHSqXiptKqaSjxjEar4SzZ71u2SDs/ibWqFHsrz7zX5Ndm+FMoJWZbmKqhDOKJLYTbU25VT8e81aUGaxSgmQrZ38lilVwfDeUJLvrE6zsgXnJfWt1YRR/HmsjqcUF4oLZZNWf4kjM5pf6rCaJrsFGfJNbwv0odhxqqVYs0GuWvjgkkkifcEdULpJE3StV/TVkhLQpbOPETknsQTIZeerLhaq3x9q5QFLWVT+vSxqI3SXpzE36LlTETfDkXR2OCt4orXoY0XjvyTtCz+tbbkSPvJwxSZdbayMKYkqbObnZOZxe+U++BllqSn4nzEnt+oipyXVR0l6wc1cSWdSLdO2IekFhe/vRJ//+9nZ6KQnryqeFvZt3uS7Jy9XfTwqc/T/h1sjtKdV7Ebh6udCGJpTbUfeB7iQrQh7e8b58Lgx4tyqhg+9a1WH5veZqtOirSUF6RXfp3NzkZ2NuaXwyn/1VRSTy3Jgh1bFMoF4+bBXVjsZ6zBtH0DHk4fP+8rKQXdkmPG1ZosiZSjRhwneNVhCBpY/qFBONE4Ktj4+GpyNxMEGY8JwUFkmudK+XWXGU67yN8FvsGc/EC10sbyM3XRd8YUj9jRW6m8SXc/xA430iqZsrjevloGnGE0pZ8ekLulc+RH7Pk8fB5UwF4TFK+cSA8+FedelCSdF0ZTjO0RmOzZ9GdJ9CcO32o0OViQvWdKkxh+LrW50g/ZzdazQjjJZtmz9N80/PM3/ufv7a/tf9khmkiuqAbwLkrJVqR033ZfW7NRBRWMGwMsapw3Fd9nhWy8ma5Ikw1Bi8OmePv24nlcoKmU93Gr73BxpT1Zmbfb+TngqDdFh3a6QBDWtsNHUuSlyi+nfm1Ns1qLt7++GAKjMORNHDHU8T8OJxCmJk7AXWZp81qSy0UHDdIUp+Ilo6cFsUfLUhWtCEtjK8m6bawaBq2xdFdRoeSb8OmhjC/5kuA7WMdSx22YiTnr08xZgXNVyRXN+dGk2e7eZ+EiewdfyT6MaKtSFd3yxIuXP3cP3BlVkFGcsDbok6zqkpIMT6v6b/Mn+/5wzigghsDg1ZZDT8FlSqU0iaZeWqM93xKwoPIilzoim+D64ZE/CcNXr5QjHrHmmGqEt9uJqGSAfVGy2hJXQcFqHKMPO5or/OhqQ+yJyy0UX6iUlt7YUzF3XnqVz2dCikJZyn2XLCwtyRIDxZ01xv0xVoQ9b22hVUica1QTbCV7sfXP7WdyvYt5D4h0XtoVeZ7hM32zoI1iZNzOI/xaMigsKfhF9BjlxNtfL9p8M/THOMm43T1PD2BVhJlIe7tND3Rd8oyJso4BzQlHG7KybJOFm/SNrpUu4HRNouJKJ8re+XYUqa+rgtylNzVvPaddz6HPLFRJ/MlmRIdjLr2RZTOyyDedP/E+dakuLnXPuXoW9e78tzfCyxUb1ZM7I/FNv3J/nwT5MBZ1lL6IlnR2iAA/HJrBC5PvpcNoz20wIhXcWAqn9KoMxp9gdqgqOGrxvHwzX+LVKnKCZL6OEdXcZmWng/Uobk3sAmaSPLrRyCoBBwAHAAcAB74cDmyk8wEM9MNxf02WnCk3FMRaEvfUuCKzpItUSIa+gNrsJRueFbAAsOCvCQs6EcqED34cLBDU8brHrtx290g77RZfkYXY0TWi5idwxybmm9T03ZAueJs4o8UJRSXrU/HPnQ1MgoH8Ygxv73khXkotVzHEOArtZJ5oLos3crVbwLwXBXfKBuIB4gHiAeIZRzwhFgXME3+cViHUFK2bhQ46G+87RVciXnSJbyrVhux215SOca0/RhaioFw5ZXQiZDrthcF/Bot28aMuZU5rUxZkB2HiXRtMU2aNYXQYOWuTlhQFS1jFb2uVy7LcikYHtTKZFjGc0WFhjQ5t9cJcaectyeqnlmgLmpKiJ9w9Akha9lBFRbt9iWVXzJawIfb2LwjUbTu7yi6XBPLhH421pH25FUaXWzFfyWouTgab8aSviJWsRrUQZ36U7Bh1NHU15Wqp8n6GHCTBdxxlQpCuyabl/RQ2Iq5Gijk/bS6WisqiTxWIk/xg+bUp5k9GcuI9IUbS1STFuMGGDOHHhz/HVruweaj+dxHDilJuTeOHbcqAs4KXMh88dbkl0gkQL1UkuwJHqL2yXTziyF4b6/e6lGGqUY0/fqEw5Hk+A8rXKr+8F5AX5+0EIYXxRu5EUYEZdKqgwKO1TpwkOhRAfGxkqZZbcVI1pVecCFqvDxC3+7S7oV8dkXBMbzKnyQp/MklvERQhzSYav3sxoKCl4oTMjl6Qm/XX3rgUSJfKOr9b3tq4EB0q6fcSi9EJ+gRH6CQ43nLswNWT/01anvJRKogH052TWArVMoStALekyE1VSx3STgzm96JEZVl+CV2L2gC1AWoD1AYgR9EFRRcU5CjgAOAA4ADgAMhRwALAApCjIEeBeIB4gHiOFPGAHAU5CnL08cjRhx0DbwmRkbi9z5W0pwrZMUujV8zyxdBjVSXZCcOok2Csi62YF6ZZlDQPJjMv3VrW9H+ymHdoOewLCBXgCeAJ4AkQKuicoHMCQgWECuAA4ADgAAgVwALAAhAqIFRAqADxAPEA8YBQAaECQuUbECoHU+8Yk//c0bREpcwCPitouthOA/2ShkePDlgs5Xsn3JpNf/zYS0T7KroNfzHiyppGF5y7VHL8/mP24HSQBCfbcLLtKEo/nGxD5xV1COoQ1CEgYtFxRccVRCzgAOAA4ADgAIhYwALAAhCxIGKBeIB4gHiAeEDEgogFEYuTbTjZBjwBPAE8AUIFnRN0TkCogFABHAAcABwAoQJYAFgAQgWECggVIB4gHiAeECogVECoHPXJth17MuNY+mIafi/2T7Yl5zR53tQqOeuL6ZLXdip+3h17W8csdL/DbimWHjyxb2ydbDjuhuNuR1EPfpfH3e55lA18K8oNlBsoN8C3orH6zRPpD9dYBd8KOAA4ADhwxHAAfCtgAWAB+FbwrUA8QDxAPEeAeMC3gm8F3/p4B9i+JoWaepN38ahsH10fc5RRHTKgaThoUNCgR1GmfVsaNH5zb4KvZkO2lFtwoCgBUAKgBAAHimbnXyWL/nDNTnCggAOAA4ADRwwHwIECFgAWgAMFBwrEA8QDxHMEiAccKDhQcKDfOQeaaJLopso1smyZk0SnMMdl6l3nhg21I/xCZLdNHbA7xx8+Jto3gTTXqBmYWubKb4civ0oCpAFRk8tdZvNXRFo8EyfLhv3LW6ldLVk/T4Idn7VXTC0/NhTRrfwUUcXZHQijNk59ThJOMre391EEp8HaWH8qfo224TgW7Egp3lveYisWxntThUWkCyUtPV+xarX2wwwdbxjBX8p5yS3mpLdWp+kBVKxILK2pIsqJH6ahrbSTW/c97PGDNpVXcX8hw5r3RYzb8PUEDNt7fwnD8AMR42dfUUYuH+8tIRvUvnw9L3586cZgmVN/0Gd6Ed/KsrWSuUPJh56wpnEVtlPG6wcLPpg1DZp8kZquVOFH0HIrR7h8hxhhzJdIcZCGokiTdo/G6na8jYK3UX60htkdb6P0cn0KVrd8d/qXvSWCs/to26Btg7bNX6Rtg/dWQFCBoMJ7K4ADgAOAA0cPB/DeCmABYAHeW8F7K0A8QDxAPEeAePDeCt5bwXsr3/l7KxFnBS/ldz2mLrdMlUZAvFRl2SJbzpW2i0d9/rjrUoapcEYfrOhRlGPf5VeVT2IpVMsQtgLcGvw9gntSorIsU+8A5ChqA9QGqA1AjqIL+s3T7g/XBQU5CjgAOAA4cMRwAOQoYAFgAchRkKNAPEA8QDxHgHhAjoIcBTn6eOTogwDI7u9MD+P2wd9uLpRLVIssjV4xyxdDj1WVZCcMo06CsS62Yl6YZlHSPJhM729Ld2g57AsIFeAJ4AngCRAq6JygcwJCBYQK4ADgAOAACBXAAsACECogVECoAPEA8QDxgFABoQJC5RsQKgdT7xiT/9zRtESlzAI+K2i62E4D/bL3F2UDFkv5vv3LlePHXiLaV9Ft+PuVV9Y0uuDcpZLj9x+zB6eDJDjZhpNtR1H64WQbOq+oQ1CHoA4BEYuOKzquIGIBBwAHAAcAB0DEAhYAFoCIBRELxAPEA8QDxAMiFkQsiFicbMPJNuAJ4AngCRAq6JygcwJCBYQK4ADgAOAACBXAAsACECogVECoAPEA8QDxgFABoQJC5ahPtu3YkxnH0hfT8Huxf7ItOafJ86ZWyVlfTJe8tlPx8+7Y2zpmofsddkux9OCJfWPrZMNxNxx3O4p68Ls87nbPo2zgW1FuoNxAuQG+FY3Vb55If7jGKvhWwAHAAcCBI4YD4FsBCwALwLeCbwXiAeIB4jkCxAO+FXwr+NbHO8D2NSnU1Ju8i0dl++j6mKOM6pABTcNBg4IGPYoy7dvSoPGbexN8NRuypdyCA0UJgBIAJQA4UDQ7/ypZ9IdrdoIDBRwAHAAcOGI4AA4UsACwABwoOFAgHiAeIJ4jQDzgQMGBggP9zjnQRJNEN1WukWXLnCQ6hTkuU+86N2yoHeEXIrtt6oDdOf7wMdG+CaS5Rs3A1DJXfjsU+VUSIA2ImlzuMpu/ItLimThZNuxf3krtasn6eRLs+Ky9Ymr5saGIbuWniCrO7kAYtXHqc5Jwkrm9vY8iOA3WxvpT8Wu0DcexYEdK8d7yFluxMN6bKiwiXShp6fmKVau1H2boeMMI/lLOS24xJ721Ok0PoGJFYmlNFVFO/DANbaWd3LrvYY8ftKm8ivsLGda8L2Lchq8nYNje+0sYhh+IGD/7ijJy+XhvCdmg9uXrefHjSzcGy5z6gz7Ti/hWlq2VzB1KPvSENY2rsJ0yXj9Y8MGsadDki9R0pQo/gpZbOcLlO8QIY75EioM0FEWatHs0VrfjbRS8jfKjNczueBull+tTsHow7Bq0tM7bxlXcoO7vzjKQFqVyIUF0dhNic2cRn7Nfw8ZcmDqbROgZ6g0qzsd8/mYApp9HKxe/xjqBwuxsOKFmuSiyWbYiP/VUsW2R6366KIKaVo5FeNNe5mdW5Ncm3cgbLjk0Zk9lrZ5uzp52Mz293k11w9qgvLEBG76/zhbSqfy84Tvff5hkxq5YlPcfePfbgb/la6oSJNoNH5RCry/EJW3DF9JbLSuKeNFRbvlr6rmndmVsEQCjCzNmszjfDumvva8Deo1iDMK8XUmt/ohV3q7DFF424utrkrHW5Mdns+zT1NjVNCirNa1a/Q9tw94rvTShCFK+pBRsQ7F8Xjhx/voilA7WxSdvzhJ89ZUM6DU94Rfy4vad3pOev/s/vrAYb5OiHcydr4vnvYLH0yf/tC6l0rGuLvnuqN73vAQW7YyHd9YwyWY9e/kwydbGeR59fb2Qjt7a8uaGP/7YkN1GVQdr5r+azmZQKMc/F+OJqC/6SYLZxRNxMejxtTLcupZWDXqbdR33LJtkl7QNY7slhOCQ9MkCxgHneU61790q67pUsb/99HdndIganV/88vOb7Obm/wHK2T/R +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Get a template by ID. + + + Request + + + + + + + diff --git a/ads/api/reference/get-templates.api.mdx b/ads/api/reference/get-templates.api.mdx new file mode 100644 index 000000000000..f59b38bc55bd --- /dev/null +++ b/ads/api/reference/get-templates.api.mdx @@ -0,0 +1,4064 @@ +--- +id: get-templates +title: 'Get /templates' +description: 'List all templates with pagination, filtering, and sorting.' +sidebar_label: 'Get /templates' +hide_title: true +hide_table_of_contents: true +api: eJztXWtz2ziy/SsofYqrJMeenXt3x6l8cG2yc1M3s8nmMVtbqdQKIlsSxiTBAKAdTSr/fasbIEVJdPyIs8lEZz5kbBEEGkA/TvcBrA+jnHzmTB2MrUYno6fGB6WLQgUq60IH8urChKWq9cJUmhuN1dwUgZypFmOlq1x564KpFoej8ajWTpcUyPnRyZsPW10fT2baU85dkaqackZOBaschcZVh+oXU5myKdUxd2T4hXcNudVoPKp0SaOTEb83Go8cvWuMo3x0MteFp/HIZ0sq9eiEx5vrpgijk+PxqNTvubvRyU9HR38+/umnH/7nxz//ePTTT/wojiTNwqrmvk0VaEFu9PHjeFvsv0dJ7VyZQKVfi6xqcjKZsZpRuCCq1LEsyPHR0afm8NL8ft15/HDUm8jx0dFNZX8mP+hCvXj5j6dp3xS9rx15b2yl7s0t/67LuiA19UGHxj98+OLx6aN/PcgbJ/v9cBEe/uloenCoHutsqRx527iMuBvrySsTvLIXFSuNvZgUrD92nsbSs4LU3FCRe1kZW5PTwTp/2frE1z69OmnaPrAKfnLWmS1LPfHEahkoV2vhRKJgRXfVbPVA1Y7m5r3S8VnU+elkqniBuHeqclMtlHU5uUP1KG6QdFHRBfmg5sb5oO5ljnio09B76+Cy2fLoN5vrW27ta1t58vz8h6Mj/l9mq0BV4B91XRcmk527/5vn9fjQ60/nuYmL89zxZgTD/aRh695HH0a5DkkZ+2v7aknRgO2cVYEXQWbHpnHDAbKlrioqnuR+d5gnOVXBzA05zyOFJanU3KuwNL5zT8p4VZjqjHIV7IYkW0vXmYt2Tq/4d140Z4urxb5Eu+pCr2Y6O1NtR6IsLOrMkT4bK99kS6W98memjp6y0rW8MaOlPjfWic/cWBRu+2w+9xR2F2XtiTxltmINXpI6N3RBTpWND+pCh2ypZjS3jtaSqBlltqQoSM02ufa24qk6p3LUrVL0z7xMrdC78vxzSWFJri+F8dEPyHYoT3Sm7Dn1VuVQ/XNJlaKKxcjHSrdvcluxsI3m3GH0trFHfuCDdqHVitiKF5e3g72RMpWaN0XxQNkqo82uclvReL1xrMC8LjpIM+sMB7kiyl1bLyqRJN4Q1CtTJWnSXoclrZR2pHTh7U1E7kk8VnrODvpiabLlpVKm4JA+VrU1VVD34m9Rc8aqr4eqdeTqgudR2aA8hYM0Lf6VwwFVYXyzjRx1ujKztiBdsStuP7Kz3ygLYmWtQxzwJaYkH3RZR8m4686sL7RX6dUx25Cu1JOXz9Rf/vfoWOU6UDAlL6tLwGPH2NtJ746afPf24piqsyo2Y3naiaDmzpabjucmJkTnVIXr+jlpfHdezuS7o76uzLumt9imkyJN5SlVi7Dsg4z1ADF2bXf5f02pq4kjnUvMz40X5ebGnVvslm5ow/oKvNt9/Ly/ScnpFuwzLpbkSKUgOGA4YlXbLmhH87cVwquG4aqObjaZmxVBhn2CGIhO/QiCaCPDYef5O8e30ycPaBaVdTxmlfeNMfkjNvRWKkGh/PZN9PBcO6MTTKhWz+YC0m1F6acbxG7tPYUBfT6Vz2UL2Gpk441XaeBDdRpUQZpRWEXRt0fos6HTt5LoEwbf7mgyMJG9p0rj6H7OKntR3WQ1W8tKWH10lP6byD8/8j9/aX9t/xtto4lkimsL3JSStchUfd197uy5ySlXs1WERY0PtuT3nNJNsJMFVRThLrtN9fr1k0dxgrY0IcSlvsLEOaNwOmuX8zbgqNdFh3Y6RyBzW+MjrbLCZGeTsHS2WSzV6xdPd4GRNHkVW+zu8V+3O+BUgwNwF1nauJbkSmmtSJMfql8YPc2ILVoXJm9FmFtXat7bxpldpzUU7krKjX4ln27L+As/UvwG77Gu4jKcqCnvp53yBk5NqRc05aGpYr17M5KHbB38ZPR2YLdKU9IlIz755XE34FqpRMat3E+GuV/WP04PNu3hlFFAdIFi1ZKz55zjl6Yi1dRzZ6vArwgWNEFluorIRkxfhnygLD+9MJ64xVJL5hTcaqxKLbAvSla7mKux1nhGH24wVoTB2YrvidPNDT8ouWJh3WHMbE02PVFa5cZRFrpg4WhOjhgorrUxro91Sta81YV2Q2JfgzvBWrLhWz+tP+MPt8qbgnYL4orLbW0zp3PDyLjtR4WlZlBYkNhFtBjj1esXT9p4s2uPsZNhvXuUBuCtkJ6oCm6VBvRd8IyBso4OzStP5+R00QYLP+4rXSud4PSKVMmZTpS9s+0oUn+vcvJnwda89Bx2Odku7cwUXH8J5wN7OGTS57poBib5qrMnXqcu1MWpbhhXT6N+PX35SgW9YKU6uNITf+zXBt4kQd4OeR1TPYmadLyNAN9uq8FTm22Ew6jPrTMiI2aslTfVohDlTzBbsgr2Wtwvv8yPeLaGvCIuDYlHtZdp2eHOfEw+6jvMJHk0o4FZAg4ADgAOAA58Phw41z4IGOi74/6cuMhdnJOINSeuqXFG5qjKUyIpdQFzvhFsuFfAAsCCPyYs6EQoEj74frCAbMfzHjV52dsD5bRLbEUzjdl2qGoegSs2Md6kou85VTkvE0e02KEqdX2o/rbWgbEoyM/W8vKe5uoXXelFdDGepJzMHU11/kov1hOY9rzgerOBeIB4gHiAeIYRj/giwTzxx0kpriZvzUwq6Ky8vxq6UPGhT3xTYc7JrdZF6ejX+m10rnLKDJ8pSIRMt3vS+FOwaO0/6kJntLRFLicAtsJT60xTZI1udNdz1jZNKQqWsEpY1SbTRbFSTSXbymRaxHC2kok1lZTVc3tR+eBIlw9aok12SquecNdwIGnau1uUt8uXaHwjJyTkkEG3fiJQt+xsKutYIuTDXxvnqArFStmqWKnpQpdTdW9nMQ76G7HQ5eAuxJ7vJDrGPZr4mjIzN1k/Qu4EwV/Zy4iT5lM0UYgHshBxNlpNebRpOo/RowrUvWxr+rXNpwcDMfGaECPt1Tj5uJ0F2YUfbz+NrdZuc3v7f40YVhV6ZZuwW6YUnCVWynzwxGeOTxVFQDw3kewSjrAKxnX+iD17bV3YqFJKV4M7fveJwi7PcwsoX5vs7FpAXp22HUgI44Vci2KEGfQmJ+HRWiNOEm0LoN41ujDzlbpXNkUwHAhaqxeI233avdDPjkh5pjeZ0+QNPxinUwS5hNlE43cHA3KaGw7IbOg5+ZP+3BufHGk8RdRNb2m9eIdSh43AYqsEfcQQOgn2Nx3bMvVkf+OWp7yTDOLGdOc4pkK1FrclcEvzmbRaVxJ2ojO/FiWqi+Jz6FrkBsgNkBsgNwA5iiooqqAgRwEHAAcABwAHQI4CFgAWgBwFOQrEA8QDxLOniAfkKMhRkKN3R47e7Bp4S4gM+O1NrqS9VciGWdhqwSxfdD3OlJqNUFrdE2WdrdQ0t82soKmozLTwS13Tv3U+7dCyrAsIFeAJ4AngCRAqqJygcgJCBYQK4ADgAOAACBXAAsACECogVECoAPEA8QDxgFABoQJC5SsQKltdrxmT/97VtESlnAg+y2kyW02EfknNo0ULFkvx3iu/ZNUfvvYS0b6JZsN/GHHhbFPlHLtMMvz+MBtwWiTBzTbcbNuL1A8321B5RR6CPAR5CIhYVFxRcQURCzgAOAA4ADgAIhawALAARCyIWCAeIB4gHiAeELEgYkHE4mYbbrYBTwBPAE+AUEHlBJUTECogVAAHAAcAB0CoABYAFoBQAaECQgWIB4gHiAeECggVECp7fbNtzZ6csC99OpHf882bbck4bZY1tUnG+nQy57kdqsfra2/LGIWud9kt+dKtEfvK1smG62647rYX+eA3ed3tmlfZwLci3UC6gXQDfCsKq189kH53hVXwrYADgAOAA3sMB8C3AhYAFoBvBd8KxAPEA8SzB4gHfCv4VvCtd3eB7UtSqKk2eRWPyvrR1TEHGdVdBjQ1Bw0KGnQv0rSvS4PGv9yb4Ks9J1foFThQpABIAZACgANFsfOPEkW/u2InOFDAAcABwIE9hgPgQAELAAvAgYIDBeIB4gHi2QPEAw4UHCg40G+cA000STRT4xtdtMxJolOY47L1unLDitoRfuLZXVMLdmf/w9dE+yqQ+hpUA1vrzITVrsjPkgCpQdzJ+TqyhQuiSh2pe/OG7Ss4Xfla8/4ciB4ft09srd81FNGtfh9RxfEVCKO23twmCCeZ29f7KILDYG1dOFQvom549gVrUorXlpfYqZkNwZYyifSgoHngJ84slmE3QscXBvCX8UFziTntW7unaQDKF6TmzpYR5cQPU9NW2vGl6y5rfKNF5VlcX0iZ86aIcRm+nICyvNeXUJpviRg/+4Iycvp4bQlZoTbl61nx3Us3BMu8+Z1uaUX8KsvWSua3Jd+1hCUNb2HbZXy+NeGtXlOj8Wdt04XJwwBabuWQx1eIIW0+R4qtMBRFGrdrNJS34zQKTqN8bwWzK06j9GJ9claX/O30zzslgrv7KNugbIOyzR+kbINzKyCoQFDh3ArgAOAA4MDewwGcWwEsACzAuRWcWwHiAeIB4tkDxINzKzi3gnMr3/i5lYizxEr5rMfEZ46p0giI56YoWmTLsdJ1/qjPH3dVSukKd/TBiu5FOvZN/qnycUyFai1uS+DWzvcRXJMS1UWRagcgR5EbIDdAbgByFFXQrx52v7sqKMhRwAHAAcCBPYYDIEcBCwALQI6CHAXiAeIB4tkDxANyFOQoyNG7I0dvBEDW3zO967e3vrs5Nz5RLbqw1YJZvuh6nCk1G6G0uifKOlupaW6bWUFTUZned0t3aFnWBYQK8ATwBPAECBVUTlA5AaECQgVwAHAAcACECmABYAEIFRAqIFSAeIB4gHhAqIBQAaHyFQiVra7XjMl/72paolJOBJ/lNJmtJkK/bHyjrGCxFO/bb64cvvYS0b6JZsN/X3nhbFPlHLtMMvz+MBtwWiTBzTbcbNuL1A8321B5RR6CPAR5CIhYVFxRcQURCzgAOAA4ADgAIhawALAARCyIWCAeIB4gHiAeELEgYkHE4mYbbrYBTwBPAE+AUEHlBJUTECogVAAHAAcAB0CoABYAFoBQAaECQgWIB4gHiAeECggVECp7fbNtzZ6csC99OpHf882bbck4bZY1tUnG+nQy57kdqsfra2/LGIWud9kt+dKtEfvK1smG62647rYX+eA3ed3tmlfZwLci3UC6gXQDfCsKq189kH53hVXwrYADgAOAA3sMB8C3AhYAFoBvBd8KxAPEA8SzB4gHfCv4VvCtd3eB7UtSqKk2eRWPyvrR1TEHGdVdBjQ1Bw0KGnQv0rSvS4PGv9yb4Ks9J1foFThQpABIAZACgANFsfOPEkW/u2InOFDAAcABwIE9hgPgQAELAAvAgYIDBeIB4gHi2QPEAw4UHCg40G+cA000STRT4xtdtMxJolOY47L1unLDitoRfuLZXVMLdmf/w9dE+yqQ+hpUA1vrzITVrsjPkgCpQdzJ+TqyhQuiSh2pe/OG7Ss4Xfla8/4ciB4ft09srd81FNGtfh9RxfEVCKO23twmCCeZ29f7KILDYG1dOFQvom549gVrUorXlpfYqZkNwZYyifSgoHngJ84slmE3QscXBvCX8UFziTntW7unaQDKF6TmzpYR5cQPU9NW2vGl6y5rfKNF5VlcX0iZ86aIcRm+nICyvNeXUJpviRg/+4Iycvp4bQlZoTbl61nx3Us3BMu8+Z1uaUX8KsvWSua3Jd+1hCUNb2HbZXy+NeGtXlOj8Wdt04XJwwBabuWQx1eIIW0+R4qtMBRFGrdrNJS34zQKTqN8bwWzK06j9GJ9clY3hl07Ja3TtnAVF6j73lkG0qowXgJEpzfimzuNuM167RbmpOvROEJPyTcoP73E5rcgZK0XjAtvDn6edy+qkoLOddBd3cGRbwqu6Q747JrT6926QlLg48lMc4LErVT0bD3E3UNsekEvU6zZ7Onv0oaXXKrbgufJtxkAvzfYYbBBFwNlVv44CbLuc2N33jWStWbOeq90UcgY/vJBnvPjq0eSXpQ+16bQbfLWDTfQ+5ZSyDL31qmd4YYQuwqy1Qvv6mhDSQZe2UnQHkXPqV7E3JOkW9YB6eJJPjoZLShMApXsr8iLvS88D/iq++wtJ1FhaVNrkYJj7Oi+rs398+P7/dc9ZY2TvOLNh9FMe5OdNtz4zdvxyLoFD/nmLVtu2/BltqQywel18500+vkTdUYr+TIDV+mSYq7hKXP8FQdcj72wLpdkw0uPo5PY33p/liHUkvlEMXYgglvoyvweDWldnZSDavx8STrWKXj40cno/cS6xUQMvTXl2vw/rWSNTTW3kkCbUFAK1FJoOc29On3+RNJO5+PI58cp9QmlFuNPI/xMQW0s7obA/FUR8Xzryegp+zbW+K51LPat1WWs5qYIFGv5snTWhVS6SeIHeh/u14U2VSzWFNFJyO7x3FjmY27e14yl9YGff/jA7uK1Kz5+5I/FNkQHcuPZavJh59WfxIDH4UqMo9C4Xpn6+FKRz2jFRaVob4mtGQl3cH0htp1WJ0DntNbI8Dgiw6Oja0iUTP+WUnU478XLfzxNO6nofe3Isw5tVTb5gEfjHz588fj00b8etDTBw0V4+Kej6UH601PMeDYuI+7GMtYxwSsplHH5c9JGyzhW9HtcmPExPRYXYp2/Yubx7TuYd2bLUk98rJXy+fBOPJEpWNFnNVs94Irq3LxngC+FJLGD6WSaam4+oyrngCGY8FA96tX8KrogHxLgu9dF795bB1fMl4XYmO3bcQQFM/YCbxjPJDfCphHfOc0yqvtv6bouTKTk7v/mbSW9dB7458evRh8//gevsw8u +sidebar_class_name: 'get api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +List all templates with pagination, filtering, and sorting. + + + Request + + + + + + + diff --git a/ads/api/reference/optiview-ads-api.info.mdx b/ads/api/reference/optiview-ads-api.info.mdx new file mode 100644 index 000000000000..5c3cf070dd1a --- /dev/null +++ b/ads/api/reference/optiview-ads-api.info.mdx @@ -0,0 +1,59 @@ +--- +id: optiview-ads-api +title: 'OptiView Ads API' +description: '' +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +--- + +import ApiLogo from '@theme/ApiLogo'; +import Heading from '@theme/Heading'; +import SchemaTabs from '@theme/SchemaTabs'; +import TabItem from '@theme/TabItem'; +import Export from '@theme/ApiExplorer/Export'; + + + + + +
+ + + + API key (username) and secret (password). +
+ + + + + + + + + + + +
Security Scheme Type:http
HTTP Authorization Scheme:basic
+
+
+ + Organization identifier. +
+ + + + + + + + + + + +
Security Scheme Type:apiKey
Header parameter name:x-org-id
+
+
+
+
diff --git a/ads/api/reference/patch-channels-channel-id-events-event-id.api.mdx b/ads/api/reference/patch-channels-channel-id-events-event-id.api.mdx new file mode 100644 index 000000000000..15db1bbaec6b --- /dev/null +++ b/ads/api/reference/patch-channels-channel-id-events-event-id.api.mdx @@ -0,0 +1,84 @@ +--- +id: patch-channels-channel-id-events-event-id +title: 'Patch /channels/{channelId}/events/{eventId}' +description: 'Patch /channels/{channelId}/events/{eventId}' +sidebar_label: 'Patch /channels/{channelId}/events/{eventId}' +hide_title: true +hide_table_of_contents: true +api: eJzFVk1v4zYQ/SsETwkgr+MeisI37xfWaIEY2Wwvhg9jcWxxI5EMOYrjGvrvxZCyLctu2qQLrE8yOXwzb+ZxhjvpwEOFhD7I8XwnFYbca0faGjmWU4WG9EqjF3YlqECRF2AMlu9kJjVbOKBCZtJAhXIs292pkpn0+Fhrj0qOydeYyZAXWIEc7yRtHRsH8tqsZdNk/+4Wn9DQPziNe690uUjGGOi9VVu2yK0hNMSf4Fypc+Bght8DR7TrQDlvHXrSGPjfSeB9Hp894oDwmURn/YxSL7ZMolEfgfAc7xMfEWiUIF3hO/HeIzwEURuFXlChQwIVVR1ILFFw0KouUQkgYb1Y4sp6TJYRgb2lLPZdfakrMAOPoGBZolA6uBK2go3FyvpTBpU2f6BZUyHHowt8AoGnlxhFgzdyghXtDVtKzSEEu/yOOcmGl061EReCsyakMv5yc/MqEYBSmregnHXksIIyYNZTSO4RCNWEztnf6woDQeXEpkBzzKnYQBDtuUxAEGDE9Out+O3Xm5FQQMhMRUrwRQX9RFW+KV6tzmG/Gf1Y7xOijx1ho6nQpt+MziB/gKz/j5DfkIYTkc45Jy2LruNjHbKOshYXJX8a4UdcQV2SuGt1Hx2yUKPGpyr11bwYtFkNg0M3H8SUhMGx0xKseV4k2oH9nzqbMZIY7qGGuwNWM0xgw12L1nADQSrsIQKZpQ4/lkNwevg0+s84AfPaa9rGUbaEoPNJzUDzRSatXzPJ+YKb/97wK9/odE875v3iTmZT8YBbcVUH9FySawFGiYC5RxJXDkLYWK+uuaixR3AlIt6xygWRYw21YfRd3Po1GP1XrEVH7YeRVyAo9Meh9zywfj2IGmkdgNO/4zZWlfvV3XG8fXqGypUXRNsq7wDauZBmZePc1MQH5a0j/afGjZioICazqczkE/qQYJ5GfMTZQBXEftPCvVIEvabV0uJGNXQlaMNOal/GGRzlMWfOHMmIL0PrRWZy3H2GJEe8ulfvIpOFDcTnd7slBPzmy6bh5cca/Tap5Qm85haRHkU68Lc6dPheqIexIa/u2ht8LV58O10kty+k2TIpKGv+JzP5gNuTt1V8MP2YkPq97jUB7fPZLJpsr0/OVtr9kAIY3DPG8fTZWGUy6cQkz9HRi7aLTquYTe4/fJGZXLYPuMoqPuRhwy9B2KRQbcxIvOBxbSdLMOsa1mybQPn3N1kX0BU= +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Patch /channels/\{channelId\}/events/\{eventId\} + + + Request + + + + + + + diff --git a/ads/api/reference/patch-channels-channel-id-integrations-channel-integration-id.api.mdx b/ads/api/reference/patch-channels-channel-id-integrations-channel-integration-id.api.mdx new file mode 100644 index 000000000000..9a9fbe91f239 --- /dev/null +++ b/ads/api/reference/patch-channels-channel-id-integrations-channel-integration-id.api.mdx @@ -0,0 +1,100 @@ +--- +id: patch-channels-channel-id-integrations-channel-integration-id +title: 'Patch /channels/{channelId}/integrations/{channelIntegrationId}' +description: 'Update a channel integration.' +sidebar_label: 'Patch /channels/{channelId}/integrations/{channelIntegrationId}' +hide_title: true +hide_table_of_contents: true +api: eJy1Vttu4zYQ/ZUBnxJAjpM+FIX7pCaL1tgCCXLpi2F0x+JY4kYiFZKyoxr698WIsiVfkmZ78ZNFDudyeM4MN0KSS6wqvTJaTMRTKdETICQZak05KO0ptcjbFyISJVosyJN1YjLbHByeStJeLRVZMEvwGW298EnFFiX6TERCY0FiIrrdqRSRsPRSKUtSTLytKBIuyahAMdkIX5ds7LxVOhVNE3047GHy76TQG35nNvNgTM7/YmTNFonRnrTnv1iWuUpat+OvjpPdDFwZTbfLFsbSmpKsV+R4XaKKnSP/merwvVftr8akOcFNPAVkK3im2sHS2LZyR3ZFduSUJDh7eIin58AFX0DsISd0HowmUA62Ff4MsgpJUvCElsBSYVYkL+ATJhkvQ4E1LDB5BvRQmM7NCZhhrXymNKAGY1PU6q8efU9FW0+h9O+kU5+JyVV0CGjE29Ng2u+itVjzZvg+xOT6RCJsCVKxWaE0emMv4Asj8udNPP0ygQGOQ9BQgtKOLyNkTboqxGQmtifF/CjlZsiXWdiN9m+xP2QWXynxopk3++eYZ+2CK412gQg/XF5+F6FQSsVbmN8NCLXE3FF0wLFeekdgvi0nnym3h/GCcqNTB94wVEc3mVhCTzL2x0EeVUHOY1HCOiP9lmhhjQ46LxGgY1pNH27hpx8vr4AblVcFQQh4MoP/Q0pDKh8FPOSrOgHwk1Yv1el6VY99J6SDLvpGwI8K4gKuK2tJ+7wGo/N6oAg4+4Aizv+ZJBT31GG37zTSE+RYIOxjv6gbWmKVe7jvNNKGYVJv+3bb3JNs1EVyo13I0QCIfvmg6XtMeaqJwXqr3IJ8Znbe2yHIvUuMsVTj1dV4G2682cVrxsOA/cYwYiMi4SiprPJ1OwUW6FQSV+x7No+EsSnXNJvzjNkaPrDYg4QH5ofXH99N2659VjmyPOnOAbUER4klD2clOrc2Vra32bYPBr7111Ms875kgnVpHIa4HXT3AW13YzYjlGT7Qfs6MjYdKdkHwFJ9prq9RG5l9/0U/fSKRZnT8SycbQnW02VHQhabXppWlcrzaXFbevWHojXE0kF8NxWRWJF1oYDVFR8pjfMFtn20S/SOLxn+zaXuATVo33/7uOpK8vTqx2WOSnOGlc3ZS+DcjFHjMq56QTkRiclQXMMsh3t7dJ9HIjPOs8vNZoGOnmzeNLz8UpGtAwVXaBUuGEt+6ynH/+VuorxZ59l9p/1zePdJeLLeLTt0zXViXvGXiMQz1XtPxvYd+J+m9KHr+Fh6e1A38yba6oGBDKbXIbfRY2iFW1dHE57rDCfiJKHSv2s77FZ38eP1byISi+5dWhjJhyyu+YGL65C3KQNPJpuwthE56rTClG2DU/59A7HBON4= +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Update a channel integration. + + + Request + + + + + + + diff --git a/ads/api/reference/patch-channels-channel-id-marker-rules-marker-rule-id.api.mdx b/ads/api/reference/patch-channels-channel-id-marker-rules-marker-rule-id.api.mdx new file mode 100644 index 000000000000..d14276d0585c --- /dev/null +++ b/ads/api/reference/patch-channels-channel-id-marker-rules-marker-rule-id.api.mdx @@ -0,0 +1,112 @@ +--- +id: patch-channels-channel-id-marker-rules-marker-rule-id +title: 'Patch /channels/{channelId}/markerRules/{markerRuleId}' +description: 'Update a marker rule.' +sidebar_label: 'Patch /channels/{channelId}/markerRules/{markerRuleId}' +hide_title: true +hide_table_of_contents: true +api: eJztV01v4zYQ/SsDnhJAXic9FIVvbjZojE0bI07aBQwDHktjixuJVEgqjtbwfy+GkizJ1qbdbg9t0Zwcajjz5s0ndyIiGxqZOamVGInHLEJHgJCieSIDJk/onQhEhgZTcmSsGM13R5cmESkn15IM6DW4mCCMUSlK+KZkiQxdLAKhMCUxEtXXSSQCYeg5l4YiMXImp0DYMKYUxWgnXJGxsHVGqo3Y74M/NnsEusd0KXGfJ/SV1helMFn3o44Klgi1cqQc/8QsS2SIjGv4yTK4XUtVZnRGxkmyXtZactMWnTuBUST5LibTjugRhuDI/7usvAReJTQhgpTMhiKQymnPi6M0S3xcWdLCNiYFCCtD+ATSAmON8oQiWBudgoul9SQGgBYQSgCQYsasVqj06hOFjlGFWpX4v8WZD1QMXjDJCRp1gBCRo9BRVIc2za0Di07adQFrbRqs4DSk6MK4FyMpXCUcZ06iNeaJq0PehfFbTC6mtlppgRgYMooo90yUxJXYpFbv4H2p0zIIVtvCsNI6IVQMwjpDmD748+NknvlvwJe61Qc+uYhVv4Or3BhSLilAq6SA5c3tbMm2SOWpGM3Fze1MLIJTrusEmESnlk/LqEkXbzoq86WhxNNMlg2nUt2S2rhYjC777Pb6enM7qz30/taRG8Hy6vF6CWfL648Pg48D/4/DjT0HbWD5fvxwfT/+5aeWROvIy7W5uHq8FoE4SPTwsj9JFD7q9gR/YDOtbJnG311cfFXx95fDGhNLwf+d4R/QGUJDXNpjd5qnDzIl6zDN6gLoTBjYooXqdkmHgsnsDn74/uISeIo6mVLFUMty42anJ317E+ptObJH/aOSz3nXFdn0gK10sVTHU/wE/H+wl/37ulfTquYc6U5UKvlOEXbIaxKwXQSL3p7YZaCadnBfNUaPhSvaN0GOC29dYTyoEsgODhvfoFnA7OBoGWMO2JOfS3K9DONJycX6oNQvozxvxBAzOXy5HNZWhruDmf2wZWe4axvaM00U5ka6wu+yK7QyHOescr4IhDYb9mC+4JWvFpxxPy+7VUv8ODPG0wk8UQFnuSXDC+c5oIrAUmjIwVmG1m61iXyc/YTwxcr6muyLncs49yoYxybuzAaV/OyJblXtYduNCSMyzb77OtBmM/C5URnATH6gwoeMp9V9s9Rev2KaJdQ/io67ebt/VbtzqyP44u2Wap23ByCc4dyh1Fr7KSAd2/az61dJWxhHFsbTiQjECxlbuv9yyVcybV2KftBWbk45M+AvZEKH3dZY/+JDqALv6NUNswSl77K5Sfyi7/NyzhQz6ksurAqRCMSo/expgeJPnUpYBCLW1rGm3W6Flh5Nst/z8XNOpijT9AWNZPrL55i0VSiqxeKLbp3dVy3jHN58tfW6WWeQKtg9HsliJEQgnqjovOr8U+3vgfRn2H8bVofa/WIf1DXCxJUiVyWWQdU3axUnix37Vd4YhyFl7k3ZduOajh+ubkQgVtXTMdURXzK45Tcobku8OjusSv5sJxJUmxw3LFsq5b/fAQtBb/E= +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Update a marker rule. + + + Request + + + + + + + diff --git a/ads/api/reference/patch-channels-channel-id-origins-origin-id.api.mdx b/ads/api/reference/patch-channels-channel-id-origins-origin-id.api.mdx new file mode 100644 index 000000000000..34d1262a2634 --- /dev/null +++ b/ads/api/reference/patch-channels-channel-id-origins-origin-id.api.mdx @@ -0,0 +1,91 @@ +--- +id: patch-channels-channel-id-origins-origin-id +title: 'Patch /channels/{channelId}/origins/{originId}' +description: 'Update an origin within a channel.' +sidebar_label: 'Patch /channels/{channelId}/origins/{originId}' +hide_title: true +hide_table_of_contents: true +api: eJzdVt9vIkcM/lesebpIS4DTtdfQJ3qXKlFzCgpJ+4CQMLuG9WV3ZjIzC6GI/73y7gIbIGkj9aXlAcGMx/5sf/6xVgn52LENbLTqqQebYCBADcbxnDUsOaSsASFOUWvKzlWkLDrMKZDzqjdaH2i4TkgHnjE5MDMIKTVfskhYDKmKlMacVE/Vt9eJipSjp4IdJaoXXEGR8nFKOareWoWVFWEfHOu52myivzdbOfCK1erynUbHlTD58ItJViIRGx1IB/mJ1mYco8Bpf/eCad1QZZ2x5AKTl38ViEMXroocdcsRJjjNCBL2NsMViDDMjDtw6gBcpKxj4zisjhX/ipyZhUTGJeS2KW2k5mfIzJIc5ITaQ8rzlBxs9UWAOgFNcwy8IA/oCDCTB4ngyPGZ8yJXvYtO53P34uLjD58+f+pcXHQjlbOurlrHdzV81oHm5AR/dXKI/RtqnpEPEoEcgyQXwQdHmNfB6MHka394NYlgcnUznERgHEyuLoeDicAjLQBGSkRUpK5uhvJ9ORyo8YkYFi57A8LD3Q1Yk2WUwHRVxm/qCB8hoUCxCIMnt+CYzuFb4QNMCRAWmHEiTwVN5YTqqcLxcQ53QVBm+p3ioDZy9JKf5YG3RvuKSh87nXcREZOE5QqzQYOSM8w8RQcs3VfmUUheLXIIKftt75hSZvTcQzAnCRs7wkBJPxzrv+ecfMDcwjIl3WA+LNFD/TAC9NKproe38NOPnS5I6wqcE1Q2TholLcV1wqU/UgpC+6YDFl3gmC0G8sAaOPido2XqW/vUz+oia1idGpMRajHLJyw+aH4qdo7xLqQncf+nWsY5fKUZFlmQ3EOnYVsX+fT/V+4nS3lftyNJf/Ri0onl+tGek42ENKtjfLItvARdxxvu6t5QIpBiLvuAlLAMwDht1SB8a4emVcXVtxozMeBcZru6ra4EQk4hNTs95RYQUtVTbbTcXnTbW8Xt9U7zpl2rbq+3ujcqUp7iomLdaK2m6DnuF6JqNI6UcXMBOxrLsN0KDqV7VT2pIX6Yt/7gGh5pBR8KT04q4KwcXJ5iRwE+WPR+aVxyJtkq+2FZoqJvn740BCvEqGEcmrh1c9T8ZxnTg4Itd4yUMCG33zKeW8bNW2XyawNo+TdaldmR3ny3XycunzG3Ge3Xgy2XmmXa2SmqCV4yuMFo1jNTri4cRJe6tYF/Z1pCP/HQH1yrSC3I+cqdRbdsAsaHHHXD8EAyDO/I6IsoNYbRP1sna48CPYe2zZB1ozQrko0kbgK9uy8jryLVa5ZUjUyOd0weRyo1PoiG9XqKnh5cttnI8VNBblVxboGOpQCrZZZ9PSDqmfiqbx/u6gI/gzd33pPubemgpdQXmBXyT0XqkVYvduJy0f13IB3Ngfcg2kV0M95EW55LvKrrLxWE1n3V0LbPj1YRcad60Y9jsuFN2WbTGfTvvwjfp/XinZtEHjlcygaPywqrKWNSNorybK0y1PMC5yJbKZXPX3vwb3A= +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Update an origin within a channel. + + + Request + + + + + + + diff --git a/ads/api/reference/patch-channels-channel-id.api.mdx b/ads/api/reference/patch-channels-channel-id.api.mdx new file mode 100644 index 000000000000..78373695fe56 --- /dev/null +++ b/ads/api/reference/patch-channels-channel-id.api.mdx @@ -0,0 +1,152 @@ +--- +id: patch-channels-channel-id +title: 'Patch /channels/{channelId}' +description: 'Update a channel.' +sidebar_label: 'Patch /channels/{channelId}' +hide_title: true +hide_table_of_contents: true +api: eJztWNtuGzcQ/ZUBnyRgFctp0tTqk3JBIrSFDTuXB8OAR8uRxJhLbshZyaqgfy+GXF0sKwH6EKBArafV7pCcc3jmQq6UplgGU7PxTg3Up1ojEyCUM3SO7DNVqBoDVsQUohpcrw4GjDQ5NhNDAfwEeEb7I41Y1MgzVSiHFamBar+OtCpUoG+NCaTVgENDhYrljCpUg5XiZS3GkYNxU7Ve32Rjivza66VYlN4xOZZHrGtrShSHTr5G8Wq1N1UdfE2BDcU0rInsq2GMxH9QmughnPfeTy3B2+EIsimg2MIdLaGJpGHiQ0IZKcwp9KaN0aShc/V+OOqCQH0Gly2sZDsnp32A2msYB8K7KLwcwCuUnocvxmm/+Cs+9unt50voBFoYp7uwSGZgHFTGWhOp9E7HAoSP4K01bgozv4AJBhhjeZecrS3yxIcKrPd3MfmVnQH2oMmaOQV5rC0uKcRn8JYm2FhO33/pyw86L6EyrmGKXVjMyIHzDJFY8NB9aZto5vSXcaZqqs2GVnif/571+69Oz86ev3zx6kX/7Ox0S4FxTFMKwoF4cT6ZROJjJPxp5gQWmVy5BJ/MDkkYbIG3mJcUQGZNzzNCDRzQ2AiB0AKbisA74JmJW9HCa+EFImPgZBEBAwHN0TbIpAGnaFxkcH6R+Ih5fPboIXF96DjffukKTT+go9oQ1z9GTY6dQ0o+NBW6XiDUOLYE2kTBCWK8leleMD4SXZ3lMizZzOkqc/h4lUxIhc5MKDK0g0C8C3O0sgkt/4B6LpEmYbITE+hGFgR0gGmlLL2HVJ3+HEm1zo60/Yn4Ws8zLDCxhXkAsP9zEIpExxiPqOOjyDvQhAK5knbJSzKjbhLGNgd4t8v3A7hdoLWl9eXdLXRGV+fw26/9U5CqIGt1wQe4rTneQsc1FQVTQh0okuOUgHPMMFZ1Ujw5AXKttnNKOeGobh7Jcb1948dfqWS1llcPK0R6EWvvYk7mz/v9f1UKUGsjn9Be7BWFCdpIxWGdCCThPuTjxCaEeUf3ogwWGKEdWQBG0fwjBiEjPhqR/9XqREyluPDOSabRjx37MiOeUQBs2FfIpmyjYTsSQuNi695+ur0k1D3v7FJUmKkDdBqa1If8DuyngtgwzA0maLspKXlzok1M+Y+crr1xfFC+0vbuwRp7bwndU9XNCcQc2c1Pznxrdqo22xbvqDqe6vZT3X6q2//jur0r0teSTvbAHSkdxV5pvTla8w/ScN4MuGwLf1pRKnVye6TzAbOc9VoiYm//hMk4lUOretN+lCUr4pnfjkvnW56pgTrB2pzMT082E52stjOtVaEilU0wvExn4DFGUw4bGXd9UygfpuLJ9Y0cVDeGV9J35G5iz/xwu4cXo1S+O02kICmgm+pfpDIQQ6fGGBc+6LQrqZNJNUzm26WGGXMtomrdOFziPEzRmb/zPj9M5umALhmWwu6Ift/zYdrLO5kXwNpIPyLUS1d1uTuKv7vHqrZ07Gi9kchBne0fVoz+duHtgOMZrn88MfT3o2lPsVLc3MSn6wTD4qM6r9l8NrSAoY4wvBipQs0pxEzT/DSnnsgVpsax9epCZALfk8UDqvd60aM3KS2dTPd8Uls0qQtpgk33FEmF18K1uHUqkbJRbaEGO1XfFGrmI4vtaiWoPwW7Xsvrbw2FZVbkHIORgMs3NrlD0tte97tOdzbdYRd+eLFzFMhGLG4pANA28k8V6i6pYQdgfbMuNqIT9/L3N9mJ3keZZTf+UUe/LjYjhmVJNf/Qdj/cL4Yf33xQhRq3N0iV1zIo4EKuonCRnfWJlRS16d1KWXTTBqdimyeV3z8csat4 +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Update a channel. + + + Request + + + + + + + diff --git a/ads/api/reference/patch-origins-origin-id.api.mdx b/ads/api/reference/patch-origins-origin-id.api.mdx new file mode 100644 index 000000000000..b6c84c3590e7 --- /dev/null +++ b/ads/api/reference/patch-origins-origin-id.api.mdx @@ -0,0 +1,88 @@ +--- +id: patch-origins-origin-id +title: 'Patch /origins/{originId}' +description: 'Update an origin.' +sidebar_label: 'Patch /origins/{originId}' +hide_title: true +hide_table_of_contents: true +api: eJzdVt9v4kYQ/ldG+3SRTIDTtdfQJ3qXKlFzCgpJ+4CQGOzBnou9u9ldQzjE/16NbcABGqmPbR6ixDs/vp35vtnZqIR87NgGNloN1JNNMBCgBuM4ZX2pImXRYUGBnFeDyebI4TYhHXjB5MAsIGTUcmQxsBgyFSmNBamBqg9vExUpRy8lO0rUILiSIuXjjApUg40Kayu2PjjWqdpup7Ux+fCbSdZiERsdSAf5E63NOUaB0/3uBdOmFco6Y8kFJi//1SCOr3BTFqg7jjDBeU6QsLc5rkGMYWHc0aWOwEXKOjaOw/o08O/IuVlKZVxCDlYcMtZVuDhDrSn/FXKzIgcFofaQcZqRg128CFAnoCnFwEvygI4Ac3FIBEeBr1yUhRpc9Xqf+1dXH3/69PlT7+qqH6mCdX3UOT1r4LMOlJIT/PWXY+zfUPOCfJAKFBikuQg+OMKiKcYAZl+H45tZBLObu/EsAuNgdnM9Hs0EHmkBMFFioiJ1czeW39fjkZqeqWHp8ncgPD3cgTV5TgnM11X95o7wGRIKFIsxeHJLjukSvpU+wJwAYYk5J+IqaOpLqIEqHZ/2cF8EZebfKQ5qK5/e8rP64K3RvqbSx17vXxERk4TlCPNRi5ILzD1FRyxtyHGbnJbkVG2NMYSMfdMYmFNudOohmLOEjR1hoGQYTuM/ckE+YGFhlZFuMR9W6KFxjAC9TIjb8T388nOvDzIyAhcEdY6zSUmLuM5c6a+MgtC+fQGLLnDMFgN5YA0c/P6iVes7h9YvGpG1ss6NyQm1pOUzGZ80v5T7i/G+pGdx/6dGxiV8pQWWeZDeQ6+VW5fF/P8n97NSPuh2Iu2PWnqqMzdOB062GtJWx/TsWHgLuqk3PDSzoUIgYq7mgEhYHsA469RF9J3WAxgwlRdV3ddHkq+gkJm9U/X2hkwNVBctd5f9bhOlu9mF2apIeYrLmk2TjZqj53hYitdkGinjUgExmcojujMcy1SqZ03L/Lgfw9EtPNMaPpSenDD7onqQPMWOAnyw6P3KuORCulDNuUp6Eu/QliwEKw1vYBynuHcpav5R1epIiNXukBEm5A7bw2vHuLRTNbVJgJb/oHVVdZm5D4c14foVC5vT4dnfcaQtv94+UEPcipktprJemGol4SCx1L0N/CfTCoaJh+HoVkVqSc7X11n2K3EbHwrUrcQjaSacb96bgrTek7ObWIM10Gvo2hxZt8RUM2UiFRFQfRU1y5ZXkRrsaTeNVGZ8EMvNZo6enly+3crnl5LcumbNEh2LNOp9j30zupvX6h8hf3hopHcB762FZ2+x66cWDS4xL+U/FalnWrfXxu10G+1oIeDq4y81hM5jreud+8mLvI12HsM4JhvetW3LcTR8/CL0mDf7Z2EScXK4kkUWVzVWU9Wk0lX1baNy1GmJqdjWQeXnb2oM6YM= +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Update an origin. + + + Request + + + + + + + diff --git a/ads/api/reference/patch-templates-template-id.api.mdx b/ads/api/reference/patch-templates-template-id.api.mdx new file mode 100644 index 000000000000..a177fb0c9a04 --- /dev/null +++ b/ads/api/reference/patch-templates-template-id.api.mdx @@ -0,0 +1,7594 @@ +--- +id: patch-templates-template-id +title: 'Patch /templates/{templateId}' +description: 'Update a template. Backdrop is required for non-SINGLE layouts.' +sidebar_label: 'Patch /templates/{templateId}' +hide_title: true +hide_table_of_contents: true +api: eJztXV1vG7e2/SuEnhxAcuKLg4sD98ltc3uMmzZBmrQPQXBNaSiJ9Qw5ITl21CD//WJvcj40GsdyHDeytPpQxBrOzCa5PxbXIqVPo0z5mdNl0NaMTkdvy0wGJaQIqihzGdSx+FHOLjNnS6G9cOpDpZ3KxNw6YayZ/H7+2y8vnotcrmwV/PFoPCqlk4UKyvnR6btPvcefZ8oEPdfKCTsXYana94zGI01NShmWo/HIyEKNTkf15fNsNB7Vbx+dBlep8cjPlqqQo9NPo7AqqbUPTpvF6PPn97Gx8uFHm62oxcyaoEygf8qyzPVMkklP//Jk16fOo0pnS+WCVp5vW0pjVH6e8V83dcbXvUnNvQhL7Zu+0cjl2lyqTATLHQ2q4AcW2rxQZhGWo9OTcb8XzQfSObmiv6kTzuYDtrzkf8hclLlcTeXsUtRtearItqlT8nIsfDVbCumFv9SlkCYT3siS75iqpbzS1vEsro0CtX05n3sVNt/8W1VM43R6NbMm8/yyK62ulRNF5YO4lmG2FFM1t061loipmtlCRUNKOc3VsfhVG11UhXhGJhTxj9Hps2YgDL+LRqI2etOeP5cqLJXrWqG9kHlur3n8hVfqUtgr1RmVY/HnUhmhDJmRjYWs76S22ix6zWMkhMqZ+ES64IN0oXaD2IoGl6bDCx2ENmJe5fkPwpqZWn9UZo0atxPnlK9oXGTgZtbphaaZZbtL6zV1NFm8ZqgX2iRr0lyHpVoJ6ZSQubd3Mblj8VjIeVBOXC/1bHmjlZmayyoP6WNRWm2COIp/Rc8Zi64fiqxyHIHimvphbBBehSepW/Rn6ZRXJozvNpGjxlem1uZKmtHnNo7s9C81C+Q+9ds33efn1JGeldo07s3pQ2XR8JlTMpCHyHTH3NliPfqPRR2cd3FwdaVM2DbtcOOHSjoxE/et+E9VSDNxSmYUMyLTnv2GGjcZp5vbN17T9Y2BfMafd4c95bOcBvt6qZwSKaUP+CQ7bD+6N5yqP8VeVF5llBvpavJky4YMhxv7Xj3x1zosm6R73CTVJqdsPJNeqBfGUjmluOv4eQp1iqHaqmDT3XdxoivptExFz6xezrkiW6PSv9aTvPRehQF/O+PPeZRT4Wc/S88+FmdB5Er6IKxRXYyw5nM3vfQLgVjPS/JxNq/jEOMYgJfGXpu7jInO4rs4zEeno2fpvwn/71/0v3/Xf9b/jcZ9mGT0h0oJvQFnopXkC9p0PfCVs1c6U5mYriJQqHywBd3nhKyCnSyUUU6G6H9SvH17/nPsoC10CHE0bwlcbYJycjY8nA1A6LRqKn4TsWx+ixGkmOV6djkJS2erxVK8ff1iExxwkzexxeZ7f+o/QNhSmTp9dnN7ssvHSGJrsmPxKyGIKSHSK5nrrDZhbl0hafoqpzezy1DKL1Sm5Rv+tG/jr3RJ0B00jdLEYTgVFzRl9oLm6EIXcqEu6NXKkGu9G/FF8nG6Mno/MCGFLtQNbzz/9XnzwtZv2EZxRLOhPsqizFWy4WlR/uviybrLn1EljLmKY9NRjsgIeRfaKFGVc2dNoFsYD+kgZtLE6s4BzK/8QVi6eq29ohZLSn5WBLcai0Iy9ImWlU4RsGev8VSB3WBSD4O95QwSu5tpulBoI4N1x+LCBxn07OJUSJFpp2ahyepOzZVTBJZab4zjY53gMa99oZ6Q+KzBmSAvWUuCX/af8ac2c607e5BuoajgfyHCMnWlCePVTUVYSoI3uWLvjn6vvXj7+rxO75tRFR8y7D0/pxfQgPKTlAlulV7om1oV61IZM48XXl0pJ/M6cftx13Vq6xhxGiUKwuzR9iZCo0ndEc+Uvwy2pAGkKhcoR9mpzhV9cjUwE0OBeSXzaqCTb5qooHFqyk7s6lqIdPzij7Pf34ggF+QaT25NmZ+7S8p3yZD3Q7lDm/PoDyd9fPS+Xxpe2Nla3YpeWacUpTkYpfDaLHJ2YRHNYXxMuYeeSzfTJeqtVl4oOVvGvGhv8rLjjf60GS8ZHeNgoIOoyqjKqMqoynVVvpI+cE3u5tNun5zyNr9SbNZcEb1DKxinTJYWXnFdfLVWLeipqM6ozt+zOjcm5KlMP5aSzIP9qsOtfxrJLNPxza/Wo6AfXzdEgsxES9aLkt5ALESsCYkjvFImo0GgqhMfKApZHov/aWd4zNP/i7U0eGeZ+FUauYhpwCtmH+lBFzJ7IxdtBy46mWorXg7AA8ADwGPfgQenG4Ye8Z+TgrNJVkcSE7/kvH9odS3iRZ8UiFxfKbdqudSYurptZCYyNdNeW8PpuTN73PhL6KRNEWUuZ2pp80y5jUzwR50vU2mMmXIzOZY2dSkalsBGWJV6JvN8JSrD00rySoRS1nDHKsNscGavjQ9OyeKHWnrhmZKiY9wWOSJ1e3OKsnr4nPKlNV4TyU+O2Bk/NqgZdgqVtlwwZ/5T5ZwyIV8Ja/KVuFjI4kIcbQzGk+5ELGQxOAvxyd+kAMY5mvhSzfRcz7pFcKPO/UFZhvNwqVzq3g88ELE3UlzQ2y7EXKs8W5PIj2a97pc2u3gyUPZuxwhpmgZGYRM5vP8yImpzZX/O/4jIM2n5m0wdoyMOTZIFJ37mlDK16qWjMMNilAnaNUmI0nlpXVgj6vhRg9P8VQh+U5P4Coxd6tnlVghbnNUP4NJEY9Waolmo8jpTLOvUwZks6hsgPlQy1/OVOCqqPGhK8HU0M/ZsPm1u6C5blPCktpHERnP6ZJz04ozLZxJsGwk4U3NNhZYCOFP+tNv3yqcEOdfOh7Z7S+s56gsZ1gqGNQm1sIM3FhzuOqkXwinExrWmti2+v7P6No7LkFJyxmGkJMXMFqU0XDFiHt5KoZN5fotACHAOcA5wfrjgHFod2MD9YgOh1aEqoyqjKj/mqgytDtV5P6sztDpodQAeAB4AHrsJPKDVQauDVndPrW7jwGlN3g/k43Vevz5zRQGXW7Mg0SmmFKcLScHFrY7YCacrcZHZapqrC3aFi9wvZan+T2YXDYzl/oL8R7VHtUe1B/kPemG/6QWQ/6jKqMqoyo+5KoP8R3Xez+oM8h/kP4AHgAeAx24CD5D/IP9B/t+P/O89r6X+/7lTPUkTOGVUlanJdDVhHSE1j2HMCCrVcS/8kvx9+KxBxOg6xgp9/9nC2cpkVLB0ivbua9ZAMFuCQ0E4FLQvazIcCsJCAAsBLAT2eiEAXRDM434xj9AFUZVRlVGVH3NVhi6I6ryf1Rm6IHRBAA8ADwCP3QQe0AWhC0IXxKEgVHtUe1T7Pa/2IP9BL+wXvQDyH1UZVRlV+TFXZZD/qM77WZ1B/oP8B/AA8ADw2E3gAfIf5D/I/0d/KKiVAU4pgb6Y8N/Z+qGgFJF2NqtKnSL0xWROfTsWz9sTQ8tYerY7J5QSaO+NXQ9rbMNJIZwU2peF2vc6KbTlKSDIf8D7wPvA+5D/QDDuN8EI+Q9VGVUZVfkxV2XIf6jO+1mdIf9B/gPwAPAA8NhN4AH5D/If5L97nv15SEUv0XO3yXrkFA2VNyjwbQpyqTlUOahy+7J+enBVLn6TZgKX9kq5XK4gyQGDA4MDg0OSA+kH0g+SHKoyqjKq8iOvypDkUJ33szpDkoMkB+AB4AHgsZvAA5IcJDlIcrsoySW+P8am9pXMawkg6QKkx9iypT3IOxtxitO5q0pG3JR06BBdd97Tswbn3pZypsNqoIolA1KDOH3ztpyFa6WMeCaO5hUFVXDS+FLSpDxh5z2pr9hSfqhUxKTyY0QLJ7cgh9J6fUNxTWbVLboAgMpbaV04Fq/jnHuK8VZAoeGjUXRiakOwBduZLuRqHuiK04tl2Ky88YYB6KR9kESkpqmppy29QGULJebOFhGgxA9T09ra8Y1Dy8N4p3GjXmxvJPd53cQ4DA9nIA/v9hZy856J8bMHtJHWdVtbSA61bl8nUL+9dUNwy+u/B5BAHSh0lV5fv9z3jdt09qUanqX6kfF6r0+9p6ZG43vNxLXOwgDQre3gy7eYwW3uY0WvgkSTxvUYDa2ZscUBWxweIR91yxaHTlFOKeeGryu+dV8CzieD/QD7AfYDmyEgt0BuwWYIVGVUZVTlg6zK2AyB6ryf1RmbIbAZAsADwAPAYzeBBzZDYDMENkPs4maIiI44NGkDwcTPHCl3EcbOdZ7XeJRqoGuSUFfObIg6fhTOIUOk25d10vf6duBxXIaUkjMOI6WNL/LeUqGTeZ5W39DqAM4BzgHOodWBDdxvNhBaHaoyqjKq8mOuytDqUJ33szpDq4NWB+AB4AHgsZvAA1odtDpodffU6vrYof0x0c183PuBzkz7JAvI3JoFiU4xpThdSAoubnXETjhdiYvMVtNcXbArdH5AtIGx3F+Q/6j2qPao9iD/QS/sN70A8h9VGVUZVfkxV2WQ/6jO+1mdQf6D/AfwAPAA8NhN4AHyH+Q/yP/7kf+957XU/z93qidpAqeMqjI1ma4mrCOs/eAgI6hUx+ufRBs+axAxuo6xQt93unC2MhkVLJ2ivfuaNRDMluBQEA4F7cuaDIeCsBDAQgALgb1eCEAXBPO4X8wjdEFUZVRlVOXHXJWhC6I672d1hi4IXRDAA8ADwGM3gQd0QeiC0AVxKAjVHtUe1X7Pqz3If9AL+0UvgPxHVUZVRlV+zFUZ5D+q835WZ5D/IP8BPAA8ADx2E3iA/Af5D/L/0R8KamWAU0qgLyb8d7Z+KChFpJ3NqlKnCH0xmVPfjsXz9sTQMpae7c4JpQTae2PXwxrbcFIIJ4X2ZaH2vU4KbXkKCPIf8D7wPvA+5D8QjPtNMEL+Q1VGVUZVfsxVGfIfqvN+VmfIf5D/ADwAPAA8dhN4QP6D/Af5755nfx5S0Uv03G2yHjlFQ+UNCnybglxqDlUOqty+rJ8eXJWL36SZwKW9Ui6XK0hywODA4MDgkORA+oH0gySHqoyqjKr8yKsyJDlU5/2szpDkIMkBeAB4AHjsJvCAJAdJDpLcLkpyie+Psal9JfNaAki6AOkxtmxpD/LORpzidO6qkhE3JR06RNed9/Sswbm3pZzpsBqoYsmA1CBO37wtZ+FaKSOeiaN5RUEVnDS+lDQpT9h5T+ortpQfKhUxqfwY0cLJLcihtF7fUFyTWXWLLgCg8lZaF47F6zjnnmK8FVBo+GgUnZjaEGzBdqYLuZoHuuL0Yhk2K2+8YQA6aR8kEalpauppSy9Q2UKJubNFBCjxw9S0tnZ849DyMN5p3KgX2xvJfV43MQ7DwxnIw7u9hdy8Z2L87AFtpHXd1haSQ63b1wnUb2/dENzy+u8BJFAHCl2l19cv933jNp19qYZnqX5kvN7rU++pqdH4XjNxrbMwAHRrO/jyLWZwm/tY0asg0aRxPUZDa2ZsccAWh0fIR92yxaFTlFPKuTM+2mCMzmpeKA5Q85uFBHNFrj2n+cZvOMM2HvE14zXU67VuB1cp/oCBeZz//3r2jNfeaVMTYeOyzHWkuJ7+5SNK8bOlKuTNyHkuc6821vNLaYzKz7OBfSHnDeHRZOzU3EdXC6ogp+V9Ibk2l0Qw2bWNITesGVu4Sn1yNv8C4E9m35DFarAp6gc17AZPaMtu+Etdcub1RpZ8R82HbMYbtX05n3s1UIF+46RM45Goqe4sF8RfXNP0i6ma20SORdeaqpktVDSkpAi5C49VG71pz59pxd8lV7yQRBfwdAiv1CVjhS5DxVlBGTIjGzPk5zupLTnuevO47gmVM/GJSfd0DQSKrWhwaTo8JTltBGHvH4QlxLL2qMwaNW4nzilfFREnx8SrF5pmlu2uA77JYx1DPS07bHeumywtc2/vYnLH4rGQ86BcivKbrEz1JX0sSqtNEEfxr+g5nELaN9XUZyR1jCVNIjxJ3aI/S6e8osxzp4lsl5tTa3MlzTA+Y5JBZWcD/vxGF8oHWZQtR9eE9bX0It0a8aMR57+/FP/+72cngpbNQRcqracHCaIv8L1p/HqD0xK+HMZ8tTGhxredxHOXEFJXyoRt8xw3/nZZrqahB1jl9umNFVswO0YWA1jgP1UhzcQpmVFg11++L6hxkxaboRuasK4DD0BH/rw7SSnp5pQzInlX7+/ZDByOqn4K2vD8vkNEiY6cjxdeMdwsGzKcEzhAarzD5HJdGY6bzN8kvo1n0gv1wliGnTXT2D4+BXptVbDp7rv4YQIT65Jou4HyDrX7H/qWlTtYBIHnwQSerwFHUH+g/uyO+rP7m0HvkOnWGJaviU1sVDnkjSq7s41UZ6PxnTauAA4ADgAOAA4czi5UwALAgoPYv/qQWAA7XIF4gHiAeA4Z8WD7K7a/Hvj215sgRrMHNua477gTNuIsjlLSgyd+5mjbVgTEcx3FLtYITdCuyUfdvWwNS8mPuv1LaL7JQgHbt7B9a6e3b32TFcSd5c5xXAqVktMWw62N33/ZUhKVeX4fuRZrA6wNsDbA2gDiKFhQsKAQRwEHAAcABwAHII4CFgAWQByFOArEA8QDxHOgiAfiKMRRiKPfThy92zHwWhAZyNvrWkl9qpACM7dmQSpfTD1OF5KCkFsdsbNOV+Iis9U0VxfsMvUvf8jsokHLPC4QVIAngCeAJyCogDkBcwJBBYIK4ADgAOAABBXAAsACCCoQVCCoAPEA8QDxQFCBoAJB5TsIKr1Ht4rJP3c0LUkpp4zPMjWZriYsv6z9ZDpjsVTv6x91Hj72EtG+jmFDX4y4cLYyGdUunQK/+5o1OM2W4GQbTrYdxNIPJ9vAvGIdgnUI1iEQYsG4gnGFEAs4ADgAOAA4ACEWsACwAEIshFggHiAeIB4gHgixEGIhxOJkG062AU8ATwBPQFABcwLmBIIKBBXAAcABwAEIKoAFgAUQVCCoQFAB4gHiAeKBoAJBBYLKQZ9sa9WTU8qlLyb8d7Z+si0Fp53NqlKnYH0xmVPfjsXz9tjbMlah7Q67pVzae2PX2RrbcNwNx90OYj24k8fdtjzKBr0Vyw0sN7DcgN4KYvW7F9K9I1ahtwIOAA4ADhwwHIDeClgAWAC9FXorEA8QDxDPASAe6K3QW6G3frsDbA8poSZu8jYdlfyj4TEHFdVNBTQ1hwwKGfQglmnfVwaN39yb4Ku9Ui6XK2igWAJgCYAlADRQkJ2PpYruHdkJDRRwAHAAcOCA4QA0UMACwAJooNBAgXiAeIB4DgDxQAOFBgoNdMc10CSTxDDVvpJ5rZwkOYU0Llu2zA05aiP4cWZ3VcnYnfIPHRPtukB61qAb2FLOdFhtmvwyGZAaxJmct5UtXCtlxDNxNK8ovoKTxpeS5ucJ+/FJfcWW8kOlIrqVHyOqOLkFYZTW668pwsnm+vYuiqAyWFoXjsXr6BueckErStHY0hA7MbUh2II7kS7kah7oitOLZdis0PGGAfylfZBEMad5q+c0vUBlCyXmzhYR5cQPU9Pa2vGN485jfKdBpV5sbyT3ed3EOAwPZyAP7/YWcvOeifGzB7SRlo9bW0gOtW5fJ4q/vXVDsMzrv9VXRhHdSrbVlvm+5ZuRsFTDU1g/Ml7vdbj31NRofK9putZZGEDLtR18+RYzuM19rOiVoWjSuB6joXU7dqNgN8q+EWa37Ebp1PqUrG747vT77RLB2X3QNqBtQNs8EtoG+1YgUEGgwr4VwAHAAcCBg4cD2LcCWABYgH0r2LcCxAPEA8RzAIgH+1awbwX7VnZ830rEWRyltNdj4meOpNIIiOc6z2tkS7XSNfmoqx83LCU/Cmf0oYoexHJsJ7+qfByXQqXktMVwa+P3CLaURGWeJ+4A4ijWBlgbYG0AcRQs6Hcvu3vHgkIcBRwAHAAcOGA4AHEUsACwAOIoxFEgHiAeIJ4DQDwQRyGOQhz9duLonQBI+zvTm3m799vNmfZJapG5NQtS+WLqcbqQFITc6oiddboSF5mtprm6YJfp/LZ0g5Z5XCCoAE8ATwBPQFABcwLmBIIKBBXAAcABwAEIKoAFgAUQVCCoQFAB4gHiAeKBoAJBBYLKdxBUeo9uFZN/7mhaklJOGZ9lajJdTVh+WftFWcZiqd7Xv1w5fOwlon0dw4a+X3nhbGUyql06BX73NWtwmi3ByTacbDuIpR9OtoF5xToE6xCsQyDEgnEF4wohFnAAcABwAHAAQixgAWABhFgIsUA8QDxAPEA8EGIhxEKIxck2nGwDngCeAJ6AoALmBMwJBBUIKoADgAOAAxBUAAsACyCoQFCBoALEA8QDxANBBYIKBJWDPtnWqienlEtfTPjvbP1kWwpOO5tVpU7B+mIyp74di+ftsbdlrELbHXZLubT3xq6zNbbhuBuOux3EenAnj7tteZQNeiuWG1huYLkBvRXE6ncvpHtHrEJvBRwAHAAcOGA4AL0VsACwAHor9FYgHiAeIJ4DQDzQW6G3Qm/9dgfYHlJCTdzkbToq+UfDYw4qqpsKaGoOGRQy6EEs076vDBq/uTfBV3ulXC5X0ECxBMASAEsAaKAgOx9LFd07shMaKOAA4ADgwAHDAWiggAWABdBAoYEC8QDxAPEcAOKBBgoNFBrojmugSSaJYap9JfNaOUlyCmlctmyZG3LURvDjzO6qkrE75R86Jtp1gfSsQTewpZzpsNo0+WUyIDWIMzlvK1u4VsqIZ+JoXlF8BSeNLyXNzxP245P6ii3lh0pFdCs/RlRxcgvCKK3XX1OEk8317V0UQWWwtC4ci9fRNzzlglaUorGlIXZiakOwBXciXcjVPNAVpxfLsFmh4w0D+Ev7IIliTvNWz2l6gcoWSsydLSLKiR+mprW14xvHncf4ToNKvdjeSO7zuolxGB7OQB7e7S3k5j0T42cPaCMtH7e2kBxq3b5OFH9764Zgmdd/q6+MIrqVbKst833LNyNhqYansH5kvN7rcO+pqdH4XtN0rbMwgJZrO/jyLWZwm/tY0StD0aRxPUZD63bsRsFulH0jzG7ZjdKp9SlZ3Rl2bVBaZzVxFQeo+d1ZAtIi154LROM3nJsbj/ia8dok5vjRo3GEnrzeUNnZUMx/3gDTP0cvF6/jOkHx08lxeM1yntF6iWyZBFWQdynf/Os844laeDLiTX2Z3lqosLTNrTToktLj6Kks9dOrk6fNs55+ah/2mWZEzSrH+PDdp9FUej07q+jOd+/HI+sWZM679zQDdcPfZ0tVJFjUNt9YDr06F5dqxV9K74wsVMSMXs0cfVU98WrX1mUMGj0/cXQan9ei/WUIJSPYaMZGqncLafTfcaXXsky84YiuL5WM6016/eh09HFi3WLCE1a7V6n/V614/P/y1hBsVD78aLPV80geMDuzlMao/DzzcY8Ah8H78Yj2GTib80D4S12+nM+9ClwmvJElQfTRaXCVWmPwno1H6kqZsPG4ZGT6gNzNV4XqPLT2uc4GrXef1p9MtN22XF2PCFvnoLoUTMv6NIRNS8u09jZpgvdQJA6gq3zsmqUs6gzYuckp9ydwF4zvrmz7/EpNUTAzMMgDfKaAbhjAmEtHPXTSLV9NmeB0ps3cMmmgA4XIqCGXzjIvzl6d8zudj1F6dZKWe6GQPATJ0V9RnhI356W1WP80qrf4no7elsQuCCnq9sfiRzm7zJwt18gEAkbGmsnv57/98uJ5Wpj7DpkQ1MfwtMylNpGzyuk9MW2+o9RA3Tih5k2eHY9OO5n4/Xi0tD5Q60+fptKrty7//Jk+/lApt4oplKN2SsNEwao9/TsbBnndTh6lJWz2RJxv8OdNx2/qS53ezGrUqFmj0Xh0qVbctukCF96UJ8nA2OCnaMYkkSn1A2RZ5joqSE8pXXK0xDvOZjNVhi+27daoV2dvfvrPaDya2ox5icJmdJOT15T45HW0NmpMnF/5s0+jXJpFRVzx6Sg+lP77f8EWi3g= +sidebar_class_name: 'patch api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Update a template. Backdrop is required for non-SINGLE layouts. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-breaks-break-id-punch.api.mdx b/ads/api/reference/post-channels-channel-id-breaks-break-id-punch.api.mdx new file mode 100644 index 000000000000..74fdca6a9df3 --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-breaks-break-id-punch.api.mdx @@ -0,0 +1,4004 @@ +--- +id: post-channels-channel-id-breaks-break-id-punch +title: 'Post /channels/{channelId}/breaks/{breakId}/punch' +description: 'schedule a CUED break, transitioning it to READY. Accepts an optional startDate (ISO 8601); defaults to now. Past dates are clamped to now.' +sidebar_label: 'Post /channels/{channelId}/breaks/{breakId}/punch' +hide_title: true +hide_table_of_contents: true +api: eJztXe9z2zbS/lcwnPeDNS+lyG7apuqHjFvn+nouaTxO0ps7x/cKIlcSapJgANCK6uR/v9kFSFESXduJc0mjzQfHJkFgAeyPZ/chpKsoBZsYVTqli2gU2WQOaZWBkOLnV0+OxMSAvIiFM7KwCtuoYiaUE06L0yeHR/8ciMMkgdJZIQuhqReZCeukcUfSgdg7fvFcPPpuuN/7UaQwlVXmLD5c6MVAnEjrRCodWCENiCSTeQlpfTuKo1IamYMDY6PR2dWGqMcpFE5NFRihp8LNQSRzWRSQ4ZMKW5TSzaM4KmQO0SgKd4/TKI4MvKmUgTQaOVNBTNPOZTS6ityyxMbWGVXMovfv45uHpTW6ZlC6d8chz31jsO4nnS6xRaILB4XDX2VZZiqRKMyD3y1KdNXqqjS6BOMUWLqO24C/rM/g+do2CadyEFNtVnOJhaT9rPeO9oiaeRkH4mh9K3+kTqxQBXVS4r527+hUm1y6aBRhl318irbZOTAo2r/3Ho/2Ho9ev05fv07PDh5+9+j8bPjw0fm7cGX/m2+//+H87OC7+srwDO+eDVdNh8N3rWbDYa8/POgf/IDtrx6+7/sBhtTk0fm7/bPhwXmv7y/1fzh/d7Z/cP76dfrum7Ph/nnvHd14+N0P5+/29zubDX2bg/bNfbxzcDbsPzrv9Xov/ZDYX339m/Pe6GzY/xYv7D0etX9//Xrw+nX6v73Hvcd7j0f/6vX+J4q3lbK+oie/Q+Ki93hpXcHogi11Yb0uHAyHd9IkmabKq8lJS6emMrMQb6jZyrC2VO1aGxVurqzXNjGBTBcz1CXUkFwVT6GYuXk02t+aeUwTMDqzN8p4jc6XmVxOZHIh6o42Vd9WyRz1316oUsgiFbaQJT0xgbm8VNqQZ1o3tAtVPp9OLXRY269VPvHTt5DoIrU02KWCBRiRV9aJhXTJXExgqg2sJBETSDQaFXZeykkGA/FMFSqvcjEMC4V/RKNhs0wFjYXLVAu9Lc8/5uDmYNpSKCtklumFt1QLcCH0JbRWZSD+MYdCQIFipLGQ9ZPYFiPCenPs0ICrTOF7xBve17Q9Ji0ubofFgKIKMa2y7EehiwTWu0p1AfFq4wzYCtdFOmqmjZop8mYod6l9mAoSrwmK/ilIU4e1OSzJUcnM6ruI3JI4FnLqwIjFXCXza6UMsS9cFqVWhRN7/i+vObFo66FIK0OmKRY4j0I7YcH1wrTwz9KAhcLFd9vIlTOZaJ2BLLq8SRwlBqSD9LBDn1+ip3cyL71kK4kX0orw3I0BZNunxVE94+0hf1pfEVXUpnQXiwBjtHkG1soZbA/xf1Uui74BmaKKCwPS6vbkoHBgIBVPTk+fn6JmuMoOxInfA6GLbOmXw9/BjaCWnROFSyjc7bwlNe32lbFQUyGLZecQqqP3V4V6U4FQ3fhFLJSbh/jdwlE3eONcmgswR+AgwVG6JvU3bYSsnO6n1ApSP571irstje9SpHWfwkCiTSrcXKLS67RKUL2bJRmIwwltAvpx33WthuJSSerz8OS4c5n8WKdVBvcouUH4TNLm6Ngh9VGkwnBLkoNwkJeZdPAxsnu/d53cobN18adG50KiDYLMg7jXTcZ3LxZzbdFdZRm6+aan1XQ/Zgpt99cBU+l6y9rrkE2iLOaAANPDmQ63Sz55M4Bt+c0NX6usqCxumA/SwVlrEqQ7opB7lS0TanDFoMENTdjc6hMHVLNCm6AkLVceohmGiVoqp8PTdwICdQ4gi+XzKaVRjMHvAYPHV3+27ueb+PNFyKvTDlQxEM8LsZBZlmQagan3vn8aQBEmiZOXL1qN6U8//ppNJlXjuIRcSOXQemQr9xsENXGV3TbCp2oKyTLJoI5selqr+0iMT06fnByeHv/6y1jsNX3DW1QkAmSuKnuxGGMlYSz2SgP9FBJllUaUNVmKX7SeZSCODo/jbtnwaaozjMUeZGqmMDjjrFLI1CWYJTZ4cfzLr4dPaYhw2RsLOgUwtkfIakzxeCz2plJlkPbQcKDA3TuLmmlEcYSyRnFEg0ZxVPcdxRF1EJ13+LHand8uptet22G9hZ3ISzfBXRx6J9BXBVmqMDAFAx4jS/IN6NQuoPSeclkk3g2thZku53spjZLFhmvQBYTf7pD/SWvBdejOIV3325CGNEtZEQYeiEMnMsBSgS7Apww+gaVSioOcuvwgia6Hkke1qw+bQbK3YkzsYdxFoRfFXdxsDbgI5UejaBj+9enHQ/zxqP6z/hdtOolrEZqXsoXQgt84MfpSpd6WCLhV1ukcnwvIZQYFGNIqBOTi1avjIz9BnSvn/FLfAPEUIl+Z1Mv5ITl3q4smiW7SbprbKu2WIslUctF3c6Or2Vy8On26nW9Tk5e+xfYe/7zZgdAloMdpEpY6XQpy2ZXJyHQgnmFSPsES6KXMVFqL0ITNyqjb1GTiKIdUyZd0dVPGZ3hL4BPkUQu/DCMxxv3UY/JYKpczGLcdFd1E68A7na4oVzlcM+LxsyfNgCulIhnFHu4GvJV5mUGQ4UFePhz31u3hEJNLj428c0U3i6DQ5KoAUZVTowuHj1CJQTmRyMInzGT6NOSPQuPdhbKALeaSqojOLGORS6omeMlKA1j/Ja2xmNSaTj/mOmdLvsdPN1V4I1eFdNoMxBgDmUrGIyFFqgwkrkGRK9+60ka/PtoIWvNaF+oN8X117gRqSTfs6tSf+Grl8+7g6Zw0M8Cw+aG2mcKlwmBS9+PDioUMyC68xSgrXp0e10B02x59J916dxQGwK2gnqBwZhkGtA2q9nGw9A7NCguXYGRWB4uQcwWlq6WjPKUAn2d52Rvb9iK19yoFe+F0iUuPeNyh69MTlSH6dZcde9hl0pcyqzom+bKxJ1ynJtT5qa4ZV0ujfjt88VI4OUOl6t3oidcqvGdBkPMur6OKY69Jq06kMXLZAUuf6mQtHHp9rp0RKDJjKawqEKehK/XiEKRCr4X94sN4C2erwAqQydx7VH2dlg225qOQI1k5zCC5N6OOWTIcYDjAcIDhwMfDgUtpHYGBtjtuz8mA1dklkFhTQKoGSzUGijRUmChxU5drwQZ7ZVjAsOCvCQsaEbKAD74eLEDbcdJ6r+S6p7fey7jWVmQqVi+q4MsPVKwN8SZwiZdQpLhM1tffUStzWQ7E31Y6EJOChJLYYSqeyULOvIuxQCwldjSW6Us5W01g3PKCq81mxMOIhxEPI55uxEO+iDCP/7Wfk6tJazMjag2V9zcFC+Fv2vAagy+7r9gq79fabWQq6ip/oPqb3aPGfwaLVv6jzGQCc52lYLbcxG+1Mw2R1bvRbc9Z6jAlL1jAKm5ZqkRm2VJUBW0rvqPhMZwuaGJVQXxbqheF50rX312UoiXcLRxImPb2FqX18oU3tVrsRrN+JFCz7MS+XLamPxA/V8ZA4bKlfwthPJP5WOxtLcYa4TGTeecu+J7vJTr6PerbEhI1VUk7Qm4Fwd/Qy5CTLsGE6f1IC+FnI8UYRxuLqYIsbVMFYi/ZmH6p03GvIybeEmKEvYqDj9takG34cf7n2GrlNje3/zePYUUml7py22VKwllkpfiaUd8mBqAIgHiqPAtO74gUTpnGH6FnL7Vxa1VK6qqburr3RGGb5/kAKF+q5OJWQF4c1h1QCMOFXImi6JUBq1JiBGVtxEGiTQHEm0pmaroUe3mVOYWBoLZ6grjN1eaBdnYEwsqc5He44b04vEWRUpgNb4c175ulMFUYkNHQU7Cj9twrGxzpVBnrVtOjNzG8Mq0FlvCeUjCERoLdTcc2TD3YX1zzlPeSQdyZ7ox9KlRKclsEt6RIdF7KgsKOd+a3okRlln0MXcu5AecGnBtwbsDkKFdBuQrK5CjDAYYDDAcYDjA5yrCAYQGTo0yOMuJhxMOIZ0cRD5OjTI4yOXp/5OjdPkqkJkQ6/PY6V4KGG6gWSUfiVeoxQGlULtEIqdUeKetkKcapriYZjEllxpmdyxL+X6bjBi3TujChwniC8QTjCSZUuHLClRMmVJhQYTjAcIDhABMqDAsYFjChwoQKEyqMeBjxMOJhQoUJFSZUPgOhstH1ijH57x1NC1TKiPBZCv3Jsk/0S2juLZqwWIj3Vtg5qn73sZfmkwwp1MrkYmZ0VaQYu1Qw/PYwa3CaJOGTbXyybSdSPz7ZxpVXzkM4D+E8hIlYrrhyxZWJWIYDDAcYDjAcYCKWYQHDAiZimYhlxMOIhxEPIx4mYpmIZSKWT7bxyTbGE4wnGE8wocKVE66cMKHChArDAYYDDAeYUGFYwLCACRUmVJhQYcTDiIcRDxMqTKgwobLTJ9tW7MkIfenTPv2drp9sC8apk6QqVTDWp/0pzm0gnqyOvc19FLrdYbfgSzdGbCtbIxsfd+PjbjuRD36Rx91ueZSN+VZONzjd4HSD+VYurH72QPrVFVaZb2U4wHCA4cAOwwHmWxkWMCxgvpX5VkY8jHgY8ewA4mG+lflW5lvv7wDbp6RQQ23yJh4V9aOpY3YyqtsMaGjONCjToDuRpn1eGtR/cm+Ar/oSTCaXzIFyCsApAKcAzIFysfOvEkW/umInc6AMBxgOMBzYYTjAHCjDAoYFzIEyB8qIhxEPI54dQDzMgTIHyhzoF86BBprEm6mylcxq5iTQKchx6XJVuUFFbQg/8uymKgm7o//BY6JtFQh9daqBLmWi3HJb5OdBgNDA7+R0FdncAqAQQ7E3rdC+nJGFLSXuT4/0eL++o0v5pgKPbuVbjyr2b0AYpbbqQ4JwkLl+vI0iMAyW2riBOPW6YdEXrEgpXFtcYiMm2jmd0yTCjQymDu8YNZu77QjtH+jAX8o6iSXmsG/1noYBIJ2BmBqde5TjL4amtbTxtetOa3ynRcVZ3F5ImvO6iH4ZPp2AtLy3l5Cab4jor31CGTF9vLWEqFDr8rWs+P6l64JlVv0BH2hF+CjKVktmNyXftoQ5dG9h3aW/vzHhjV5Do/ijtmmhUteBlms56PYNYlCbj5FiIwx5keJ6jbrydn4bhd9G+doKZje8jdKK9cFZXfPZ6R/3lgif3eeyDZdtuGzzFynb8HsrTFAxQcXvrTAcYDjAcGDn4QC/t8KwgGEBv7fC760w4mHEw4hnBxAPv7fC763weytf+HsrHmeRleK7Hn2bGKRKPSCeqiyrkS3GStP4ozZ/3FQpqSs+o8+s6E6kY1/kR5XHPhUqJbktgltb30dwS0pUZlmoHTA5yrkB5wacGzA5ylXQzx52v7oqKJOjDAcYDjAc2GE4wOQowwKGBUyOMjnKiIcRDyOeHUA8TI4yOcrk6P2Ro3cCIKvvmd722xvf3ZwqG6gWmelihiyfdz1G5RKNkFrtkbJOlmKc6mqSwZhUpvXd0g1apnVhQoXxBOMJxhNMqHDlhCsnTKgwocJwgOEAwwEmVBgWMCxgQoUJFSZUGPEw4mHEw4QKEypMqHwGQmWj6xVj8t87mhaolBHhsxT6k2Wf6Je1b5QlLBbiff3Nld3HXjzaV95s8POVZ0ZXRYqxSwXDbw+zBqdJEj7ZxifbdiL145NtXHnlPITzEM5DmIjliitXXJmIZTjAcIDhAMMBJmIZFjAsYCKWiVhGPIx4GPEw4mEilolYJmL5ZBufbGM8wXiC8QQTKlw54coJEypMqDAcYDjAcIAJFYYFDAuYUGFChQkVRjyMeBjxMKHChAoTKjt9sm3FnozQlz7t09/p+sm2YJw6SapSBWN92p/i3AbiyerY29xHodsddgu+dGPEtrI1svFxNz7uthP54Bd53O2WR9mYb+V0g9MNTjeYb+XC6mcPpF9dYZX5VoYDDAcYDuwwHGC+lWEBwwLmW5lvZcTDiIcRzw4gHuZbmW9lvvX+DrB9Sgo11CZv4lFRP5o6Ziejus2AhuZMgzINuhNp2uelQf0n9wb4qi/BZHLJHCinAJwCcArAHCgXO/8qUfSrK3YyB8pwgOEAw4EdhgPMgTIsYFjAHChzoIx4GPEw4tkBxMMcKHOgzIF+4RxooEm8mSpbyaxmTgKdghyXLleVG1TUhvAjz26qkrA7+h88JtpWgdBXpxroUibKLbdFfh4ECA38Tk5Xkc0tAAoxFHvTCu3LGVnYUuL+9EiP9+s7upRvKvDoVr71qGL/BoRRaqs+JAgHmevH2ygCw2CpjRuIU68bFn3BipTCtcUlNmKindM5TSLcyGDq8I5Rs7nbjtD+gQ78payTWGIO+1bvaRgA0hmIqdG5Rzn+YmhaSxtfu+60xndaVJzF7YWkOa+L6Jfh0wlIy3t7Can5hoj+2ieUEdPHW0uICrUuX8uK71+6Llhm1R/wgVaEj6JstWR2U/JtS5hD9xbWXfr7GxPe6DU0ij9qmxYqdR1ouZaDbt8gBrX5GCk2wpAXKa7XqCtv57dR+G2Ur61gdsPbKK1YH5zVnWHXVknrsC5c+QVqvncWgbTIlKUA0egN+eZGIz5kvToBZ1OWwYohDRXFUTKXRQHZMTZA/q3CBaB8BNLDLp/wfgtsH3krEKc+jwAaHRWLRjtOMZ/S1vXDULbfjNmn5bD+v+O0X1ZFMqetnVkU+ye6jULk4Oa67gm3SKIzjR7IUj243H9Qd/3gqun7/QPf+YOr0Pv7B3X3FpLKEMQ8u4om0qrksMLuzs7jSJsZSnx2jptYN3yRzCEPyGrVfCujOjkWF7Ckz7U3hczBw04LicFPu8fS3EKblHCnpR6jke9vlTDMnSsJBHsxtqKFmclC/eGTxVWhit5ZwvtzkD5lxeGjUfS2r82sT7tfa2ip/g5L2qLfrS4QeYJ1P+l0+cTXH3BQ66TBNPhgePCwP/y+f/DDy/1vR9/ujw4eDYbf7//LF6ammjIx5fChqMnYD1MrDk+OKX8x1st9uR8wtMslQegg34m2Ttxx99ZWBL+WwL9LOaI1TSsqZ//86smRt7XY5wFkz+TzHSbRp08Oj/45EIdJAqWzWABqCsQ09yPpQOwdv3guHn033O+tZ+CFXgzECaJ0TBstOewkkzm+Hhpur9bbwVv3oMykKnyhIUOZvfae4WbgMu2v7BCtb9S2Sb8MeDUsBCo/rcR5HM3RGEZn0dXVRFp4ZbL37/HymwrM0qszGTp+wTyqeqos/p52x+z2Uu6FjCTtieOtcmgQ79pJ1ppWLKOGm4iiOLqAZTRqORysnd+TSL4g+2EC1etKTj0YEK6Wv/uzF6AfEvX6aVmWmfLsxAO0I5qMf8Ir1Z+2bTu0k+cvXuI+65RS3lyn+IyRiyimnySp105yQHTtKspkMauwDDmKfJ/47z/92RLo +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +schedule a CUED break, transitioning it to READY. Accepts an optional startDate (ISO 8601); defaults to now. Past dates are clamped to now. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-breaks.api.mdx b/ads/api/reference/post-channels-channel-id-breaks.api.mdx new file mode 100644 index 000000000000..3d97e9951119 --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-breaks.api.mdx @@ -0,0 +1,11565 @@ +--- +id: post-channels-channel-id-breaks +title: 'Post /channels/{channelId}/breaks' +description: 'Create a break. Optionally provide a templateId to use a template as base.' +sidebar_label: 'Post /channels/{channelId}/breaks' +hide_title: true +hide_table_of_contents: true +api: eJztfV1zGze27V9BseZBrCEVSnE8NvPgUhKfuarjjF22M1N3JM0VyAZJjJqNDoCWwtj+77f2BvqDZMuiIiumqJWHlNUNonfjY6+FtQDyQydRbmx17rXJOsPOj1ZJr4QUI6vkxb54zTdkmi5Ebs2lTuieV/M8lV4dJ8IbUbjmNSGdGEmn9ju9Ti6tnCuvrOsMTz6sPOk4UZnXE62sMBPhZ0qMZzLLVEqf1FQil37W6XUyOVedYSfePU46vY5VvxbaqqQz9LZQvY4bz9RcdoYfOn6RU2Hnrc6mnU+fzkJh5fwPJllQibHJvMo8/VPmearHkgL65r+OovrQqEpmi9cTDjy3JlfWa+X4unPKv2m82oeOTBId2unNUtGVaHorTVA2ruAqRd1c1IhShI+Jucx7Yq7sVCVCZ95wW12qLDE2fNCVDVj1wdVMZXyFe1FoJ8bcr8m+qAMvOzQRM2WVkFaJsZmPdKYScaX9jCswmXIiURO+arLlx4Snf0/XkyI0pRIXauFCiDIt1OpTrnRG/Rsbxoz+q8aeGoZ6xZqUW+2aRspTuRjJ8YUoy4qJsfVb9oQrxjNqOXehcyGzRLhM5vyJkZrJS20sD8qlHqKyrycTp/z6k/9RzEdhdDo1NlkSX0urK2XFvHBeXEk/nomRmhirGu09UmMzVyGQXI5StS9+1pmeF3MxoBDm4Y/OcFC1RMbPopYog16P518z5WfKNqPQTsg0NVeKZ6JT6kKYS9VolX3xLxoLKqMwkp6Q5SepLI2u5eJUoVW+sFmokW44L60vh1goRY1L3eGE9kJnYlKkKQ2DsVquKjGZ6tUdZ5UrqF2kD2PL6qmmnuW4c+N4DsWIlwJ19cCPfe1nasFDVqbO3CbkRsQ9ISdeWXE10+PZtVEmaiKL1MfLIjc682Iv/BVGTk80x6FICsspJczCzHjhlO/G16I/c6ucynzvdh1Zz5qRMamSWefTp5aJVD59ffj8sBydzsphXWf5EDLnChobE2vmjdT+vZjINKX0Pr4oW7rKBWW9N45vdakyf5x8ZqLrNWTgzwg/066aYanJpk54sy/eVy0fup1nJkXKWUxnjRqudJaYq0ZT1plZt0T0S6Z/LVRLPOFxjepL6BJvymw3WoQbhfNmTp+0Qhbe9KcqU5ZScWhrM9ee8nJotVcqm/pZZ3jQEmBzxLU0Hl9vdGqZJVPqyCvOvRH5WkY6T4PVnLE2VFeGt3YE/QllXLob54fhQNonMY9o2Wi9KpXvV6m6ylRrddID9TQzlp6ZJc3ZExMIzcwyKm/ip2+Ve2kALWP/xNi59J1hJ5Fe9b2eKyY23itL7f6fvRfDvRfD09Pk9DQ5OXzy9NnZyeDJs7OP8crBt9/97fnZyeHT8srghO6eDOqig8HHRrHBoNsfHPYPn1P5D08+9cMDBlzk2dnHg5PB4Vm3Hy71n599PDk4PDs9TT5+ezI4OOt+5BtPnj4/+3hw0FpsEMocNm8e0J3Dk0H/2Vm3230fHkn1lde/PesOTwb97+jC3oth89+np/unp8lfuy+6L/ZeDP/d7f6lZXp9+Fy7n63yonfjmUqKVCUtiXxfvM7ElUzTcWqIC4SJ54TMxPG71+LZ08GBoK6inooMignKm/fvGoVFZrJ+pqbS60vF90Iw19VusnTR48lKA2tckuRxQTOdh7OfSR58roqd0qIVl1py8HmRjWdCZQkP030abTWNXp/P6+y4yrTeMMFupkNCzffNMuVUJ+Zncs3crQmgBG4hzVcZ+3O551JaLbOVmWEydT0/biFyR4GrUvZRSeRu2olY97448iJV0nninIGHBJLP6wGv5lzldQ+9HvZ+KvNVbMfAtetE2QuJ+CIzV9ltckUJGMwOOsPOIP7X5/89of89K/8s/+usjvRrESZE2UCYOPhvgS+8hvjll+Ofbos0OvPKynF7c9YoXZeq+HXFyDn8mpFLMU71+KLvZ9YU05n45e2rdSrORd6HEuvP/XG1AmFylZUw2mRSMS5XL2Jksi9+JlYwokl7KVOdlCFU6b2wej1vtRGsuUq0fM9XV2P8mW4J+gR1o8xCMwzFOXWZOac+OtdzOVXn9GiV0dA66fBNGuN0p3PW0iFzPVfXPPH455fVA+txwzGKPeoN9Zuc56mKMXwzz5+cd5eH/BHxzoDhPDctZZiElohznSlR5BNriDvF1Yf2YiyzwKV5AvMjvxeG7l5pp6jEjEiBEd4uemIueaER17hW0TKXR40jvmtb2ZhvfVvOIOF1E0035jqT3th9ce689Hp8PhRSJNqqsa9SoFUTZRUtTerRGNrHWMFtXo6FskNCXa09QaOknR60jp/ehzpzLQ92L+1UEcn+zAxL1KWmFVVZNGCMU6ni0R3GvXbil7fHJe1Zn1WhkvbR81N8ADUo16Qybxfxga7icAEx4jreCaculZVpmbhdrzl0yuiidiDmtEIOsVczNITUbPFEuQtvcmpAYn+ecpQZ6ZS4lr9s6Ym2icl6w/pLvq9mBbVTBTvhVZemSGNc/PPo3Xvh5ZSGRvfGlPmpqUidxEDO2nKHzo7DeKgrkdbKRQsJemXGS7gVRmWZUpTmySiF09k05SEc2Q6vRin3UL30YbpFb6uVE0qOZyEvmutG2f7a+9QZLwYd5kHLCwKVgcpAZaByicqX0nnG5GY+bb6TVc6kl4rDmigSU2llb1WWREEiLFIul9CCagU6A52/JjpXIaQRph8KJN+He5U0raucnkDqXMCEVb9qydfaF/9T93CPu//vxlDjHSXiZ5nJaUgDLthTVNG5TN7Laf0C5612EogHiAeIxyMmHpxumHqEf/bnnE2SciaxIUKD959aXYlw00W/L9WXyi5qjyGkrmYZmYhEjbXTJuP03Og9Lvw5dlKniDyVYzUzaaLsWib4Z8PfJ2gMmXI9OeYmKTcBUGCRbPhFrse8aaPIuFubei+/WJGxS5KYq8x5q+T8+9Lo5J6SohHcJgJxeO31LkrK5rPK5SZzepQqTguN9uOAqmanqbK0vWFf/FhYqzKfLliHF+dTOT8Xe2uN0W12xFTOW3sh1PxFADD0Ud/laqwnevyZ/Rv74p+UZTgP52QK8Ce/54YIbyPFOT3tXEy0SpOm/C32xiuvn5vkvNsCezdzhNhNLa2wzhzOPs+I6ly52uf/DMxTpHJhCr+u1DE74qlJJnzfja1SWaSxEx0MS7ZsM69tlYQonefG+iWhjqtq7eY/xODXPYk/wLFzPb7YiGGLo7IChiZqqzoUNm4ypxPFdmc5OWNEqwGIXwuZ6slC7M2L1GtK8OVsZu5ZXa0+0Fy2KOHknOP31KfdXtydkTB8xu0R1YaLcjMQTeBEuWHz3QsXE+REW+fr15sZx7N+Th5ZAzDihqI4wKsIHu86aWUKxynWKz21Tfn9rd23XliG5JIzDjMlSbvBcpkxYoQ8vJFDJ9P0BoMQ5BzkHOT88ZJzeHVQA3dLDYRXB1QGKgOVHzIqw6sDOu8mOsOrg1cH4gHiAeKxncQDXh28Onh1d/TqVrlDJd635ONlXZ8mZLQFJJ+qpEP+nFKsnkuaXFxqjwfhaCHOE1OMUnXOQ+E8dTOZq/8nk/OKxvL7QvwH2gPtgfYQ/yEv7La8APEfqAxUBio/ZFSG+A903k10hvgP8R/EA8QDxGM7iQfEf4j/EP/vJv6v1FdL/3/eqZ7oCQyZVSWqP1r02UeIxcM0ZgYVcdwJN6Px3n7WoPo6NYZQOb6YWlNkCQGWjrO9+ZglEsyR4FAQDgXtypoMh4KwEMBCAAuBnV4IwBeE8rhbyiN8QaAyUBmo/JBRGb4g0Hk30Rm+IHxBEA8QDxCP7SQe8AXhC8IXxKEgoD3QHmi/42gP8R/ywm7JCxD/gcpAZaDyQ0ZliP9A591EZ4j/EP9BPEA8QDy2k3hA/If4D/H/wR8Kqm2AISXQV33+O1k+FBRnpBmPi1zHGfqqP6F32xcv6xNDswA9m50Tigl05YnNEVbFhpNCOCm0Kwu1r3VSaMNTQLD/wPfB98H3Yf9BYNxtgRH2H1AZqAxUfsioDPsP6Lyb6Az7D/YfiAeIB4jHdhIP2H+w/2D/3fHsz306elGeu8nWo0FRSXmtBt+6IReLw5WDK7cr66d7d+XCN2lGcmkulU3lApYcODg4ODg4LDmIfhD9YMkBlYHKQOUHjsqw5IDOu4nOsORgyYF4gHiAeGwn8YAlB0sOltw2WnJR7w9zU7tCpqUFEH0B8mNMXsseNDorc4rTuS1yZtyUdOgQXbPfY12tfW9yOdZ+0YJiMYBYIHTfpIYzf6VUJgZib1LQpPJWZi6X1CldHrwH5R2Ty18LFTip/C2whYMbmENunL4GXGNYZYkmASB4y431++Jt6HNHc7w2UKj5qBWtGBnvzZzjjDdSNfF0x+rpzK8jb/hAC3XSzksSUmPXlN0WH6CSqRITa+aBoISLsWgZbe/apuVmvFW70VtsHiS/83KIoRnuL0Bu3s0j5OIrIYZr9xgjres2jpAG1HJ8jYn65aNro1tO/97CBMqJQnfp8eXD3Wpw64N9ptp7qawy3F95p5VaY6HenXriSie+heiWcfDtG8LgMneJYgVBQki9so3a1szY4oAtDg9Qj7phi0MDlGPKuebrim/cl4DzyVA/oH5A/cBmCNgtsFuwGQKoDFQGKj9KVMZmCKDzbqIzNkNgMwSIB4gHiMd2Eg9shsBmCGyG2MbNEIEd8dSkDQR9N7bk3AUaO9FpWvJRwkBbJaGmnVkJdVwVziHDpNuVddLX+nbgXliG5JIzDjOltS/y3tChk2kaV9/w6kDOQc5BzuHVQQ3cbTUQXh1QGagMVH7IqAyvDui8m+gMrw5eHYgHiAeIx3YSD3h18Org1d3Rq1vlDvWPia7n45Uf6Ey0i7aATE02JdMppBSr55ImF5fa40E4WojzxBSjVJ3zUGj8gGhFY/l9If4D7YH2QHuI/5AXdltegPgPVAYqA5UfMipD/Ac67yY6Q/yH+A/iAeIB4rGdxAPiP8R/iP93E/9X6qul/z/vVE/0BIbMqhLVHy367CMs/eAgM6iI4+VPorWfNQgcXYe5Qt93OrWmyBICLB1ne/MxSySYI8GhIBwK2pU1GQ4FYSGAhQAWAju9EIAvCOVxt5RH+IJAZaAyUPkhozJ8QaDzbqIzfEH4giAeIB4gHttJPOALwheEL4hDQUB7oD3QfsfRHuI/5IXdkhcg/gOVgcpA5YeMyhD/gc67ic4Q/yH+g3iAeIB4bCfxgPgP8R/i/4M/FFTbAENKoK/6/HeyfCgozkgzHhe5jjP0VX9C77YvXtYnhmYBejY7JxQT6MoTmyOsig0nhXBSaFcWal/rpNCGp4Bg/4Hvg++D78P+g8C42wIj7D+gMlAZqPyQURn2H9B5N9EZ9h/sPxAPEA8Qj+0kHrD/YP/B/rvj2Z/7dPSiPHeTrUeDopLyWg2+dUMuFocrB1duV9ZP9+7KhW/SjOTSXCqbygUsOXBwcHBwcFhyEP0g+sGSAyoDlYHKDxyVYckBnXcTnWHJwZID8QDxAPHYTuIBSw6WHCy5bbTkot4f5qZ2hUxLCyD6AuTHmLyWPWh0VuYUp3Nb5My4KenQIbpmv8e6Wvve5HKs/aIFxWIAsUDovkkNZ/5KqUwMxN6koEnlrcxcLqlTujx4D8o7Jpe/FipwUvlbYAsHNzCH3Dh9DbjGsMoSTQJA8JYb6/fF29DnjuZ4baBQ81ErWjEy3ps5xxlvpGri6Y7V05lfR97wgRbqpJ2XJKTGrim7LT5AJVMlJtbMA0EJF2PRMtretU3LzXirdqO32DxIfuflEEMz3F+A3LybR8jFV0IM1+4xRlrXbRwhDajl+BoT9ctH10a3nP69hQmUE4Xu0uPLh7vV4NYH+0y191JZZbi/8k4rtcZCvTv1xJVOfAvRLePg2zeEwWXuEsUKgoSQemUbta2ZscUBWxweoB51wxaHBijHlHNrfrSmGB2VulBooOo3C4nmilQ7TvPVuOEMW42IP9Jeq+/o1Zz6XR0nm8hE5J5ak7bs4aimdcm+RFm2Wu7zG9bLfXehc05FLpM5f6IUCNYHIJV9PZk41ZKS/8FZipopajXN157Tgv6K2kOM1MREtSi09UiNzVyFQHIaMrcRdsqg1+P5V1wCN9UGJyStn0kAM8IpdcHg2ZRseJqojMJIesyB+ZNUlnpyuXhYCPjCZqHGaATaihOEUtS41B2OZr3OBJHR74UhCF+qKjGZ6tUdZ5Ur5oE4hkykp5p6luMuZ0A1sRuBOuLhptnXVdqSqTO3CbkRcU/IiVc2DvvroowJN14WudGZF3vhrzByeE7VTyq1wKByZIZEet+Nr0V/5lY5RVPxVh1Zr79GxqRKZu2E5Xol8ofl6GoJ8jajU12qzB8nnxPm1sRE/kxI4eX84K9MF97si/dVu4VO43k1kWnaXHyEGq50lpirVsFGt0R0rbgZHteofjyTWabSW8mbtxQ1m+OlpfH4eqNLyhyX0hQN4lG5v2R9nPIgXp3xawNtZXBGi4jyJRP/MLoNB9I+BXk8ykbrVYl4v0q0VZ5Zq5MeqKeZYdpTKl119XFelVF5Ez99q8xJA+gaQ460kL7Xc8LsXHqvLLX7f/ZeDPdeDE9Pk9PT5OTwydNnZyeDJ8/OPsYrB99+97fnZyeHT8srgxO6ezKoiw4GHxvFBoNuf3DYP3xO5T88+dQPDxhwkWdnHw9OBodn3X641H9+9vHk4PDs9DT5+O3J4OCs+5FvPHn6/OzjwUFrsUEoc9i8eUB3Dk8G/Wdn3W73fXgk1Vde//asOzwZ9L+jC3svhs1/n57un54mf+2+6L7YezH8d7f7l1bf8jPtvkY83o1nKilSlbSk4X3xOhNXMk3HqSEkDxPPkVh9/O61ePZ0cCCoq6inop5FuCLevH/XKCwyk/UzNWWnlu+FYK6rnWSsHk9WGlisS5ISPy5opvNwLr8myVWxE3Wx4pIEdeJDRTaeCZUlPEz3g8HI1Gl5vF23XRRfGwNTCqYUTCnsUcUuGOyCwR5VoDJQGaj8KFEZe1SBzruJztijij2qIB4gHiAe20k8sEcVe1SxR3Ub96gGdsRTk4zpvhtb2lAVaOxEBxuQjdDMa1sloeYus0qo46rw9TDYO7Ur66Sv9aMNvbAMySVnHGZKa7+vsqFDJ9P0BoMQ5BzkHOT88ZJzeHVQA3dLDYRXB1QGKgOVHzIqw6sDOu8mOsOrg1cH4gHiAeKxncQDXh28Onh1d/Tq1g8Zl7/xvp6PV343PdEu2gKSzyrqJMB3bvVc0uTiUns8CEcLcZ6YYpSqcx4Kjd91r2gsvy/Ef6A90B5oD/Ef8sJuywsQ/4HKQGWg8kNGZYj/QOfdRGeI/xD/QTxAPEA8tpN4QPyH+A/x/27i/0p9tfT/553qiZ7AkFlVovqjRZ99hKXfgWYGFXG8/KXa9rMG1ZeUMYTK8cXUmiJLCLB0nO3NxyyRYI4Eh4JwKGhX1mQ4FISFABYCWAjs9EIAviCUx91SHuELApWBykDlh4zK8AWBzruJzvAF4QuCeIB4gHhsJ/GALwhfEL4gDgUB7YH2QPsdR3uI/5AXdktegPgPVAYqA5UfMipD/Ac67yY6Q/yH+A/iAeIB4rGdxAPiP8R/iP8P/lBQbQMMKYG+6vPfyfKhoDgjzXhc5DrO0Ff9Cb3bvnhZnxiaBejZ7JxQTKArT2yOsCo2nBTCSaFdWah9rZNCG54Cgv0Hvg++D74P+w8C424LjLD/gMpAZaDyQ0Zl2H9A591EZ9h/sP9APEA8QDy2k3jA/oP9B/vvjmd/7tPRi/LcTbYeDYpKyms1+NYNuVgcrhxcuV1ZP927Kxe+STOSS3OpbCoXsOTAwcHBwcFhyUH0g+gHSw6oDFQGKj9wVIYlB3TeTXSGJQdLDsQDxAPEYzuJByw5WHKw5LbRkot6f5ib2hUyLS2A6AuQH2PyWvag0VmZU5zObZEz46akQ4fomv0e62rte5PLsfaLFhSLAcQCofsmNZz5K6UyMRB7k4Imlbcyc7mkTuny4D0o75hc/lqowEnlb4EtHNzAHHLj9DXgGsMqSzQJAMFbbqzfF29Dnzua47WBQs1HrWjFyHhv5hxnvJGqiac7Vk9nfh15wwdaqJN2XpKQGrum7Lb4AJVMlZhYMw8EJVyMRctoe9c2LTfjrdqN3mLzIPmdl0MMzXB/AXLzbh4hF18JMVy7xxhpXbdxhDSgluNrTNQvH10b3XL69xYmUE4UukuPLx/uVoNbH+wz1d5LZZXh/so7rdQaC/Xu1BNXOvEtRLeMg2/fEAaXuUsUKwgSQuqVbdS2ZsYWB2xxeIB61A1bHBqgHFPONV9XfOO+BJxPhvoB9QPqBzZDwG6B3YLNEEBloDJQ+VGiMjZDAJ13E52xGQKbIUA8QDxAPLaTeGAzBDZDYDPENm6GCOyIpyZtIOi7sSXnLtDYiU7Tko8SBtoqCTXtzEqo46pwDhkm3a6sk77WtwP3wjIkl5xxmCmtfZH3hg6dTNO4+oZXB3IOcg5yDq8OauBuq4Hw6oDKQGWg8kNGZXh1QOfdRGd4dfDqQDxAPEA8tpN4wKuDVwev7o5e3Sp3qH9MdD0fr/xAZ6JdtAVkarIpmU4hpVg9lzS5uNQeD8LRQpwnphil6pyHQuMHRCsay+8L8R9oD7QH2kP8h7yw2/ICxH+gMlAZqPyQURniP9B5N9EZ4j/EfxAPEA8Qj+0kHhD/If5D/L+b+L9SXy39/3mneqInMGRWlaj+aNFnH2HpBweZQUUcL38Srf2sQeDoOswV+r7TqTVFlhBg6Tjbm49ZIsEcCQ4F4VDQrqzJcCgICwEsBLAQ2OmFAHxBKI+7pTzCFwQqA5WByg8ZleELAp13E53hC8IXBPEA8QDx2E7iAV8QviB8QRwKAtoD7YH2O472EP8hL+yWvADxH6gMVAYqP2RUhvgPdN5NdIb4D/EfxAPEA8RjO4kHxH+I/xD/H/yhoNoGGFICfdXnv5PlQ0FxRprxuMh1nKGv+hN6t33xsj4xNAvQs9k5oZhAV57YHGFVbDgphJNCu7JQ+1onhTY8BQT7D3wffB98H/YfBMbdFhhh/wGVgcpA5YeMyrD/gM67ic6w/2D/gXiAeIB4bCfxgP0H+w/23x3P/tynoxfluZtsPRoUlZTXavCtG3KxOFw5uHK7sn66d1cufJNmJJfmUtlULmDJgYODg4ODw5KD6AfRD5YcUBmoDFR+4KgMSw7ovJvoDEsOlhyIB4gHiMd2Eg9YcrDkYMltoyUX9f4wN7UrZFpaANEXID/G5LXsQaOzMqc4ndsiZ8ZNSYcO0TX7PdbV2vcml2PtFy0oFgOIBUL3TWo481dKZWIg9iYFTSpvZeZySZ3S5cF7UN4xufy1UIGTyt8CWzi4gTnkxulrwDWGVZZoEgCCt9xYvy/ehj53NMdrA4Waj1rRipHx3sw5zngjVRNPd6yezvw68oYPtFAn7bwkITV2Tdlt8QEqmSoxsWYeCEq4GIuW0faubVpuxlu1G73F5kHyOy+HGJrh/gLk5t08Qi6+EmK4do8x0rpu4whpQC3H15ioXz66Nrrl9O8tTKCcKHSXHl8+3K0Gtz7YZ6q9l8oqw/2Vd1qpNRbq3aknrnTiW4huGQffviEMLnOXKFYQJITUK9uobc2MLQ7Y4vAA9agbtjg0QDmmnFvzozXF6KjUhUIDVb9ZSDRXpNpxmq/GDWfYakT8kfZafcdKEiEtjp/S/jUMSx/ztlB8gcl7GCOHgwNen8eNT8Sf8zzVQQb75r8uMBk3nqm5vJ5dT2Tq1NqafyazTKXHyfroO17TRGLhMBZDo44Uf/ez8GaDNQu9gDXpZ1YAMcZr0lrJPkVZUSV3cDC13OEudM6p2GUy50+UAsn6BKSyrycTp1og6R+cpen1o1bV7PY5CRpXNB7ESE1MVMvKZhmbuQqB5DRlbiNslUGvx/OvKAE01RYnJOkHJAAa4ZS6YPLQlKw4TaiMwkh6vAbgT1JZGsnLxcNCyBc2CzVGI9RWnCiUosal7nCU9XQmiIx/LwxRmKWqEpOpXt1xVrliHohzyMR6qqlnOe4yA1SJrRGoo3WIafZ1lbZl6sxtQm5E3BNy4pWN0/66KCPgxMsiNzrzYi/8FUYO55T6SeXEDypPZsik8N34WvRnbpVTlIpu1ZH1+nNkTKpk1k7YWHVQyVHLeH6v58p5Oc9r0S5EfCWdiJ8LbDITx+9ei2dPBweCFtFez1VcXbfKRdervz8st0gt+95mRihrjf1ZOUcC3doj/k8xl1nfKpnQEBdWSWeaL6doBasS8fLt29dv2dUvHAm53Adhhc/NEe5QR3DJ1hdVlyrzm2VLLtqeK3tCkzy5aH2Ebqn9Wpk6dl+9So05eoNsPJf2QtmflFfMbdte6n9KUTvhUqR60/MipViPJlQpkrJOYdXY2CQYdbk1STFmo6Jskn1xNOJOoDweqi6HobgkJXemxNGb49ZmCs96W6TqC0Zui1SFaBnoiaASihQEtyqIk17Nic2pu8Qe8t51ccfKlsNneiJLcSaEe93LhOojOc1NmlKar2qqX/cur9BMfy0rEb7emO0lZHMoQQsut4utp13OyasAtpY3V3JtdHwpe/E6PiRrw4G0IwqnV9mYQhWv2K94QwWba3XSA/U0MzYOkkYqj2hGMFFG5U389K2IAIHYNf46ZeU+pWUiNNJ7Zand/7P3Yrj3Ynh6mpyeJieHT54+OzsZPHl29jFeOfj2u789Pzs5fFpeGZzQ3ZNBXXQw+NgoNhh0+4PD/uFzKv/hyad+eMCAizw7+3hwMjg86/bDpf7zs48nB4dnp6fJx29PBgdn3Y9848nT52cfDw5aiw1CmcPmzQO6c3gy6D8763a778Mjqb7y+rdn3eHJoP8dXdh7MWz++/R0//Q0+Wv3RffF3ovhv7vdv7RuQ/hMu6+tI95RIihSlbSwin3xOhNXMk3HqSFiGrLvZwGUaJJ48/5dozD/GZ6/NCfHRZW4hLySmpe1MoZBVe7HYeKLlr3fr/REjRfjVJXIxkI/VzcU52/evnxz9Pb4H38/F3tV3eo3GkhMyHyRd3vi/MdfXv50LvZyq/qlgRDMz2gG/HR03GuPjT799uXRT//3XOypVE8bRkQwHqjAu+O//+PoFT8iXg6TJSy/XJeZ1Tnj8bnYm0idqmTJdaheo9PrUKydXocf2ul1yro7vQ5X0H5iJKbzzTC9LN2E9QZ34ixdgbs4CkmgrzOeqY2NseWX0lFSu1B5yJSLbFxbphXMtCXfcjm5lBrqjfq3WP/9Sd/mdYuIsJHg3jYS/JE1N3YZYJfB9uwy2P5DB7fIdEtK/h+Zm9gQ+Zg3RG7PcQWddHq32iAJOgA6ADoAOvB4TjuAFoAWPIpzEvfJBXCSAowHjAeM5zEzHhyzwDGLR37M4jqKUZ21CDnuK564CDyLZyltM+q7saXtwYEQT3RwwXmPSOa1rfJRc890pVJyVTd/2dkXWShgmzC2CW/1NuEvsoK4td3ZC0uhXHLaYrq19jtjG1qiMk3vYtdibYC1AdYGWBvAHIUKChUU5ijoAOgA6ADoAMxR0ALQApijMEfBeMB4wHgeKeOBOQpzFObolzNHb/dVIqUh0pK3l70SmrjRapF8JF4ngQPkVs8lTUIutceDdbQQ54kpRqk65yFT/sKUTM4rtsztAkMFfAJ8AnwChgqUEygnMFRgqIAOgA6ADsBQAS0ALYChAkMFhgoYDxgPGA8MFRgqMFS+gqGyUnXtmPx5R9OilTJkfpao/mjRZ/slFg8zmrlYxHsXfySo/dhL9U2GDLVyfDG1psgSwi4dJ37zMUt0miPByTacbHsUSz+cbIPyinUI1iFYh8CIheIKxRVGLOgA6ADoAOgAjFjQAtACGLEwYsF4wHjAeMB4YMTCiIURi5NtONkGPgE+AT4BQwXKCZQTGCowVEAHQAdAB2CogBaAFsBQgaECQwWMB4wHjAeGCgwVGCqP+mRb7Z4MKZe+6vPfyfLJtjg5zXhc5DpO1lf9Cb3bvnhZH3ubBRTa7LBbzKUrT2wOtio2HHfDcbdHsR7cyuNuGx5lg9+K5QaWG1huwG+FsPrVgXTnhFX4raADoAOgA4+YDsBvBS0ALYDfCr8VjAeMB4znETAe+K3wW+G3frkDbPdpoUZt8iYflcZHpWO2OqrrDmgsDhsUNuijWKZ9XRs0fHNvpK/mUtlULuCBYgmAJQCWAPBAIXY+FBTdObETHijoAOgA6MAjpgPwQEELQAvggcIDBeMB4wHjeQSMBx4oPFB4oFvugUabJExT7QqZls5JtFPI4zJ5rdzQQK0MP87stsiZu1P+oWOizSEQ62odBiaXY+0X6yG/jgHEAqEnJzWy+SulMjEQe5OC5pe3MnO5pP7p8jg+KO+YXP5aqMBu5W+BVRzcwDBy4/QfAeEYc/nxJosgGMyN9fvibRgbjnJBbUpR21ITWzEy3ps5v0S8kaqJpztWT2d+HaHDB1r4l3ZeksQc+63s0/gAlUyVmFgzDywnXIxFy2h717Y7t/GtGpXeYvMg+Z2XQwzNcH8BcvNuHiEXXwkxXLvHGGn5uHGENKCW42vM4i8fXRstc/p39QdnEX2UYisjc6uRr8+EmWrvwrLKcH/lhVdqjYV6d+qmK534FrZcxsG3bwiDy9wlihUYCiH1yjZqW7djNwp2o+yaYHbDbpQG1sdkdc13p99tlwjO7kO2gWwD2eaByDbYtwKDCgYV9q2ADoAOgA48ejqAfSugBaAF2LeCfStgPGA8YDyPgPFg3wr2rWDfypbvWwk8i2cp7fXou7ElqzQQ4olO05LZElbaKh81/eNKpeSqcEYfruijWI5t5VeV98JSKJectphurf0ewYaWqEzTqB3AHMXaAGsDrA1gjkIF/eqwu3MqKMxR0AHQAdCBR0wHYI6CFoAWwByFOQrGA8YDxvMIGA/MUZijMEe/nDl6KwJS/870et5e+e3mRLtotcjUZFNy+ULqsXouaRJyqT0erKOFOE9MMUrVOQ+Zxm9LV2yZ2wWGCvgE+AT4BAwVKCdQTmCowFABHQAdAB2AoQJaAFoAQwWGCgwVMB4wHjAeGCowVGCofAVDZaXq2jH5846mRStlyPwsUf3Ros/2y9IvyjIXi3hf/nJl+7GXwPZ1mDb0/cpTa4osIezSceI3H7NEpzkSnGzDybZHsfTDyTYor1iHYB2CdQiMWCiuUFxhxIIOgA6ADoAOwIgFLQAtgBELIxaMB4wHjAeMB0YsjFgYsTjZhpNt4BPgE+ATMFSgnEA5gaECQwV0AHQAdACGCmgBaAEMFRgqMFTAeMB4wHhgqMBQgaHyqE+21e7JkHLpqz7/nSyfbIuT04zHRa7jZH3Vn9C77YuX9bG3WUChzQ67xVy68sTmYKtiw3E3HHd7FOvBrTzutuFRNvitWG5guYHlBvxWCKtfHUh3TliF3wo6ADoAOvCI6QD8VtAC0AL4rfBbwXjAeMB4HgHjgd8KvxV+65c7wHafFmrUJm/yUWl8VDpmq6O67oDG4rBBYYM+imXa17VBwzf3RvpqLpVN5QIeKJYAWAJgCQAPFGLnQ0HRnRM74YGCDoAOgA48YjoADxS0ALQAHig8UDAeMB4wnkfAeOCBwgOFB7rlHmi0ScI01a6QaemcRDuFPC6T18oNDdTK8OPMboucuTvlHzom2hwCsa7WYWByOdZ+sR7y6xhALBB6clIjm79SKhMDsTcpaH55KzOXS+qfLo/jg/KOyeWvhQrsVv4WWMXBDQwjN07/ERCOMZcfb7IIgsHcWL8v3oax4SgX1KYUtS01sRUj472Z80vEG6maeLpj9XTm1xE6fKCFf2nnJUnMsd/KPo0PUMlUiYk188BywsVYtIy2d227cxvfqlHpLTYPkt95OcTQDPcXIDfv5hFy8ZUQw7V7jJGWjxtHSANqOb7GLP7y0bXRMqd/V39wFtFHKbYyMrca+fpMmKn2LiyrDPdXXnil1liod6duutKJb2HLZRx8+4YwuMxdoliBoRBSr2yjtnU7dqNgN8quCWY37EZpYH1MVremXWuS1lEpXIUGqn53loi0SLVjgKjGDefmakT8kfZqJZyVLEOKIT+q0+uMZzLLVHpMBch/K6gBeD2ikqO2nPBpjWz/FGaBeBvWEYqfTgOLn3ac0HrKON+Pj3L96pl9bg7HnTl1FOgP4cIZ0WM/M+VnqVMkpc/ONzLX31wefFNW9s2HqrZP31TVOTUuLJPIkw+dkXR6fFTQx0/Oeh1jpxTTyRl1U1nw3Xim5pE71cXX1kxvjsWFWvA319tMzlUglk6NLX2fPYlvV8YmzCwd19gZhvrqJcHM+5xpbghjDQ/sVGb697AcrKUo3pVE92dKhkUpPb4z7PzWN3ba5/4tx2Cu/1ctuBP+60xG3FI5/4NJFi+DwtAuRH7qdWgngjUpt4K70PnrycQpz0DiMpkTie8MvS3UksY36HXUpco8d3ScdUGRq/+yyhVz1azPS0sL7cPB4ZP+4G/9w+fvD74bfncwPHy2P/jbwb/pddSccpVarrccuY1tXycflqPhR2+oAK7Ia8vKVlPYqbWkSgaqxZ46vCr58M6MqCw0/ZRti5StopY4WwfI1gXfXC+vqjal8MF6Q6u68IkyQKUrhgzdWeE8TVCswIeToM4mhqUI7WlOdSrJ6ihx4ujNMT/TujCtLw/iItLPJTdBnL5vjPPihmS2lCA+dMrNw8POj5ymS9jdFyXpShclBAsp6mlE6lHhmteIb46kUw3Fwqvf/Dd5KnUWhLGUHhly7wmlFnqrgxo3KL5hE0NGVQKfUd4ennQ+fKBH/GLTT5/o8q+FsouQiXkuj6jxaAprR/9O2gll87X34nI56YrjNa0+xnLtG5VJMlt0KuOs0+l1LtSiM2ygIUN8TLYUXrj/YwiiH2Wb8vMyz1MdvKpvKOfyDAqfOBqPVe4/W7YJdm9ev3tPrWgSFkDmJqHPWHlFSVRehViDmcVpmq996KQymxYkSg87oU767/8DOwu/vQ== +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a break. Optionally provide a templateId to use a template as base. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-detection-disable.api.mdx b/ads/api/reference/post-channels-channel-id-detection-disable.api.mdx new file mode 100644 index 000000000000..0d5124903cd0 --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-detection-disable.api.mdx @@ -0,0 +1,101 @@ +--- +id: post-channels-channel-id-detection-disable +title: 'Post /channels/{channelId}/detection/disable' +description: 'Disable automatic ad-break detection for a channel. Stops the per-channel detection scheduler.' +sidebar_label: 'Post /channels/{channelId}/detection/disable' +hide_title: true +hide_table_of_contents: true +api: eJy1Vk1v4zYQ/SsDnmxAjp3tbrdxTy5SbI12kSDZj0MQIBNxbHNDkVpyJMdr+L8XQ8m2YruLXpJLZHE0nPf4OPPWSlPMgynZeKfG6tJEfLQEWLEvkE0OqAePgfAJNDHlEgYzHwAhX6BzZM/gln0ZgRcEJYVB+7oTHvMF6cpSOFOZKjFgQUwhqvHd+mD3qSbHZmYogJ+ljNtNVKaMRJTIC5UphwWpsWpXp1plKtD3ygTSasyhokzJrgWq8VrxqpTgyMG4udps7iU4lt5FirL+ZjSSf7l3TI7lEcvSmhylquG3KKWtO/lQayNLaK+DLymwkTwztJEyVXZerVUeCJn0JGV9ifWTKSgyFiUsF+S6YGGJEdovM8AI6GB6ewW//To6B41MbAqCBo4Qc4AvU3kV2ReTGIn/ptXx1h+8n1uCy8kUmlBAiYUnWkEVSacDloIihZrCYF4ZTRp6tx8m0z7IEZzBTUt3iq3JaR+g9BqSVuLJsnaK+NOJxvRxYV8XxAsKHfUdSi9ULrblmbiX4A2hHnhnV+BdSx2g01CVwtfvwH4uiA1DbTBB26ekVM1Qt8onp0tvHMczuKQZVpYjsId0vB1Yj95bQpdw1eGrcdovP8ZjSJdfbqAXaGmc7sMyhYFxUBhrTaTcOx0zEOkFb61xc1j4JcwwwCPmT82lssgzHwqw3j814BuSpSxN1tQU5LG0uKJwUPYvI/mD3jsojKuYYr+Rm/MMkVgA0XNuq2hq+micKapie4EKfG5+XoxG788vLt68e/v+7eji4nzHgXFMcwrCgTlxmp+d+V7tVW12l/ukOgTH1WwWiU/R+I+pCSwyuXwFPoUd0jjeUdeytqIAkjU9Lwg1cEBjIwRCC+kSeXcgpD+S3iJj4BQRAQMB1WgruY6AczQuMji/TIzG5vumopfUj6DnfLvSF8g/IbTYUj86RW7T7Q4p+asq0A0CoU661SYKTpDg3QXutM8jwstGcJOcTU23DYfHuzSEFOjMjCJD+xFIdaFGK4fQ8g+oa+l80kD2cgRdyYbSwzDt1Ij3JVXnryPKttiptq+Ir6287VQmtjAPAI5eB6FI9BHjCXXIeIFAMwrkctq39XYYC8a2i3i3H+ZjeFiitbn1+dMD9I6mTh98gIeS4wP0XFVQMDmUgSI5TtOyuTMy1ZLiyQmQO7XLKQaAo7o/kuOmO8DvpJ10wJ0YHVlntO6z+cdvlLPabNK0edGGm8OAm3bwpx1lUqeyp1qshY+8dS9xsLMWg93eg3ZESGk4F/+iLrdrUkRBvPDbTMnq8EKN1RBLM6zPh9vUw/Uu92a4Sz7cJ4+UV8HwKhmkR4wmn1SS6e4+Uz7Mpdi7e3Ex28BbsSaN4eiEHypicj1NE75XRQrSJfppREbKAzH0Soxx6YNOB5fMThpzkm/fPRbMpeiuLeNwi6swR2d+NFJ42e+Te5MmTGHv354HPswHzWE3G2BpxLLI6Rg388m+GbaydFWy+WJoCRMdYXI9VZmqKcRm5/q8ufCRC0x2rd3h2keG/0/9CzgdS/j6vrjFz/TMw9KiSc6iClbKaIR0J+QI6HNRf4tIZWrcdcG77PLcwrrP1EIUOb5T67VcqM/Bbjby+ntFYdUIq8ZgUnRy5c2Xeudq/5OX3tYH9uGn5v0kvO2Zu5XAQlvJL5WpJzGtHXO/ud9kW+1Iec36JM+p5M6XR659072U11e3n9Rm8y9utIDW +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Disable automatic ad-break detection for a channel. Stops the per-channel detection scheduler. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-detection-enable.api.mdx b/ads/api/reference/post-channels-channel-id-detection-enable.api.mdx new file mode 100644 index 000000000000..3767aa16b4a3 --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-detection-enable.api.mdx @@ -0,0 +1,101 @@ +--- +id: post-channels-channel-id-detection-enable +title: 'Post /channels/{channelId}/detection/enable' +description: 'Enable automatic ad-break detection for a channel. Starts the per-channel detection scheduler.' +sidebar_label: 'Post /channels/{channelId}/detection/enable' +hide_title: true +hide_table_of_contents: true +api: eJy1Vk1vIjkQ/Ssln0BqAszO7GzYE6usZtHuKFGYjwOKlKJdgCduu8d2N2EQ/31VdgMdYEd7SS5p2tXles/PVW8rJPncqTIoa8RI/GlwrgmwCrbAoHJA2Zs7wieQFCjnKFhYBwj5Co0hfQXTgC54CCuCklyved+K9/mKZKXJXYlMlOiwoEDOi9Fse7L7RJIJaqHIgV3EjPtdRCYUR5QYViITBgsSI9GsTqTIhKPvlXIkxSi4ijLBuxYoRlsRNiUH++CUWYrd7oGDfWmNJ8/rbwYD/pdbE8gEfsSy1CpHrqr/zXNp21Y+lFLxEuo7Z0tyQXGeBWpPmShbr7Yid4SB5DhmfYn1kyrIByxKWK/ItMHCGj00X2aAHtDAZHoLv/06GILEQEEVBAkOE3OCLxN55YMtxt5T+Js251t/sHapCW7GE0ihgBwLT7SBypOMJ8wFeXI1ud6yUpIkdKYfxpMu8BFcwX1Dd4ytyUjroLQSolj8xbIOikgik+eFfV1RWJFrye9Ue64yvilP+aMG7wllzxq9AWsa6gCNhKpkvn6HYJeMWAWoFUZox5QUq+lL5aP0ycjSKhP8FdzQAivN2rYQj7cFa26tJjQRV+2+KiPt+qM/h3Tz5R46jtbKyC6sYxgoA4XSWnnKrZE+A5aes1ors4SVXcMCHcwxf0qXSmNYWFeAtvYpgU8kc1mStKrJ8WOpcUPupOxfBvwHnXdQKFMF8t0kN2MDeAoMiJ5zXXlV00dlVFEV+wtU4HP6eT0YvB9eX7959/b928H19fDAgTKBluSYA3XhND8b9b06qlodLvdFdTCO28XCU7hE4z+qJtAYyOQbsDHslMbRgbqGtQ054KzxeUUoIThU2oMj1BAvkTUnQvoj6s1zS4sRHtARUI264usIuERlfABj15FRn75PFb2kfgAdY5uVLkP+CaHFnvrBJXJTtzul5K+qQNNzhDLqVirPOIGDDxe41T7PCC+T4MZ5UDVNE4fnuyRCCjRqQT5A8xFwda5GzYfQ8A8oa+583ECOcgRZ8YbcwzDulMT7kqrh64iyKXYi9SviaypvOpXyDcwTgIPXQcgSnaO/oA4eL+BoQY5MTse23gxjxth0EWuO03wEj2vUOtc2f3qEztnU6YJ18FgG/wgdUxXkVA6lI08mxGmZ7gxPtah4MgxkJg452QAELx7O5LhrD/AZt5MWuAujI2uN1mM2O/9GeRC7XZw2L9pwOgy4bwZ/3JEndSx7ItlaWB/27sX3Dtaid9i7lyYFV4ZLti/iZr/ENRQUVnafKDqdsBIj0cdS9ethf5+5vz2k3vUPufuH3J7yyqmwifZojl7l44oTzR4yYd2SS509sIfZB07ZmCS70Qo/1cP4bhLne6fy5LhHdOOA9JQ7CtAp0fu1dTIeW7Q6cchxvmPvWIVQsuqaMk63uHVLNOpHEsLLbh+9G7dgckf39tyzbtlLR502wFKxYeGzUWZho3lTQfPSbRnUF0VrGEsP47uJyERNzqed62G67j4UGM1as8Od9QH+N/Mv0LT84Oub4gZ+oOfQLzWqaCsqp7mMJKMZc8OYhyz9BpDIxKhtgQ/Z49WLqB4ysWI5jmZiu+XL9Nnp3Y5ff6/IbZKsanQqRkdHnnyQPDja/6Sls/eAXfipcb+Ibn/iZsOoUFf8S2TiiQ1ry9jvHnbZXjlcXlof5zmVofXlmWPftW/k3e30k9jt/gVD3n8Y +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Enable automatic ad-break detection for a channel. Starts the per-channel detection scheduler. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-events.api.mdx b/ads/api/reference/post-channels-channel-id-events.api.mdx new file mode 100644 index 000000000000..30ff455e18ff --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-events.api.mdx @@ -0,0 +1,87 @@ +--- +id: post-channels-channel-id-events +title: 'Post /channels/{channelId}/events' +description: 'Post /channels/{channelId}/events' +sidebar_label: 'Post /channels/{channelId}/events' +hide_title: true +hide_table_of_contents: true +api: eJzFVk1v20gM/SvEnBJArus9LArf3I/FGrtAjCTtxfCB1tDWNNKMMkPZUQ3994Ia2ZYdI91NC9QnSyIfH8nH4exUiR4LYvJBjec7pSmk3pRsnFVjNdVk2awMeXAr4IwgzdBayt+oRBmxKJEzlSiLBamx6r5OtUqUp8fKeNJqzL6iRIU0owLVeKe4LsU4sDd2rZpmEY0p8Huna7FInWWyLH+xLHOTohAafg3CateDKr0rybOhIE8n5M9z+csTDZieGHrv92nRhixLUmfcEkVWf0Sm53ifxAXIamBT0Bt47wkfAlRWkwfOTIigUFSBYUkgpHWVkwZkcB6WtHKeomWLINGMfh7oszWPVUcRzLEjW8OZsSddgZl3G6NJw7KOH6rArpD2ecCK3WBNljwyadhmZMEVhpm0ZF4Y+y/ZNWdqPLpQh9jhc25/VwXagSfUuMwJtAlljjWIMaycP63tDyIERs8v1bo1eGW1ccV7w67YTV+i85hfn8Sx9YsDWbf8Simr5tRZ9N2+CKWzIUrxj7ej/yVk1NrIJ8xnPUmvMA+UnKk89SQNnPDzOt2bggJjUcbuHqoPWwzQ+SWAAdDC9O4G3v35dgQamaQmEFtxcQp+42S9iu9PztElyF8wAD8j+VeU4UzhRu8P6ssyT3rKuiz5U4YfaYVVznDb6b4NKEJtNT7Vsh1c4EFX1DA4bIdBW5EgjHEteydmGyTsaYyZCwzDPcJwd4BohgeMgjhz+2gqiStprIZYmuFm9APnQGnlDdft8ltiMOmkEvf5IlHOryWL+UI21N7wTkY2DmLP/Lx7k9kUHqiGqyqQl5pfA1oNgVJPDFclhrB1Xl9L19pDQErd4h3bmDGXIpKOxnmIG79Ga761xe7J+bCZM0JN/ribnwbOrwetCLoAWJp/qG7bJgfS7XEHf3rCoswvqLKTVhyw41MXojd/duXaVW9YYNRNyeaLoS1MdIDJbKoStSEfIuhmJC7SvQLb46WD+y/NPzuYuszkMBqWORoryJXP27tCq4u5pC3hRyL4Dlslaty/u9BBjploajxXu90SA332edPI68eKfB1VskFvZPbj9ckE+a8PR/cZv8M+UFe33Whew4u3rIsZ7Rtoa8kE80qeVKIeqD65hTWLJtkLQejF7x8iicG9oBz9ny2oJtl7TNKUSn7RdtEbxNnN3b1K1LK7zRVOi4/HrVwLcRu5urYo7SC173YqR7uucC22EVN+3wEklK5T +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Post /channels/\{channelId\}/events + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-integrations.api.mdx b/ads/api/reference/post-channels-channel-id-integrations.api.mdx new file mode 100644 index 000000000000..2819d74810b6 --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-integrations.api.mdx @@ -0,0 +1,102 @@ +--- +id: post-channels-channel-id-integrations +title: 'Post /channels/{channelId}/integrations' +description: 'Create a channel integration.' +sidebar_label: 'Post /channels/{channelId}/integrations' +hide_title: true +hide_table_of_contents: true +api: eJy1Vk1v4zYQ/SsDnhJAjtc9FIV7cpNFYWyBGMluL4bRHYtjiRuJVMiRE9Xwfy9GlG35I/tRYH2yyOHMm5n3ONwoTSH1pmLjrBqrW0/IBAhpjtZSAcYyZR5l+0YlqkKPJTH5oMbzzcnhqSbLZmXIg1sB57TzIieNWFTIuUqUxZLUWHW7U60S5em5Np60GrOvKVEhzalENd4obioxDuyNzdR2u4jGFPgPpxuxSJ1lsix/saoKk7Zwh1+CoNr0XDlL96sWeOVdRZ4NBVnXaCYhEH+gJn4fpfWnc1lBcDeZAooVPFETYOV8m2IgvyY/CEYTXD0+TqbXIFnewIShIAwMzhKYALsMfwddR5AUPaEn8FS6NekbeI9pLstQYgNLTJ8AGUrXubnQFXgxnBsLaMH5DK35d98sw1S2+ZTG/kU241yNR8lpQRPZnkbTwy56j41sGn1ekU/WPNeX0ZgDBzpgfR7AzLu10aRh2cSNOrArhTAesGY3yMiSRyYNLzlZcKVhJi3ZfCOJuHCK9PYCRLEEbcSsNBbZ+Rv4LJ37524y/TyGXr/7zUUNxgYhTawu2bpU47nanVSLM1TbPq/ncTc5ZtvhkFt+oZTVdrE9Pid6aBdC5WyIhP3l3eiHiI9aG9nCYtYj/gqLQMmJFg6iPCvmm/oGzk04qvGSCmezAOykVGfNSttrRk/4PMhHU1JgLKtIgH6UI9ZjgM5LAhiE/tPHe/jt13cj0MjEpiSIAS8i+BmS70vuDX7+JF1dyvDHBHEDt7X3ZLlowNmi6SkCrr5DEdf/TxJG7v7+HOg0ciDIuUDEx3FSd7TCumB46DTShhFSt/kJlVXlAg+6QGGwjzjo1SFIeMxksqlpf3mRqJI4dzs/7RyUe0gNsTLD9Wi4czzc7D1vhyeuA6W1N9y082eJwaSTWpzMF4lyPhOU84VMt53ho8g3irJnftrQyWzazourOpCXwXoNaDUESj0xXFUYwovzuu1PeyFIKVt/B9LkzJVQpoNxGuK+N1d6RNxP9ZxQkz/M9deB89nA6EMArMwHatq2yOX0cJjf71+xrAo6n8LzHWUWUSu7z73PPclETHblWtUZFl/qvmLzt6EXmOgAk9lUJWpNPsR01iM5Io0ssb0nO9gzmbLf1cqj8vSu4W8+nzroTK88rAo0VpDUvhAvkVJzqZXAHR2EISHHfZGYE3bmQsrxXG02Swz0yRfbrSw/1+SbSLA1eoNLqY282kyQ/3o/Ad7M5+qh0+o1fPVxdzGvXe9tI/lgUcuXStQTNUePv+1im+w4JPDi/m0EMfgYL4Td+bM5t012JyZpShV/1bav5Nn940eVqGX3iCydljMeX+Q1ii8Rq6tikcebuLZRBdqsxkxso0/5/Qeb7+hp +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a channel integration. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-marker-rules.api.mdx b/ads/api/reference/post-channels-channel-id-marker-rules.api.mdx new file mode 100644 index 000000000000..518c95df07c7 --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-marker-rules.api.mdx @@ -0,0 +1,115 @@ +--- +id: post-channels-channel-id-marker-rules +title: 'Post /channels/{channelId}/markerRules' +description: 'Create a marker rule.' +sidebar_label: 'Post /channels/{channelId}/markerRules' +hide_title: true +hide_table_of_contents: true +api: eJztV1Fv4zYM/iuEnlrAaa57GIa8Zb1iLa5bg6bdDggChLGZWFdbciW6qRfkvw+U7cZOc4c7HAZsw/qUyhT1kfz4idqqhHzsdMHaGjVSF46QCRBydI/kwJUZnalIFegwJybn1Wi2Pdh0nZBhvdLkwK6AU4I4RWMok51aLArkVEXKYE5qpJqv14mKlKOnUjtK1IhdSZHycUo5qtFWcVWIsWenzVrtdvPamDz/bJNKLGJrmAzLTyyKTMcogIafvKDadlwVzhbkWJMPtt4TTzoBbRUmiZa9mE16pgcYooPAb4t6EwSXsE8S5OTWlIA2bENCmPIiC5kVSw+blAwgLB3hI2gPgjUpM0pg5WwOnGofch8BekCoAUCOhaS0QWWXnyhmQRVbU+P/nmA+UDV4xqwk2LsDhISYYqakZUReegaPrP2qgpV1e6zAFnLkOD2KkQwuM6mzsGeFZcZtyfsw/kiJU+q61R5IgKGgSMqQiTpxNTZtzRm8r316ASFuOxiW1maERkDo5vzugQ9GP5XUJTzoPaE3mlNteqSGibPPOqEEllX9ofRsc2G/AyzZDtZkyAW4oc4218yUCKRcmxsya07V6Dx6WxHPjjC/D8uHOKfhG8iefn9CID9J6GdwUTpHhrMKrMkqWFzdTBdyMJkyV6OZurqZqvmRk1uCXh/J0Nv+3tM5HN3EuS9ZoAH5r4iYj8Z6dTNtIwzxtswaweLi4XIBJ4vLj/eDj4PwD+Pan0ruF+/H95d3499+6Vh0loJdNxcXD5cqUq8WR/Ky6wrUrFuexrTXe70szt/0QN+bkDQs+MIaX3foD+/Ov0nXjnf6CjNP0f+i9w8QvThcp8mY31L8XufkGfOi7Z2+BG3QQ7O7ToeB6+kt/PTju3NIkIl1Tk2GOifvw+zJ7ffr69+npsfA/wdl8N8tfFpGtW9Rvz0Bu01wXBP7GWgucrhrhDFgkY4OIih1UYX1PGj44wev0+SgTtxdmVFAg2sZVtWvdTrr5XmkcuLUtm7CaCt3kxpioYfP58PW73D76ng37Hv2FJdOcxVG4SV6HY9L8TGbR8q6tWCczWVebQ2noti1HnXMD2s/nlzDI1VwUnpyMiqfApoEPMWOGE4K9H5jXRIqGe6A0I7ib8+vlLkQdjUwDo+4dWs0+s+Qyk5fvs7pKWFCbj+pvwysWw9C9ZsDsNAfqApFkfvobj+RX75gXmR0/LI51OuuQtVToIhJS7++AoRm7bfm3rCBJYwWRTIrG1RfsyAJd9XvmjYwTjyMJ9cqUs/kfJ2M53PZIizIMVysTdAT6xm+hge93Hau7c++ohqwTC88LDLUQUVLl4U3SqDhTBIsKM+lcRoIKlKj7pupi2IeqVR4PJqp7XaJnh5cttvJ8lNJrqpJ+YxOS7Lrt5v2TeKbQeGzYZzcNRJwCl984h0Nq+WLqSQcuWLVSKlIPVLVewLu5ruo5Z3Aq79f1CAGjdq0+9+MQ7uo3TGOYyr4i7bd5p/cTu9VpJbNUzK3iexxuJE3KW5qrLZ4nS/C2lZlaNYlrsW29il/fwEVi0rq +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a marker rule. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-origins-origin-id-disable.api.mdx b/ads/api/reference/post-channels-channel-id-origins-origin-id-disable.api.mdx new file mode 100644 index 000000000000..c227968d2a6e --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-origins-origin-id-disable.api.mdx @@ -0,0 +1,68 @@ +--- +id: post-channels-channel-id-origins-origin-id-disable +title: 'Post /channels/{channelId}/origins/{originId}/disable' +description: 'Disable an origin within a channel (sets `enabled` to false).' +sidebar_label: 'Post /channels/{channelId}/origins/{originId}/disable' +hide_title: true +hide_table_of_contents: true +api: eJytVttu4zYQ/ZUBnxJAXid9KAr1yUC2iNEUNuJN+2AY8FgaW9xIJEOO7HUN/XsxutiK7d122774Qg7nnLkd8qBSConXjrU1KlYPOuAqJ0AD1uuNNrDTnGkDCEmGxlAON4E4wJKMGKZLYAtrzAPdflCRcuixICYfVDw/nDkfp2RYrzV5sGvgjDqfclKLhUPOVKQMFqRi1e6OUxUpT2+l9pSqmH1JkQpJRgWq+KB478Q4sNdmo6oq+nvYJrSvoDab3wm6EOPgrAkUZP+Huzv5SqxhMiw/0blcJyichp+DEDv0/GGaatnCfOqtI89a/NR5jZTrLR16WYn/cYKBMx26iq4ot2YTgK1k4CySSCWekCkd8aX/T7qgwFg42GVkeqmEHQZoD0aAQfpnPJvATz/e3UOKTKwLggbjKmjbTZeQf2TEGfl3ATj0rBPtkCmANqA5HANdecLXQUpMiXiANercbsn3UFfW5oRGYPUVxBej38pjYPqY0qu8m545d/FYFmgGnjCthynVweW4BzGGtfVnPXjh1Hltveb9peNf2mjA+pR8N5u9Qv8Mud2Rh4LQBMj0RnLX+fsAD7TGMmepPdz1sE1ZrMgLdrNwjvsbGr2mwMK+QJbuQiknYdEGEsPyYTR7XEawfHyaLSOwHpaPH2fTpcCQKQsVz5WYqEg9Ps3k8+NsqhZX4i99/g0KL89P4GyeUwqrfR17XXM41TyQ3+qEruS26s/0XMofvVMZQW4PnXqyV5D+dJyY29VnSlhV4v5MTpt8w3OrDTUDGeZaB2SElbOBBy2HMDiSGTRpDYNOjgZpI83CDzcir2rSmAiTgjiznbtahzlTsRqi08Pt/bDzPzwcAaphizA8dBDV8IQRKCmbHpwf1AqDTkaluJwvImX9RqjPFyJ7neFMtKxRqJ75eRVH0zG80h5uykBe5uEW0KQQKPHEcOMwhJ31aX2X1OpYD6z4OxUzY3bSJi2Nc4iJ36DRf9YZPhvfWu0zwpT8Se+/DKzfDOpWaAHQ6V9pX9dKm7Wt9V5zLlsTx/p3TTsYpQFG07GK1JZ8aJC39/X02sAF1vreIkxtYPgXNXgXV+8y+c+3dBsn0xceuhy16U1d0zlzSYIEd3+akKAiFfenpSUvy71Ls+O/iFQmzRjP1eGwwkAvPq8qWX4rye+bVtqi17V1/VpoTqbHi++rCbh5bqf4Fr75qLgaaFdlI/O8xbyUfypSr7R/9+ioXxL/D6ULsf8eRsfcVosq6tpX8tVsj5KEHPcOXrw0qr5ATCezT6qq/gLrwW8y +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Disable an origin within a channel (sets `enabled` to false). + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-origins-origin-id-enable.api.mdx b/ads/api/reference/post-channels-channel-id-origins-origin-id-enable.api.mdx new file mode 100644 index 000000000000..cf27bc142feb --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-origins-origin-id-enable.api.mdx @@ -0,0 +1,68 @@ +--- +id: post-channels-channel-id-origins-origin-id-enable +title: 'Post /channels/{channelId}/origins/{originId}/enable' +description: 'Enable an origin within a channel (sets `enabled` to true).' +sidebar_label: 'Post /channels/{channelId}/origins/{originId}/enable' +hide_title: true +hide_table_of_contents: true +api: eJytVttu4zYQ/ZUBnxJAXid9KAr1ycBmkaApYsSb9sEw4LE0triRSIYc2esa+vfF6GLLl91u0L74Qg7nnLkdcqdSConXjrU1KlZ3Bhc5ARqwXq+0gY3mTBtASDI0hnK4CsQB5lQbpnNgC+xLuv6gIuXQY0FMPqh4ujtx/ZCSYb3U5MEugTPqXMpJLRYOOVORMliQilW7+5CqSHl6K7WnVMWCFamQZFSgineKt06MA3ttVqqqon+HbSL7Dmqz+U7QmRgHZ02gIPu/3NzIV2INk2H5ic7lOkHhNPwShNiu5w/TVMsW5mNvHXnW4meJeaBIud7SrpeV+KcTDJzp0BV0Qbk1qwBsJQMnkUQq8YRM6YjP/X/WBQXGwsEmI9NLJWwwQHswAgzSPg+TJ/jt15tbSJGJdUHQYFwEbZvpHPLvjDgjfxSAQ8860Q6ZAmgDmsM+0IUnfB2kxJSIB1iizu2afA91YW1OaARWX0B8Mfqt3Aem9ym9yLvpmVMX92WBZuAJ03qWUh1cjlsQY1haf9KDZ06d19Zr3p47/tRGA9an5LvR7BX6d8jthjwUhCZApleSu87fB/hISyxzltrDTQ/blMWCvGA3C6e4f6LRSwos7Atk6S6UchIWbSAxzD+OJvfzCOb3j5N5BNbD/P5uMp4LDJmyUPFUiYmK1P3jRD7vJmM1uxB/6fMfUHh5fgRn85xSWGzr2Ouaw6HmgfxaJ3Qht1V/pqdS/uhIZQS5PXToyV5B+tNxYG4XXyhhVYn7Y9JtvuG51YaagQxzrQMywsrZwIOWQxjsyQyatIZBJ0eDho7Qw5Woq3pqLIRIQZzZzlstw5ypWA3R6eH6dti5H+72/qthCzDcdQjVcA8RKCmbDpzu1AKDTkaleJzOImX9SohPZyJ6neFElKzRp575aQ1H4wd4pS1clYG8TMM1oEkhUOKJ4cphCBvr0/omqbWxHlfxdyhlxuykSVoapxBPfoVG/1Pn92R4a63PCFPyB7X/OrB+NagboQVAp/+gbV0pbZa2VnvNuWw9OdZ/adrAKA0wGj+oSK3JhwZ5fVvPrg1cYK3uLcLYBob3l+AorN5N8h8v6DZIpq88dDlq0xu4pmumkgGJ7PYwHEFFKu4PSstclnv3ZUt+FqlM+jCeqt1ugYFefF5VsvxWkt82bbRGr2vr+p2gQ6v/7ZX33eivntv5vYYfPicuxtlV2MgkrzEv5Z+K1Cttj54b9Rvi/6F0JvPvYbRPbTWroq51JV/N9ihJyHHv4Nkbo+prw/hp8llV1Tf+/2wO +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Enable an origin within a channel (sets `enabled` to true). + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels-channel-id-origins.api.mdx b/ads/api/reference/post-channels-channel-id-origins.api.mdx new file mode 100644 index 000000000000..185c7ba99c7f --- /dev/null +++ b/ads/api/reference/post-channels-channel-id-origins.api.mdx @@ -0,0 +1,98 @@ +--- +id: post-channels-channel-id-origins +title: 'Post /channels/{channelId}/origins' +description: 'Create a new origin within a channel. The channel is taken from the path.' +sidebar_label: 'Post /channels/{channelId}/origins' +hide_title: true +hide_table_of_contents: true +api: eJzdV01v20gM/SvEnBJAju2i+xH35G27SLApYsTp7sEIENpDS9NIM+oMZcdr+L8vOJJt2XFbFPtx2BySSOKQj3zkE7VWmsLMm5KNs2qg3npCJkCwtATnTWosLA1nxgLCLENrKb+A+4y2F2ACMD6Rhbl3BXBGUCJnFypRJXosiMkHNZisjwJda7Js5oY8uHk8tvWuEmXEQtyoRFksSA1U8/Raq0R5+lwZT1oN2FeUqDDLqEA1WCtelWIc2Bubqs3moTamwL84vRKLmbNMluVfLMvczFAAdT8FQbVuuSq9K8mzoSBXZHGaS0TJY45VzmowxzxQcpTXHxlxRh44M2FbwBI9m5kpkSmAsWA47Mo39YRPHU1MM/EAczS5W5C/gDFxrIuxhg3msMC8InAWZpGjN4BzJr9ErwOwS9OcwDAsDMZTNeCuNkH+AlldOmM5wNloeP/2CrSjANZxBJLK0fMLeFenJv4gZidkNDWdOpcTWrVJlGnq0M77ozWfBV6dsdmxewEj7xZGk4bpqua5CuwK4d0DVuw6KVnyyKRhmZEFVxhm0hK6MPaGbMqZGvSTY3K3rXGM5Koq0HY8oY6ZaxPKHFcgxjB3PmKoYbay2zstvXHe8OqA6t4xzb82NIHzmvx2RFptPIgXe15z50pgbyg01OgGRKgHJ3dLCiyFz0yayb9bIIBWQxUoRI9z48UsQwZPoXRWhwu4cUvyUBDaUB/3u9NvwFKKbBYUAD0B5hJJH3Ldi8XGZ1NUhRpc9no/9S8vX/3w+qfXvcvLfuShftR5+awpoLFMKXmpYH3nmJYPaM1c8po7XyDL1CME9oRFU4kBPL4bjq8eE3i8uhk/JtIgj1fvx6NHgUdWAEyUmKhEXd2M5ff78Ug9nGCx8vlXIHy8u4HS5fm+KeMYtugK5BdmRhfwoQoMU1HEBeZGy1FBUyehBqry5mUXbdoaNYlgGps9Vjf9RDNWm0NjEbR4Q6gNtfa86vW/S7lQayOPMB+1NKxRq0NZ26vqi2J9UaAPpG1KubOpNNHJYaqlSg/5pf97U1BgLMp66vdTCUsMjcbpBDAAWrge38LPP/b6oJGJTUFQxzgZ9ECr/xVt/vuqeAr3fyBn3yVhb6IofUFXTghIE9tWxfT/JwTfHHIjm0l7S2lN/b4nW4S0p+O0LByCbuoNd402RAQyzFEHZIRV6QJ3GgyhswPTad40AgdT2cbUbXPnIVEFcea2p+PaJu9b1cXSdBf97tZdd73zt+nuHQaaVXV/TdZqisHMhpWcnzwkyvlUYE0eZA/bGo5Fp2r1aZkfMzQcXcMTreCsCuSl18/jazDQzBPDWYkhLJ3X58JLVL44jOJvT1TGXEoLNDCOQ9z6FK35M1bvaDTj/pkRavL7DfS543zaiTQ3AbA0v9Eq8iAqfLffNN8/Y1HmdLA5NgIsMrHtoZ3v3fV+XHu7ME2jx05udbaxcxd3XsMSSd2WbH43tIShDjAcXatELciHOtlFP4qBC1xgfF00gUcuMHyL44O6tV5E/+jXQpMs0zN3yxyNbU1v3ZITKbhk1d9PmsAbtKfO7Rs7k34eTNR6PcVAH32+2cjtzxX5Vd2gC/RG2Km/T+pVWZ9e7Ntpn901c38OX/2MOZnStnesKEDc6dVAqUQ90ergM2fzsEm2PSjw6udvaxCd+1pWtudfLASbZHtiOJtRyV+1bYvA6HZ8rxI1bT6XCqfljMelfHfhssbqYlHiDMd7a5WjTStMxbb2KT9/AQf48pM= +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a new origin within a channel. The channel is taken from the path. + + + Request + + + + + + + diff --git a/ads/api/reference/post-channels.api.mdx b/ads/api/reference/post-channels.api.mdx new file mode 100644 index 000000000000..70d8d34d7695 --- /dev/null +++ b/ads/api/reference/post-channels.api.mdx @@ -0,0 +1,152 @@ +--- +id: post-channels +title: 'Post /channels' +description: 'Create a new channel.' +sidebar_label: 'Post /channels' +hide_title: true +hide_table_of_contents: true +api: eJztWNtu4zgM/RVCTymQtMnszM42+5S5YLbYGbRo5/JQFChjMY6msuRKtNNs0X9fUHIuTTML7AID7EPz5NiURB4e8tC+V5piEUzNxjs1Vm8DIRMgOFpAMUfnyB6qvgp021DkN14v1fheFd4xOZZLrGtrCpT1R9+jbHKvYjGnCuWqDr6mwIZiWtZE9tUkRuI/KW30+PQP3peW4N3kBLIpoNjCDS2hiaRh5gPwnCBSaCkMysZo0tC7+DA5OYAaeX4I53TbmNDZtuS0D1B7DdNAeBMlFl7WpMYqcjCuVA99pdvwzTjtF5/iU5/efT2HXqCFcfoAFskMjIPKWGsiFd7p2AfBI3hrjSth7hcwwwBTLG6Ss7VFnvlQgfX+Jia/sjPAHjRZ01KQy9rikkI8hHc0w8Zyev7LUH7QewWVcQ1TPIDFnBw4zxCJJR66K2wTTUufjDNVU6kxh4b6qsK7/Pd4OHw9Oj5+8erl65fD4+PRGgLjmEoKgoHRT0P/4sxtQysagNHk2MwMhUM4C75N2E+XKcacLgrgA2DDflCSo4BMOrvrK8NMWtytjPtIruS5Go/2JEPgOJ3NIvG+bHw0LYFFJlcswSez3WyM1xnowF9SANk1Xc8JNXBAYyMEQgtsKgLvgOcmrhkPbyRBEBkDJ4sIGAioRdukoLBE4yKD84uUmJjXZ48eZ3AIPee7JwcJgB/npVplcLgvRw4regrJH02FbhAINU4tgTZR4gQxXtfLViU/AbzOvJ0UbFq6yBg+PSUDUqEzM4oM3SIQ70KLVpLQ4Q+oWyl5qdcNq0E3ciCgA0wn5Rp4DNXo53C7c/ZE258YX+d5DgtM7MLcCXD4cyIUik4x7mHHZ6F3oBkFcgVtuqi0aN2kGLtm5B3giihjuF6gtYX1xc019E4uTuG3X4cj0MgkZx1InV/XHK+h55qKgimgDhTJcVKCXDOMVZ0YT04CuVTrPVVf1RzV1RM6PmSpkQYuC9ZxbSz99DsVrB4emwpm6UasvYtZbV4MR/9Kq1BrI4/Qnm2p1gxtpP6ukCWZ1BPeD3iKPGd6q/pggRG6lX3AKLXwBFnISOyt1P+rfBJTIS68d9KB9gjJtznxnLIyVMim6KpkvRJC42Ln3nYbPifUA+/sUthZdLOJ09DUgtfvwL6UiA1DazCFttmSkjdH2sTUF8np2hvHO/qa0rsV1tR7S+iex4L/MhbsY8eznj/r+bOeP+t50nOj1VZwe6SjvyWt+zV/pw3nZMB5J/zpRFHq5PaJVmNV+8iDDocox2MZxZe3q1tXfVURz/3KWIJBeT1RR1ibo3Z0tLU6UtEEw0s1vrxXU4ymmDRie3nVVz6UcuLl1cPVxvBC5os8NWyZ76Z1cnaSZLrXRApS6gdJ5yIVgRh6Nca48EEn9NPEkrRK9tu0gDlzLeTp3Ng94jSU6MxfOZ+Pm7aR59JJKahVW1J3Ax/KQc5YPgBrI3OHQCzT0/nmm8D7O6xqS/ve8VdU2NHTYdaWzdPHOjFcu7E22N/XhvvbwXC7hrZ4KpLmZl4cZcPisTqt2Xw1tICJjjA5O1F91VKIGbR2lBtO5ArTuNh5deYjwzYvHmG9NXT+8ItKhynTHR/VFk0aOZpg01eTRL9LAVy8GUlZbLF1LiQdX6r7e4nvS7APD3L7tqGwzExsMRgpqETG/iq1QtmblJO32b3BZ3FCzG2TE7wzHz/0VysmRUE1/6Ptdh2dnV58Vn017b4XVV7LmoAL+ZaECzVWSupUVqfSSPfulUVXNliKbd5Tfn8D+WZ5yA== +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a new channel. + + + Request + + + + + + + diff --git a/ads/api/reference/post-origins-origin-id-disable.api.mdx b/ads/api/reference/post-origins-origin-id-disable.api.mdx new file mode 100644 index 000000000000..597523169f6a --- /dev/null +++ b/ads/api/reference/post-origins-origin-id-disable.api.mdx @@ -0,0 +1,65 @@ +--- +id: post-origins-origin-id-disable +title: 'Post /origins/{originId}/disable' +description: 'Disable an origin (sets `enabled` to false).' +sidebar_label: 'Post /origins/{originId}/disable' +hide_title: true +hide_table_of_contents: true +api: eJyVVU1v40YM/SvEnBJAXic9FIV7MpBdxGiKGPGmPRgGTEu0xY00M5mh7HUN/feCkhxrHTfFXvwxw+Ej+cjHg8kopoG9sLNmZO444qogQAsu8IYtXEWSCEuyep4tQRyssYh0/ckkxmPAkoRCNKP54czXJCMrvGYK4NYgOXUu9SGrgUfJTWIslmRGpr2cZCYxgV4rDpSZkYSKEhPTnEo0o4ORvVfbKIHtxtT1Qo2jdzZS1Ptfbm70K3VWyIr+RO8LTlFjGn6LGtih5w+zjPUKi2lwnoKw+mkSTIzvHR1MmqO1VEwy/fN/mXbGIDnHYyVXVDi7iSBOK3CWSWLSQCiUjeW9/69cUhQsPexysr1Swg4jdA8TwKi8TWaP8NuvN7eQoZBwSdBiXATtaH0P+XdOklP4IQGPQThlj0IR2AJLfEt0FQhfBhkJpeoB1siF21Looa6cKwitwvIFxGfLr9VbYvxW0otxtz1z7uK+KtEOAmHWNHHG0Re4BzWGtQtnPfjOqQ/sAsv+veMvXTbgQkYBdiw52z7Rv0PhdhSgJLQRct5o7Y7+PsEdrbEqRLmHmx62rcoVBcVuD85x/0TLa4qi0Zco2l2odBKWXSIjWN6NZ/fLBJb3D7NlAi7A8v7zbLpUGLJVaUZzoyYmMfcPM/38PJuaxYX8q1B8EMLz0wN4VxSUwWrf5N5wDifOI4Utp3ShtnV/pudKf9Kbpxa5e3TqyR4h/ek4Re5W3ygVU6v7Mxlr6w1PnTY0EegwNzqgI2y8izJoaxgHR+0ZZK3+aTC4UVEzj62JwpYkuTu+bdRPcjMyQ/Q83N4OO2fDw9FbPTy5i5RWbW/ND2aFkdNxpa/ni8S4sNGQ5guVs6PhTDWqVZ6e+Tk74+kEXmgPV1WkoH1+DWgziJQGErjyGOPOhawR60b1mkFUfyeSchGv9HdhnEM8hg1a/qep3NlYNiqeE2YUTjr+feDCZtBQ3AGg5z9o33DAdu0aHWcp9OrRC//FtINxFmE8nZjEbCnEFnl720yli1Jio9sdwtRFgY/L/UMKvX3wswuuy0Douwx9gWx7c9LSP9f0NOxbk3Q7LJrEjHrr7BjWIjG5ds5obg6HFUZ6DkVd6/FrRWHfNsMWAzfWzUJtX2ZvK+k/87p66ubrGj7auxfzOdJkddC2WFT6zyTmhfb9vVwv6uTItgbXXo/TlLz0Hr5buHV/dKaPs6+mrv8FoubpRQ== +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Disable an origin (sets `enabled` to false). + + + Request + + + + + + + diff --git a/ads/api/reference/post-origins-origin-id-enable.api.mdx b/ads/api/reference/post-origins-origin-id-enable.api.mdx new file mode 100644 index 000000000000..13c8a578cd17 --- /dev/null +++ b/ads/api/reference/post-origins-origin-id-enable.api.mdx @@ -0,0 +1,65 @@ +--- +id: post-origins-origin-id-enable +title: 'Post /origins/{originId}/enable' +description: 'Enable an origin (sets `enabled` to true).' +sidebar_label: 'Post /origins/{originId}/enable' +hide_title: true +hide_table_of_contents: true +api: eJyVVV1v6kYQ/SujfUokc0n6UFX0CemmCmqqoHDTPiAkBnvAc2PvbnbHcCnyf6/GNsEhNFVf+NidPWdmznwcTEYxDeyFnTUjc2dxVRCgBRd4wxauIkmEJTXn2RLEgYSKrr+YxHgMWJJQiGY0P5whTTKywmumAG4NklOHqA9ZDTxKbhJjsSQzMu3lJDOJCfRacaDMjJQpMTHNqUQzOhjZe7WNEthuTF0v1Dh6ZyNFvf/p5ka/UmeFrOhP9L7gFNWn4feojh16eJhlrFdYTIPzFIQVZ41FpMT43tHBpDlaS8Uk0z//FWlnDJJzPCZyRYWzmwjiNANnkSQmDYRC2Vg+4n/jkqJg6WGXk+2lEnYYoXuYAEaVbTJ7hF9+vrmFDIWES4KW4yJpp+pHyr9ykpzCuwA8BuGUPQpFYAss8S3QVSB8GWQklCoCrJELt6XQY105VxBapeULjM+WX6u3wPgtpRf9bmvmHOK+KtEOAmHW1HDG0Re4BzWGtQtnNfgB1Ad2gWX/Efi3LhpwIaMAO5acbV/oX6FwOwpQEtoIOW80d0e8L/CV1lgVotrDTY/bVuWKgnK3B+e8f6DlNUVR70sUrS5UOQnLLpARLL+OZ/fLBJb3D7NlAi7A8v5uNl0qDdmqNKO5UROTmPuHmX7ezaZmcSH+KhSfuPD89ADeFQVlsNo3sTeaw0nzSGHLKV3Ibd3v6bnKn/T6qWXuHp1qsidIvztOnrvVd0rF1Ar/3uku3/DUzYbGA23mZg5oCxvvogzaHMbBcfYMWm71BTc608xja6GsJUnujk+b4Se5GZkheh5ub4cd1vBwBKuHb2iR0qqtrPnBrDByOq708XyRGBc26tB8ocPsaDjTCdXOnZ75uTbj6QReaA9XVaSgVX4NaDOIlAYSuPIY486FrBnVzcxr2lDxThLlIl7F79w4p3gMG7T8d5O3s6ZsZnhOmFE4TfEfAxc2g0bgjgA9/077RgG2a9dMcZZCrx698J9MOxhnEcbTiUnMlkJsmbe3TU+6KCU2U7tjmLoo8Gm230XQWwb/b7d17gv9kKEvkG2vRVrp5xqb+nxrkm59RZOYUW+TdT4tEpNr0Yzm5nBYYaTnUNS1Hr9WFPZtIWwxcGPdrFKO3WTultG/BnX11HXWNXy2cS+Gc5TIaottsaj0n0nMC+37G7le1MlRaXWuvR6nKXnpPfywaut+10wfZ99MXf8DOQzmIQ== +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Enable an origin (sets `enabled` to true). + + + Request + + + + + + + diff --git a/ads/api/reference/post-origins.api.mdx b/ads/api/reference/post-origins.api.mdx new file mode 100644 index 000000000000..b7ebd14f6f27 --- /dev/null +++ b/ads/api/reference/post-origins.api.mdx @@ -0,0 +1,97 @@ +--- +id: post-origins +title: 'Post /origins' +description: 'Create a new origin.' +sidebar_label: 'Post /origins' +hide_title: true +hide_table_of_contents: true +api: eJzdV9tuG0cM/RVinhJgZUtBerHypCYpbNSBhchpHwQDpjTULpPdmc0MV7Iq6N8Lzq6ti520QZE+1A/yXsjhmXPIM9LGWIrzwLWwd2ZoXgdCIUBwtAIfOGd3YjIT6HNDUX7xdm2GGzP3TsiJXmJdlzxHTT/9GHWNjYnzgirUqzr4moIwxZRWoHNUXli9Oax7YckJL5gC+AVIQdAFgxQcOyQwo9K7PIJ4BVWxuySXS2GGg8zIuiYzNFECu9xsM0MOZyV1tRbYlGKGCywjZUe1/yhICgoHlWoMwnOuUSgCO2CJD4hmgfBTz5LQXFeABXLplxROYEKSsLNjYSxhiWVD4B3ME62vABdCYYXB6h7yvCRggSVjymoBn1qO+h/I2dqzkwjPxqPr1+dgPUVwXhKQXFOfn8Cbdmu6HqTdKTMdFzPvS0KnZPATnH9w/FnhtTvmBwVOYBz8ki1ZmK1bLZoovlJtAmAjvpeTo4BCFlYFOfAVi5D9B6I4rOgxkvOmQtcLhDbt3HKsS1yDBsPCh4Rh14yPFq0D+8CyPpC6fyzzr51M4IOlACuWgt1+qw3TzU7X0vsaJDDFThrbgYiwCL6C0q8oihJfcF7o5T0QQGehiRTTigsOGlagQKBYe2fjCVz6FQWoCF1s08ND9itwlKPwkiJgIMBSK9lDrfuJbLzjqqnM8Kzf/2lwdvbih5c/veyfnQ2SDu2r3uN3HYHshHIKymD75FiWd+h4ofta+FCh6GQiRAmEVcfEEG7fjCbntxncnl9ObjNtkNvzt5PxrcIjpwCmRkNMZs4vJ/r5djI2N0+o2ITyKxA+vL+E2pflrinTGO7JFSkseU4n8K6JAjM1sSWWbDVV0bSbMEPTBH7cRdvW5DioY0z3rKoF1sXvcPvZR5qL2R4mSmgoPVCZY+t6L/qDb/JMtJb1FZbjPffsnOu7GuojSVrbsiN5vP41VxQFq7p1gN2Ewgpj53c2A4yADi4mV/Dzj/0BWBQSrgjaGk8WPfDt7+LT/94hn8L9H1jbN9nZq2RQX/CYJ8ykq+2aavb/M4W/HXjWSf/C1O96ck+Q/el42hYOQXd8w/vOGxICHebkAzrCpvZRet0Ro7Uxjwrtqntyk5mKpPD3oYoG9aA1p1jz6XJwusuNNG/avpluzAwjz0eNhk5vMuNDruWmN9ubXeBE/ad1lb3wY+ZH4wv4RGt41kQK2sPP01EXaR5I4FmNMa58sM+V7+Roach0vZ0AhUit0nYwjktchRwd/5lYORo51vcFoaVg7ufN3PV8yHtJvq4A1vwbrRO/6q7vd99d395hVZd0ZJ33LbFnPZ3b8sHbruDD/W42+w+1u65ObbvXxuwWXqsKi5Y3V7Xw70wrGNkIo/GFycySQmwZWA7S5PsoFaazoSs89lFgT+MD3vYOmC99ie8gCt3JaV0iu70BaxtpqtwploFRfR7artBuG07NZjPDSB9Cud3q488NhXXbU0sMrNyltsruRdLm+0RrhdSC612385S+GCepjk7CbXafMZrPqZavxu4PxPhqcm0yM+t+oVTeak7Alf56wZUZGt1SIis1eXq2MSW6vMFcY9s19e8vY15/qQ== +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a new origin. + + + Request + + + + + + + diff --git a/ads/api/reference/post-templates.api.mdx b/ads/api/reference/post-templates.api.mdx new file mode 100644 index 000000000000..5b3c7021ca36 --- /dev/null +++ b/ads/api/reference/post-templates.api.mdx @@ -0,0 +1,7594 @@ +--- +id: post-templates +title: 'Post /templates' +description: 'Create a new template. Backdrop is required for non-SINGLE layouts.' +sidebar_label: 'Post /templates' +hide_title: true +hide_table_of_contents: true +api: eJztXV1vG7e2/SuEnhxAcuKLg4sD98ltc88xrtsEadrzEATX1AwlsZ4hJyTHjhrkv1/sTc6HpHEsx3EjS6sPRazhcPaQ+2NxLVL6NMqVz5yugrZmdDr6ySkZlJDCqBsRVFkVMqhj8aPMrnJnK6G9cOpDrZ3Kxcw6YayZ/Hb+678uXopCLm0d/PFoPKImyocfbb4cnX4aZdYEZQL9U1ZVoTNJT3v+p6dHfhr5bKFKSf+qnK2UC1p5vm0hjVHFec5/rdp5nisT9Ewr54WdibBQIjX3Iiy0b20niwttrlQugiXbdFAld1hqc6HMPCxGpyfjUVhWanQ68sFpMx99bj+Qzskl/U0v4WwxYMsr/ocsRFXI5VRmV6Jpy0NEtk2dkldj4etsIaQX/kpXQppceCMrvmOqFvJaW0cWro4CtX01m3kVNp/8a11OlaMB8CqzJvf8sGutbpQTZe2DuJEhW4ipmlmnOkvEVGW2VNGQSk4LdSx+0UaXdSlekAll/GN0+qIdCMPPopFojN605z8LFRbK9a3QXsiisDc8/sIrdSXsteqNyrH4z0IZoQyZkY+FbO6kttrM15pHDwy1M7FHuuCDdKFxg9iKBpemwwsdhDZiVhfFD8KaTK12lVujxt3EOeVrGhcZuJl1eq5pZtnuynpNL5osXjHUC22SNWmuw0IthXRKyMLb+5jcs3gs5CwoJ24WOlvcamWuZrIuQvpYVFabII7iX9FzxqLvhyKvHUeguKH3MDYIr8Kz9Fr0Z+WUVyaM7zeRo9ZXptYWSprR5y6O7PRPlQVyn+bpm+7zc3qRNSu1ad2b04fKo+EZ5SryEJnumDlbrkb/sWiC8z4Orq6VCdumHW78WElH55s2/G70h1r1ntXadCxeO3utc5WL6TLmxNoHW1KKcELWwU7myignQzOEttQhqDyNyJcsM7JUm7b8uy6lmTglc4pekWvPHkyN29zXzsVooNu+lw5kVv687wApsxY07TcL5ZRIxWUgOjh01vPMhnuvO5sXtVc5ZWm6mmLKsiHDgc9R0LjgjQ6LNv0ft+m9zW4bfdID9dxYKqiUAXoRl5IORXNjVbDp7vu487V0Wqbya5avZqPTd59G1qj0r9VyI71XYcDzz/hzHuVU+tnjU9/H4iyIQkkfhDWqjxJWvP+2h34hJTTzkqKNzes5xDj68ZWxN+Y+Y9IEFiec0enoRfpvwv/7B/3vn82fzX+j8XAkdgG4aiX5gjZ9D7xHeEovpPj99/Of7xuo2gTlZDY8nC1U6bVqsUcbsWx+h1akyAqdXU3Cwtl6vhC/v7nYhCnc5G1ssfncn9Y7ELZSpslC/SqT7PIxktia/Fj8QlhmSrj0WhY6b0yYWVdKmr7a6c3sMlR8SpVr+ZY/XbfxF7ok6A6aRmniMJyKS5oye0lzdKlLOVeX9GhlyLXejfgi+ThdGb0fmJBSl+qWJ57/8rJ9YOc3bKM4otlQH2VZFSrZ8Lys/nH5bNXlz6gmx1zFsekoR+QqKFdqo0RdzZw1gW5hZKaDyKSJOIMDmB/5g7B09UZ7RS0WlPysCG45FqVkEBYtq5yqZApIT1jADSb1MPi2nEHi6+aaLpTayGDdsbj0QQadXZ4KKXLtVBbarO7UTDlFsK3zxjg+1gke88YXmgmJfQ3OBHnJShL8sv+MP3WZa9XZg3RzRdDjCxGWq2tNaLNpKsJCEtAqFHt39Hvtxe9vzpv0vhlVsZNh7/k5PYAGlHtSJrhleqBva1WsS1XMPF54da2cLJrE7cd912msY+xrlChp9RBtbyM0mtQf8Vz5q2ArGkCqcoFylJ3qQtEn1wMzMRSY17KoB17ybRsVNE5t2YmvuhIiPb/44+y3tyLIObnGsztT5ue4XqVixQHNhrwfyh3anEd/OFlHau/XS8OFzVbqVvTKJqUozcEohddmXrALi2gOI3XKPdQv3UyX6G218kLJbBHzor3Ny4433qfLeMnoGAcDL4iqjKqMqoyq3FTla+kD1+R+Pu2/k1PeFteKzZopIppoBeOUydPCK67Qr1eqBfWK6ozq/D2rc2tCkcr0UynJPNivpZMl5ZL4UZ7r+OTXq1GwHl+3RILMRdV2KCp6ArEQsSYktvJamZwGgapO7FCUsjoW/9PN8Jin/1/W0uCd5eIXaeQ8pgGvmAelji5l/lbOuxe47GWqrRhCAA8ADwCPfQcenG4YesR/TkrOJnkTSUz8kvP+odWNiBd90kIKfa3csuNSY+rqt5G5yFWmvbaG03Nv9rjxl9BJlyKqQmZqYYtcuY1M8EeTL1NpjJlyMzlWNr1SNCyBjbCsdCaLYilqw9NKQk+EUtbwi9WG2eDc3hgfnJLlD40IxDMlRc+4LXJEeu3NKcqb4XPKV9Z4TSQ/OWJv/NigdtgpVLpywZz5T7VzyoRiKawpluJyLstLcbQxGM/6EzGX5eAsxJ6/SQGMczTxlcr0TGf9IrhR5/6gLMN5uFIuvd4PPBDxbaS4pKddiplWRb4ikh9la69f2fzy2UDZuxsjpGkaGIVN5PD+y4ioy5Xrc/5HRJ5Jzd9k6hgdcWiSQDnxmVPKNPqbjsIMy2ImaNcmIUrnlXVhhajjrgan+asQ/KYm8RUYu9LZ1VYIW5w1HXBporHqTNEsVHmdK5Z1muBMFq0bID7UstCzpTgq6yJoSvBNNDP2bD9tb+gvW5TwpLaRxEZz+myclOucy2eSjlsxOlczTYWWAjhX/rT/7rVPCXKmnQ/d6y2s56gvZVgpGNYk1MIO3lpwuOuktRBOITZuNLVt8f291bdxXIZUkjMOIyUpMltW0nDFiHl4K4VOFsUdAiHAOcA5wPnhgnNodWAD94sNhFaHqoyqjKr8lKsytDpU5/2sztDqoNUBeAB4AHjsJvCAVgetDlrdA7W6jaOvDXk/kI9Xef3mzBUFXGHNnESnmFKcLiUFF7c6YiecLsVlbutpoS7ZFS4Lv5CV+j+ZX7Ywlt8X5D+qPao9qj3If9AL+00vgPxHVUZVRlV+ylUZ5D+q835WZ5D/IP8BPAA8ADx2E3iA/Af5D/L/YeT/Wn8d9f/3nepJmsApo6pcTabLCesIqXkMY0ZQqY574Rfk78NnDSJG1zFW6PvP5s7WJqeCpVO09x+zAoLZEhwKwqGgfVmT4VAQFgJYCGAhsNcLAeiCYB73i3mELoiqjKqMqvyUqzJ0QVTn/azO0AWhCwJ4AHgAeOwm8IAuCF0QuiAOBaHao9qj2u95tQf5D3phv+gFkP+oyqjKqMpPuSqD/Ed13s/qDPIf5D+AB4AHgMduAg+Q/yD/Qf4/+UNBnQxwSgn0YsJ/56uHglJE2iyrK50i9GIyo3c7Fi+7E0OLWHq2OyeUEujaE/se1tqGk0I4KbQvC7XvdVJoy1NAkP+A94H3gfch/4Fg3G+CEfIfqjKqMqryU67KkP9QnfezOkP+g/wH4AHgAeCxm8AD8h/kP8h/Dzz785iKXqLn7pL1yClaKm9Q4NsU5FJzqHJQ5fZl/fToqlz8Js0ELu21coVcQpIDBgcGBwaHJAfSD6QfJDlUZVRlVOUnXpUhyaE672d1hiQHSQ7AA8ADwGM3gQckOUhykOR2UZJLfH+MTe1rWTQSQNIFSI+xVUd7kHe24hSnc1dXjLgp6dAhuv68p74G595WMtNhOVDFkgGpQZy+WVfOwo1SRrwQR7Oagio4aXwlaVKesfOeNFdsJT/UKmJS+TGihZM7kENlvb6luCazmhZ9AEDlrbIuHIs3cc49xXgnoNDw0Sg6MbUh2JLtTBcKNQt0xen5ImxW3njDAHTSPkgiUtPUNNOWHqDyuRIzZ8sIUOKHqWlj7fjWoeVhvNe40VtsbyS/86qJcRgez0Ae3u0t5OZrJsbPHtFGWtdtbSE51Kp9vUD99tYNwS2v/xpAAk2g0FV6fPNwv27cprMv1PAsNV3G62vvtNZrajR+0Ezc6DwMAN3GDr58hxnc5iFWrFWQaNK4GaOhNTO2OGCLwxPko+7Y4tAryinl3PJ1xXfuS8D5ZLAfYD/AfmAzBOQWyC3YDIGqjKqMqnyQVRmbIVCd97M6YzMENkMAeAB4AHjsJvDAZghshsBmiF3cDBHREYcmbSCY+MyRchdh7EwXRYNHqQa6Ngn15cyWqOOucA4ZIt2+rJO+17cDj+MypJKccRgpbXyR95YKnSyKtPqGVgdwDnAOcA6tDmzgfrOB0OpQlVGVUZWfclWGVofqvJ/VGVodtDoADwAPAI/dBB7Q6qDVQat7oFa3jh26HxPdzMdrP9CZa59kAVlYMyfRKaYUp0tJwcWtjtgJp0txmdt6WqhLdoXeD4i2MJbfF+Q/qj2qPao9yH/QC/tNL4D8R1VGVUZVfspVGeQ/qvN+VmeQ/yD/ATwAPAA8dhN4gPwH+Q/y/2Hk/1p/HfX/953qSZrAKaOqXE2mywnrCCs/OMgIKtXx5ifRhs8aRIyuY6zQ953Ona1NTgVLp2jvP2YFBLMlOBSEQ0H7sibDoSAsBLAQwEJgrxcC0AXBPO4X8whdEFUZVRlV+SlXZeiCqM77WZ2hC0IXBPAA8ADw2E3gAV0QuiB0QRwKQrVHtUe13/NqD/If9MJ+0Qsg/1GVUZVRlZ9yVQb5j+q8n9UZ5D/IfwAPAA8Aj90EHiD/Qf6D/H/yh4I6GeCUEujFhP/OVw8FpYi0WVZXOkXoxWRG73YsXnYnhhax9Gx3Tigl0LUn9j2stQ0nhXBSaF8Wat/rpNCWp4Ag/wHvA+8D70P+A8G43wQj5D9UZVRlVOWnXJUh/6E672d1hvwH+Q/AA8ADwGM3gQfkP8h/kP8eePbnMRW9RM/dJeuRU7RU3qDAtynIpeZQ5aDK7cv66dFVufhNmglc2mvlCrmEJAcMDgwODA5JDqQfSD9IcqjKqMqoyk+8KkOSQ3Xez+oMSQ6SHIAHgAeAx24CD0hykOQgye2iJJf4/hib2teyaCSApAuQHmOrjvYg72zFKU7nrq4YcVPSoUN0/XlPfQ3Ova1kpsNyoIolA1KDOH2zrpyFG6WMeCGOZjUFVXDS+ErSpDxj5z1prthKfqhVxKTyY0QLJ3cgh8p6fUtxTWY1LfoAgMpbZV04Fm/inHuK8U5AoeGjUXRiakOwJduZLhRqFuiK0/NF2Ky88YYB6KR9kESkpqlppi09QOVzJWbOlhGgxA9T08ba8a1Dy8N4r3Gjt9jeSH7nVRPjMDyegTy821vIzddMjJ89oo20rtvaQnKoVft6gfrtrRuCW17/NYAEmkChq/T45uF+3bhNZ1+o4VlquozX195prdfUaPygmbjReRgAuo0dfPkOM7jNQ6xYqyDRpHEzRkNrZmxxwBaHJ8hH3bHFoVeUU8q5Nz7aYIzOGl4oDlD7m4UEc0WhPaf51m84w7Ye8TXjtcl7cdcDb7LaMrha8QeM16Nb/NeLE16Sp71OBJmrqtCR+Xr+p4/gxWcLVcrbAfVMFl5tLPMX0hhVnOcD20XOWx6kTeSpuY8eGFRJvszbRQptroh3siv7RW5ZSnYolt7J2eIL64Bk9i3JrcGgoumoJT14njvSw1/pihOyN7LiOxqaZDMMqe2r2cyrgcL0K+dqGo/EWPUnvyRa44a8QkzVzCbOLHrcVGW2VNGQigLnPvRWY/SmPf9JRECfc/FCEovA0yG8UlcMIfrEFScLZciMfMwrAb6T2pI/rzaPy6FQOxN7THKoa5FRbEWDS9PhKfdpIwiS/yAsAZmVrnJr1LibOKd8XUb4HPOxnmuaWba7yQNteusZ6mk1Yvtz3SZvWXh7H5N7Fo+FnAXlUvDfZmUqO+ljUVltgjiKf0XP4czSPalhRCPXYyxJFeFZei36s3LKK0pI95rIbhU6tbZQ0gzDNuYeVH424M9vdal8kGXVUXdtWN9IL9KtEVYacf7bK/HP/35xImg1HXSp0jJ7kDf6Ag2cxm9tcDoemMOYr7YmNLC3l3juE0LqWpmwbZ7jxt8uyzXs9ADZ3PXeWrEF4WNkOQAR/l2X0kyckjkFdvOd/IIat2mxHbqhCes78ACi5M/7k5SSbkE5I3J6zbafzcDhqFpPQRuev+4QUbkj5+P1WAw3y4YM5wQOkAYGMefcVIbjNvO3iW+jT3qgnhvLaLQhILvuU6A3VgWb7r6PHzZAYEUp7fZV3qN2/01fvnIPi6D7PJru8zXgCKIQRKHdEYV2f4/oPTLdCvHyNbGJ/SuHvH9ld3aX6nw0vtd+FsABwAHAAcCBw9mcClgAWHAQ21ofEwtg4ysQDxAPEM8hIx7sisWu2APfFXsbxGi3xsYc9x03yEacxVFKevDEZ452c0VAPNNR7GKN0ATt2nzU3+LWspTc1d3fTfNNFgrY1YVdXTu9q+ubrCDuLXeO41Kokpy2GG5t/CzMlpKoLIqHyLVYG2BtgLUB1gYQR8GCggWFOAo4ADgAOAA4AHEUsACwAOIoxFEgHiAeIJ4DRTwQRyGOQhz9duLo/Y6BN4LIQN5e1UqaU4UUmIU1c1L5YupxupQUhNzqiJ11uhSXua2nhbpkl2l+EETmly1a5nGBoAI8ATwBPAFBBcwJmBMIKhBUAAcABwAHIKgAFgAWQFCBoAJBBYgHiAeIB4IKBBUIKt9BUFnrulNM/r6jaUlKOWV8lqvJdDlh+WXll9QZi6V63/zW8/Cxl4j2dQwb+mLEubO1yal26RT4/ceswGm2BCfbcLLtIJZ+ONkG5hXrEKxDsA6BEAvGFYwrhFjAAcABwAHAAQixgAWABRBiIcQC8QDxAPEA8UCIhRALIRYn23CyDXgCeAJ4AoIKmBMwJxBUIKgADgAOAA5AUAEsACyAoAJBBYIKEA8QDxAPBBUIKhBUDvpkW6eenFIuvZjw3/nqybYUnDbL6kqnYL2YzOjdjsXL7tjbIlah7Q67pVy69sS+s7W24bgbjrsdxHpwJ4+7bXmUDXorlhtYbmC5Ab0VxOp3L6R7R6xCbwUcABwAHDhgOAC9FbAAsAB6K/RWIB4gHiCeA0A80Fuht0Jv/XYH2B5TQk3c5F06KvlHy2MOKqqbCmhqDhkUMuhBLNO+rwwav7k3wVd7rVwhl9BAsQTAEgBLAGigIDufShXdO7ITGijgAOAA4MABwwFooIAFgAXQQKGBAvEA8QDxHADigQYKDRQa6I5roEkmiWGqfS2LRjlJcgppXLbqmBty1Fbw48zu6oqxO+UfOibad4HU16Ab2EpmOiw3TX6VDEgN4kzOusoWbpQy4oU4mtUUX8FJ4ytJ8/OM/fikuWIr+aFWEd3KjxFVnNyBMCrr9dcU4WRzc3sfRVAZrKwLx+JN9A1PuaATpWhsaYidmNoQbMkvkS4UahboitPzRdis0PGGAfylfZBEMad5a+Y0PUDlcyVmzpYR5cQPU9PG2vGt485jfK9BpbfY3kh+51UT4zA8noE8vNtbyM3XTIyfPaKNtHzc2kJyqFX7elH87a0bgmVe/6W+MoroVrKtscyvW74ZCQs1PIVNl/H62guv9ZoajR80TTc6DwNoubGDL99hBrd5iBVrZSiaNG7GaGjdjt0o2I2yb4TZHbtRerU+Jatbvjv9YbtEcHYftA1oG9A2T4S2wb4VCFQQqLBvBXAAcABw4ODhAPatABYAFmDfCvatAPEA8QDxHADiwb4V7FvBvpUd37cScRZHKe31mPjMkVQaAfFMF0WDbKlWujYf9fXjlqXkrnBGH6roQSzHdvKrysdxKVRJTlsMtzZ+j2BLSVQWReIOII5ibYC1AdYGEEfBgn73srt3LCjEUcABwAHAgQOGAxBHAQsACyCOQhwF4gHiAeI5AMQDcRTiKMTRbyeO3guAdL8zvZm31367Odc+SS2ysGZOKl9MPU6XkoKQWx2xs06X4jK39bRQl+wyvd+WbtEyjwsEFeAJ4AngCQgqYE7AnEBQgaACOAA4ADgAQQWwALAAggoEFQgqQDxAPEA8EFQgqEBQ+Q6CylrXnWLy9x1NS1LKKeOzXE2mywnLLyu/KMtYLNX75pcrh4+9RLSvY9jQ9yvPna1NTrVLp8DvP2YFTrMlONmGk20HsfTDyTYwr1iHYB2CdQiEWDCuYFwhxAIOAA4ADgAOQIgFLAAsgBALIRaIB4gHiAeIB0IshFgIsTjZhpNtwBPAE8ATEFTAnIA5gaACQQVwAHAAcACCCmABYAEEFQgqEFSAeIB4gHggqEBQgaBy0CfbOvXklHLpxYT/zldPtqXgtFlWVzoF68VkRu92LF52x94WsQptd9gt5dK1J/adrbUNx91w3O0g1oM7edxty6Ns0Fux3MByA8sN6K0gVr97Id07YhV6K+AA4ADgwAHDAeitgAWABdBbobcC8QDxAPEcAOKB3gq9FXrrtzvA9pgSauIm79JRyT9aHnNQUd1UQFNzyKCQQQ9imfZ9ZdD4zb0Jvtpr5Qq5hAaKJQCWAFgCQAMF2flUqujekZ3QQAEHAAcABw4YDkADBSwALIAGCg0UiAeIB4jnABAPNFBooNBAd1wDTTJJDFPta1k0ykmSU0jjslXH3JCjtoIfZ3ZXV4zdKf/QMdG+C6S+Bt3AVjLTYblp8qtkQGoQZ3LWVbZwo5QRL8TRrKb4Ck4aX0man2fsxyfNFVvJD7WK6FZ+jKji5A6EUVmvv6YIJ5ub2/sogspgZV04Fm+ib3jKBZ0oRWNLQ+zE1IZgS36JdKFQs0BXnJ4vwmaFjjcM4C/tgySKOc1bM6fpASqfKzFztowoJ36YmjbWjm8ddx7jew0qvcX2RvI7r5oYh+HxDOTh3d5Cbr5mYvzsEW2k5ePWFpJDrdrXi+Jvb90QLPP6L/WVUUS3km2NZX7d8s1IWKjhKWy6jNfXXnit19Ro/KBputF5GEDLjR18+Q4zuM1DrFgrQ9GkcTNGQ+t27EbBbpR9I8zu2I3Sq/UpWd0bdm1QWmcNcRUHqP3dWQLSotCeC0TrN5ybW4/4mvHaJOa469E4Qk9eb6j8bCjmP2+A6Z+jl4s3cZ2guHdyHF6znOe0XrI+TIIqybmU58mZe3rw2/az94R4w8I2zWmcJWXE0XNZ6efXJ8/793uV1Y5R4LtPo6n0OjurqfG79+ORdXN66Lv3NM5Nw9+yhSoT+Omabyx6Xp+LK7Xkr553RpYqIkOvMkdfSE/s2Y11OUNDzz2OTmN/HaZfhFAxTo1mbCR0N5dG/xXXcx2XxNuK6PpCybiqpMePTkcfJ9bNJzwtjRNV+n/Vkkf5T28NgUPlw482X76MFAFzMAtpjCrOcx93ArCzvx+PaDeBswUPhL/S1avZzKvAxcAbWREQH50GV6sVnu7FeKSulQkb3RGx1vzZmtz+7ZSvS9V7RONnvU1Z7z6tPod73JKfWyO/VnmnPu3SMT0tSdNRMZ29bWrgfRNp3d9XO3bNUhZyBuzc5JHXp3MXjO+vZtc5lYaWYDZgcO3/mcK7Zf1i/hytIZJ+yWpLA6cwbWaWiQIdKGBGLaF0lntx9vqcn+l8jNnrk7TEC6XkIUiO/tr6IFby0kqsfxo1G3lPRz9xShVSGHUjmjuOxY8yu8qdrVZoA4JAxprJb+e//uviZVqC+x5tENTH8LwqpDaRnSroWTFbvqP0QMafUPN+dl1QUj19N/r0aSq9+t0Vnz/Txx9q5ZYxcXJ0Tmk43lEBS5mIIvRKLflnPPhtJomUSLLSSFZVoaMS85wSEntgvOMsy1QVvti2n/dfv/rt7Wg8mtqcl/elzekeJ28ol8ib0emIfueDR5cTGH/2aVRIM6+Jcj0dxT7pv/8HO55V3g== +sidebar_class_name: 'post api-method' +info_path: ads/api/reference/optiview-ads-api +custom_edit_url: null +hide_send_button: true +--- + +import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint'; +import ParamsDetails from '@theme/ParamsDetails'; +import RequestSchema from '@theme/RequestSchema'; +import StatusCodes from '@theme/StatusCodes'; +import OperationTabs from '@theme/OperationTabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; +import Translate from '@docusaurus/Translate'; + + + + + +Create a new template. Backdrop is required for non-SINGLE layouts. + + + Request + + + + + + + diff --git a/ads/api/reference/sidebar.ts b/ads/api/reference/sidebar.ts new file mode 100644 index 000000000000..30bf8307cfcd --- /dev/null +++ b/ads/api/reference/sidebar.ts @@ -0,0 +1,414 @@ +import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: 'doc', + id: 'api/reference/optiview-ads-api', + }, + { + type: 'category', + label: 'Channels', + items: [ + { + type: 'doc', + id: 'api/reference/get-channels', + label: 'Get /channels', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels', + label: 'Post /channels', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id', + label: 'Delete /channels/{channelId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id', + label: 'Get /channels/{channelId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-channels-channel-id', + label: 'Patch /channels/{channelId}', + className: 'api-method patch', + }, + ], + }, + { + type: 'category', + label: 'Breaks', + items: [ + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-breaks', + label: 'Delete /channels/{channelId}/breaks', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-breaks', + label: 'Get /channels/{channelId}/breaks', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-breaks', + label: 'Post /channels/{channelId}/breaks', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-breaks-active', + label: 'Get /channels/{channelId}/breaks/active', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-breaks-current', + label: 'Get /channels/{channelId}/breaks/current', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-breaks-break-id', + label: 'Delete /channels/{channelId}/breaks/{breakId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-breaks-break-id', + label: 'Get /channels/{channelId}/breaks/{breakId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-breaks-break-id-punch', + label: 'Post /channels/{channelId}/breaks/{breakId}/punch', + className: 'api-method post', + }, + ], + }, + { + type: 'category', + label: 'Detection', + items: [ + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-detection-disable', + label: 'Post /channels/{channelId}/detection/disable', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-detection-enable', + label: 'Post /channels/{channelId}/detection/enable', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-detection-history', + label: 'Get /channels/{channelId}/detection/history', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-detection-history-marker-detection-id', + label: 'Get /channels/{channelId}/detection/history/{markerDetectionId}', + className: 'api-method get', + }, + ], + }, + { + type: 'category', + label: 'Events', + items: [ + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-events', + label: 'Delete /channels/{channelId}/events', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events', + label: 'Get /channels/{channelId}/events', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-events', + label: 'Post /channels/{channelId}/events', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-events-event-id', + label: 'Delete /channels/{channelId}/events/{eventId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events-event-id', + label: 'Get /channels/{channelId}/events/{eventId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-channels-channel-id-events-event-id', + label: 'Patch /channels/{channelId}/events/{eventId}', + className: 'api-method patch', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events-event-id-breaks', + label: 'Get /channels/{channelId}/events/{eventId}/breaks', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events-event-id-breaks-active', + label: 'Get /channels/{channelId}/events/{eventId}/breaks/active', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events-event-id-breaks-current', + label: 'Get /channels/{channelId}/events/{eventId}/breaks/current', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events-event-id-templates', + label: 'Get /channels/{channelId}/events/{eventId}/templates', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-events-event-id-templates-template-id-breaks', + label: 'Get /channels/{channelId}/events/{eventId}/templates/{templateId}/breaks', + className: 'api-method get', + }, + ], + }, + { + type: 'category', + label: 'Integrations', + items: [ + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-integrations', + label: 'Get /channels/{channelId}/integrations', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-integrations', + label: 'Post /channels/{channelId}/integrations', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-integrations-channel-integration-id', + label: 'Delete /channels/{channelId}/integrations/{channelIntegrationId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-integrations-channel-integration-id', + label: 'Get /channels/{channelId}/integrations/{channelIntegrationId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-channels-channel-id-integrations-channel-integration-id', + label: 'Patch /channels/{channelId}/integrations/{channelIntegrationId}', + className: 'api-method patch', + }, + ], + }, + { + type: 'category', + label: 'Marker Rules', + items: [ + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-marker-rules', + label: 'Delete /channels/{channelId}/markerRules', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-marker-rules', + label: 'Get /channels/{channelId}/markerRules', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-marker-rules', + label: 'Post /channels/{channelId}/markerRules', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-marker-rules-marker-rule-id', + label: 'Delete /channels/{channelId}/markerRules/{markerRuleId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-marker-rules-marker-rule-id', + label: 'Get /channels/{channelId}/markerRules/{markerRuleId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-channels-channel-id-marker-rules-marker-rule-id', + label: 'Patch /channels/{channelId}/markerRules/{markerRuleId}', + className: 'api-method patch', + }, + ], + }, + { + type: 'category', + label: 'Origins', + items: [ + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-origins', + label: 'Get /channels/{channelId}/origins', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-origins', + label: 'Post /channels/{channelId}/origins', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-channels-channel-id-origins-origin-id', + label: 'Delete /channels/{channelId}/origins/{originId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-channels-channel-id-origins-origin-id', + label: 'Get /channels/{channelId}/origins/{originId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-channels-channel-id-origins-origin-id', + label: 'Patch /channels/{channelId}/origins/{originId}', + className: 'api-method patch', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-origins-origin-id-disable', + label: 'Post /channels/{channelId}/origins/{originId}/disable', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/post-channels-channel-id-origins-origin-id-enable', + label: 'Post /channels/{channelId}/origins/{originId}/enable', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/get-origins', + label: 'Get /origins', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-origins', + label: 'Post /origins', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-origins-origin-id', + label: 'Delete /origins/{originId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-origins-origin-id', + label: 'Get /origins/{originId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-origins-origin-id', + label: 'Patch /origins/{originId}', + className: 'api-method patch', + }, + { + type: 'doc', + id: 'api/reference/post-origins-origin-id-disable', + label: 'Post /origins/{originId}/disable', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/post-origins-origin-id-enable', + label: 'Post /origins/{originId}/enable', + className: 'api-method post', + }, + ], + }, + { + type: 'category', + label: 'Templates', + items: [ + { + type: 'doc', + id: 'api/reference/delete-templates', + label: 'Delete /templates', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-templates', + label: 'Get /templates', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/post-templates', + label: 'Post /templates', + className: 'api-method post', + }, + { + type: 'doc', + id: 'api/reference/delete-templates-template-id', + label: 'Delete /templates/{templateId}', + className: 'api-method delete', + }, + { + type: 'doc', + id: 'api/reference/get-templates-template-id', + label: 'Get /templates/{templateId}', + className: 'api-method get', + }, + { + type: 'doc', + id: 'api/reference/patch-templates-template-id', + label: 'Patch /templates/{templateId}', + className: 'api-method patch', + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/ads/api/signaling/.gitignore b/ads/api/signaling/.gitignore deleted file mode 100644 index 7c5ca8c38d5f..000000000000 --- a/ads/api/signaling/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -# Auto-generated by `docusaurus gen-api-docs` -**/*.mdx -**/sidebar.ts diff --git a/ads/getting-started/index.mdx b/ads/getting-started/index.mdx index 4413ab08b29e..1f9afcadf2ce 100644 --- a/ads/getting-started/index.mdx +++ b/ads/getting-started/index.mdx @@ -110,7 +110,7 @@ curl -X POST 'https://ads.example.com/api/v1/templates' \ }' ``` -The supported break formats are `single`, `double`, `lshape_ad`, `lshape_content`, and `overlay`. For Google Ad Manager pod serving, use an asset with `type: "vendor"`, `vendor: "gam"`, and `vendorParameters` such as `{ "type": "pod" }`; this uses the channel's `customAssetKey`. See the [Ads API reference](/ads/api/reference/optiview-ads-api/) for the complete template fields. +The supported break formats are `single`, `double`, `lshape_ad`, `lshape_content`, and `overlay`. For Google Ad Manager pod serving, use an asset with `type: "vendor"`, `vendor: "gam"`, and `vendorParameters` such as `{ "type": "pod" }`; this uses the channel's `customAssetKey`. See [Templates](/ads/concepts/templates/) for the complete template field model. ## 4. Schedule a break diff --git a/ads/how-to-guides/override-layout.md b/ads/how-to-guides/override-layout.md index 4eaf568ab2cc..d28ff3f5444a 100644 --- a/ads/how-to-guides/override-layout.md +++ b/ads/how-to-guides/override-layout.md @@ -11,7 +11,7 @@ OptiView Ads is able to insert ad breaks into your content via the signaling ser - `LSHAPE_AD`: Displays advertisements in a scaled window alongside a companion background. - `LSHAPE_CONTENT`: Displays the original content video in a scaled window alongside a companion background. -When your signaling service is created, the default layout should be defined. Look at our [API references](/ads/api/signaling/create-monetized-stream/) for more information. +When your signaling service is created, the default layout should be defined. Look at our [API references](/ads/api/reference/optiview-ads-api/) for more information. The rest of this page will go over how to override this initial chosen layout in the [signaling service](#override-layout-through-the-signaling-service) itself, or override it on the [player side](#override-the-layout-through-the-player). @@ -22,7 +22,7 @@ There are two ways to update the layout in the signaling service. ### Setting a new default layout -It is possible to update the default layout value on the signaling service. This can be done by making an [UpdateMonetizedStreamLayout](/ads/api/signaling/update-monetized-stream-layout/) API request to the signaling service with the new layout. The updated layout value will be the new default for all ad breaks. +It is possible to update the default layout value on the signaling service. This can be done by making an [UpdateMonetizedStreamLayout](/ads/api/reference/optiview-ads-api/) API request to the signaling service with the new layout. The updated layout value will be the new default for all ad breaks. ### Signaling an ad break through the API diff --git a/ads/how-to-guides/scheduling-breaks.md b/ads/how-to-guides/scheduling-breaks.md index 5a13e63c8415..bbf339ee8a91 100644 --- a/ads/how-to-guides/scheduling-breaks.md +++ b/ads/how-to-guides/scheduling-breaks.md @@ -90,7 +90,7 @@ An example snippet for an `#EXT-OATCLS-SCTE35` tag can be found below: If the ad information won't be present in the provided manifest, it is possible to schedule one through the OptiView Ads service API. -This can be done by a POST request to `{path}/break` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamBreak](/ads/api/signaling/create-monetized-stream-break/). +This can be done by a POST request to `{path}/break` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamBreak](/ads/api/reference/optiview-ads-api/). The body of the post request can have the following properties: diff --git a/ads/how-to-guides/scheduling-overlays.md b/ads/how-to-guides/scheduling-overlays.md index 6bd3dc330522..6885eafbb533 100644 --- a/ads/how-to-guides/scheduling-overlays.md +++ b/ads/how-to-guides/scheduling-overlays.md @@ -10,7 +10,7 @@ OptiView Ads can insert overlays into your content, but it requires placement in The recommended way to schedule overlays is through the OptiView Ads service API. -This can be done by a POST request to `{path}/overlay` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamOverlay](/ads/api/signaling/create-monetized-stream-overlay/). +This can be done by a POST request to `{path}/overlay` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamOverlay](/ads/api/reference/optiview-ads-api/). The body of the post request can have the following properties: diff --git a/ads/how-to-guides/workflow-integration.md b/ads/how-to-guides/workflow-integration.md index fb93c260ed0e..5a8f17d66e31 100644 --- a/ads/how-to-guides/workflow-integration.md +++ b/ads/how-to-guides/workflow-integration.md @@ -29,4 +29,4 @@ To integrate the Signaling Service with your workflow, the properties origin and ## More information - [Getting Started](/ads/getting-started/index.mdx) -- [API reference](/ads/api/signaling/theoads-api/) +- [API reference](/ads/api/reference/optiview-ads-api/) diff --git a/ads_versioned_docs/version-v1/getting-started/signaling-service.mdx b/ads_versioned_docs/version-v1/getting-started/signaling-service.mdx index af904930bb28..638a3ef163c6 100644 --- a/ads_versioned_docs/version-v1/getting-started/signaling-service.mdx +++ b/ads_versioned_docs/version-v1/getting-started/signaling-service.mdx @@ -194,7 +194,7 @@ The response is the monetized stream resource. } ``` -Please refer to the [API reference](/ads/api/signaling/theoads-api/) for even more detailed information on the REST API. +Please refer to the [API reference](/ads/v1/api/signaling/theoads-api/) for even more detailed information on the REST API. ### Player source @@ -236,7 +236,7 @@ Optionally, SCTE markers can be included with the tags for extra metadata. ### REST API -For scheduling ad breaks through the REST API, please refer to the [API definitions](/ads/api/signaling/create-monetized-stream-break/) and the example below. +For scheduling ad breaks through the REST API, please refer to the [API definitions](/ads/v1/api/signaling/create-monetized-stream-break/) and the example below. ```bash curl --location 'https:///ads-client/api/v1/monetized-streams/stream-1/break' \ @@ -257,7 +257,7 @@ For more information on this topic we refer to our [workflow integration](/ads/h # More information -- [API reference](/ads/api/signaling/theoads-api/) +- [API reference](/ads/v1/api/signaling/theoads-api/) - [What is OptiView Ads?](https://optiview.dolby.com/products/server-guided-ad-insertion/) - [The Advantages of Server-Guided Ad Insertion](https://optiview.dolby.com/solutions/personalized-advertising/) - [Is Server-Guided Ad-Insertion (SGAI) revolutionizing streaming monetization? (blog)](https://optiview.dolby.com/resources/blog/advertising/what-is-sgai-server-guided-ad-insertion-in-streaming/) diff --git a/ads_versioned_docs/version-v1/how-to-guides/override-layout.md b/ads_versioned_docs/version-v1/how-to-guides/override-layout.md index 4eaf568ab2cc..d3eb2ea5d343 100644 --- a/ads_versioned_docs/version-v1/how-to-guides/override-layout.md +++ b/ads_versioned_docs/version-v1/how-to-guides/override-layout.md @@ -11,7 +11,7 @@ OptiView Ads is able to insert ad breaks into your content via the signaling ser - `LSHAPE_AD`: Displays advertisements in a scaled window alongside a companion background. - `LSHAPE_CONTENT`: Displays the original content video in a scaled window alongside a companion background. -When your signaling service is created, the default layout should be defined. Look at our [API references](/ads/api/signaling/create-monetized-stream/) for more information. +When your signaling service is created, the default layout should be defined. Look at our [API references](/ads/v1/api/signaling/create-monetized-stream/) for more information. The rest of this page will go over how to override this initial chosen layout in the [signaling service](#override-layout-through-the-signaling-service) itself, or override it on the [player side](#override-the-layout-through-the-player). @@ -22,7 +22,7 @@ There are two ways to update the layout in the signaling service. ### Setting a new default layout -It is possible to update the default layout value on the signaling service. This can be done by making an [UpdateMonetizedStreamLayout](/ads/api/signaling/update-monetized-stream-layout/) API request to the signaling service with the new layout. The updated layout value will be the new default for all ad breaks. +It is possible to update the default layout value on the signaling service. This can be done by making an [UpdateMonetizedStreamLayout](/ads/v1/api/signaling/update-monetized-stream-layout/) API request to the signaling service with the new layout. The updated layout value will be the new default for all ad breaks. ### Signaling an ad break through the API diff --git a/ads_versioned_docs/version-v1/how-to-guides/scheduling-breaks.md b/ads_versioned_docs/version-v1/how-to-guides/scheduling-breaks.md index 5a13e63c8415..9ccf6f0ac4ef 100644 --- a/ads_versioned_docs/version-v1/how-to-guides/scheduling-breaks.md +++ b/ads_versioned_docs/version-v1/how-to-guides/scheduling-breaks.md @@ -90,7 +90,7 @@ An example snippet for an `#EXT-OATCLS-SCTE35` tag can be found below: If the ad information won't be present in the provided manifest, it is possible to schedule one through the OptiView Ads service API. -This can be done by a POST request to `{path}/break` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamBreak](/ads/api/signaling/create-monetized-stream-break/). +This can be done by a POST request to `{path}/break` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamBreak](/ads/v1/api/signaling/create-monetized-stream-break/). The body of the post request can have the following properties: diff --git a/ads_versioned_docs/version-v1/how-to-guides/scheduling-overlays.md b/ads_versioned_docs/version-v1/how-to-guides/scheduling-overlays.md index 6bd3dc330522..712e3b70c164 100644 --- a/ads_versioned_docs/version-v1/how-to-guides/scheduling-overlays.md +++ b/ads_versioned_docs/version-v1/how-to-guides/scheduling-overlays.md @@ -10,7 +10,7 @@ OptiView Ads can insert overlays into your content, but it requires placement in The recommended way to schedule overlays is through the OptiView Ads service API. -This can be done by a POST request to `{path}/overlay` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamOverlay](/ads/api/signaling/create-monetized-stream-overlay/). +This can be done by a POST request to `{path}/overlay` where path is the usual url to interact with the OptiView Ads service for a specific monetized stream: `{optiview-ads-host}/ads-client/api/v1/monetized-streams/:monetizedStreamId`. Please see [CreateMonetizedStreamOverlay](/ads/v1/api/signaling/create-monetized-stream-overlay/). The body of the post request can have the following properties: diff --git a/ads_versioned_docs/version-v1/how-to-guides/workflow-integration.md b/ads_versioned_docs/version-v1/how-to-guides/workflow-integration.md index fb93c260ed0e..45a9e58d9993 100644 --- a/ads_versioned_docs/version-v1/how-to-guides/workflow-integration.md +++ b/ads_versioned_docs/version-v1/how-to-guides/workflow-integration.md @@ -29,4 +29,4 @@ To integrate the Signaling Service with your workflow, the properties origin and ## More information - [Getting Started](/ads/getting-started/index.mdx) -- [API reference](/ads/api/signaling/theoads-api/) +- [API reference](/ads/v1/api/signaling/theoads-api/) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 5be3015ffc40..3df8f0543dca 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -344,8 +344,8 @@ const config: Config = { signaling: { version: 'v2', label: 'v2', - specPath: 'ads/api/ads-client.swagger.json', - outputDir: 'ads/api/signaling', + specPath: '.docusaurus/openapi/ads-v2/openapi.json', + outputDir: 'ads/api/reference', hideSendButton: true, sidebarOptions: { groupPathsBy: 'tag', diff --git a/package.json b/package.json index fc580234d62d..1c88d8137a14 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,9 @@ "serve": "node serve.js", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", - "gen-api-docs": "docusaurus gen-api-docs all --plugin-id ads-api --all-versions && docusaurus gen-api-docs all --plugin-id ad-engine-api && docusaurus gen-api-docs all --plugin-id millicast-api && docusaurus gen-api-docs all --plugin-id theolive-api --all-versions", + "fetch-ads-openapi": "node scripts/fetch-ads-openapi.mjs", + "refresh-ads-api-docs": "npm run fetch-ads-openapi && docusaurus gen-api-docs signaling --plugin-id ads-api && prettier --write ads/api/reference", + "gen-api-docs": "docusaurus gen-api-docs signalingV1 --plugin-id ads-api && docusaurus gen-api-docs all --plugin-id ad-engine-api && docusaurus gen-api-docs all --plugin-id millicast-api && docusaurus gen-api-docs all --plugin-id theolive-api --all-versions", "clean-api-docs": "docusaurus clean-api-docs all --plugin-id ads-api --all-versions && docusaurus clean-api-docs all --plugin-id ad-engine-api && docusaurus clean-api-docs all --plugin-id millicast-api && docusaurus clean-api-docs all --plugin-id theolive-api --all-versions", "typecheck": "tsc", "check-format": "prettier --check .", diff --git a/redirectsAds.json b/redirectsAds.json index 6d968bed4689..d57085a2dff8 100644 --- a/redirectsAds.json +++ b/redirectsAds.json @@ -9,55 +9,55 @@ }, { "from": "/theoads/api/signaling/create-monetized-stream-break/", - "to": "/ads/api/signaling/create-monetized-stream-break/" + "to": "/ads/v1/api/signaling/create-monetized-stream-break/" }, { "from": "/theoads/api/signaling/create-monetized-stream-overlay/", - "to": "/ads/api/signaling/create-monetized-stream-overlay/" + "to": "/ads/v1/api/signaling/create-monetized-stream-overlay/" }, { "from": "/theoads/api/signaling/create-monetized-stream/", - "to": "/ads/api/signaling/create-monetized-stream/" + "to": "/ads/v1/api/signaling/create-monetized-stream/" }, { "from": "/theoads/api/signaling/delete-monetized-stream-breaks/", - "to": "/ads/api/signaling/delete-monetized-stream-breaks/" + "to": "/ads/v1/api/signaling/delete-monetized-stream-breaks/" }, { "from": "/theoads/api/signaling/delete-monetized-stream-overlay/", - "to": "/ads/api/signaling/delete-monetized-stream-overlay/" + "to": "/ads/v1/api/signaling/delete-monetized-stream-overlay/" }, { "from": "/theoads/api/signaling/delete-monetized-stream/", - "to": "/ads/api/signaling/delete-monetized-stream/" + "to": "/ads/v1/api/signaling/delete-monetized-stream/" }, { "from": "/theoads/api/signaling/get-monetized-stream-breaks/", - "to": "/ads/api/signaling/get-monetized-stream-breaks/" + "to": "/ads/v1/api/signaling/get-monetized-stream-breaks/" }, { "from": "/theoads/api/signaling/get-monetized-stream-overlays/", - "to": "/ads/api/signaling/get-monetized-stream-overlays/" + "to": "/ads/v1/api/signaling/get-monetized-stream-overlays/" }, { "from": "/theoads/api/signaling/get-monetized-stream/", - "to": "/ads/api/signaling/get-monetized-stream/" + "to": "/ads/v1/api/signaling/get-monetized-stream/" }, { "from": "/theoads/api/signaling/get-monetized-streams/", - "to": "/ads/api/signaling/get-monetized-streams/" + "to": "/ads/v1/api/signaling/get-monetized-streams/" }, { "from": ["/theoads/api/signaling/", "/theoads/api/signaling/theoads-api/"], - "to": "/ads/api/signaling/theoads-api/" + "to": "/ads/v1/api/signaling/theoads-api/" }, { "from": "/theoads/api/signaling/update-monetized-stream-layout/", - "to": "/ads/api/signaling/update-monetized-stream-layout/" + "to": "/ads/v1/api/signaling/update-monetized-stream-layout/" }, { "from": "/theoads/api/signaling/update-monetized-stream/", - "to": "/ads/api/signaling/update-monetized-stream/" + "to": "/ads/v1/api/signaling/update-monetized-stream/" }, { "from": "/theoads/getting-started/", diff --git a/scripts/fetch-ads-openapi.mjs b/scripts/fetch-ads-openapi.mjs new file mode 100644 index 000000000000..cafda75e0757 --- /dev/null +++ b/scripts/fetch-ads-openapi.mjs @@ -0,0 +1,97 @@ +import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'; +import { dirname, resolve } from 'node:path'; + +const DEFAULT_SPEC_REF = '76b8e3996237ea4b7b4c2297caeb2f5e8514a3c7'; +const OUTPUT_PATH = resolve('.docusaurus/openapi/ads-v2/openapi.json'); + +const specRef = process.env.ADS_OPENAPI_REF ?? DEFAULT_SPEC_REF; +const rawUrl = `https://raw.githubusercontent.com/Dolby-OptiView/optiview-ads/${specRef}/openapi.json`; +const apiUrl = `https://api.github.com/repos/Dolby-OptiView/optiview-ads/contents/openapi.json?ref=${encodeURIComponent(specRef)}`; +const specUrl = process.env.ADS_OPENAPI_SPEC_URL ?? rawUrl; +const token = process.env.ADS_OPENAPI_TOKEN ?? process.env.GITHUB_TOKEN ?? process.env.GH_TOKEN; + +const headers = { + Accept: 'application/vnd.github.raw+json', + 'User-Agent': 'optiview-docs-openapi-fetcher', +}; + +if (token) { + headers.Authorization = `Bearer ${token}`; +} + +const source = specUrl.startsWith('file://') || specUrl.startsWith('/') ? await readFile(specUrl.replace(/^file:\/\//, ''), 'utf8') : undefined; + +const spec = source + ? JSON.parse(source) + : await (async () => { + const remoteUrl = token && !process.env.ADS_OPENAPI_SPEC_URL ? apiUrl : specUrl; + const response = await fetch(remoteUrl, { headers }); + + if (!response.ok) { + throw new Error(`Failed to fetch Ads OpenAPI spec from ${remoteUrl}: ${response.status} ${response.statusText}`); + } + + return response.json(); + })(); + +if (spec.openapi !== '3.0.3' || !spec.paths || !spec.components) { + throw new Error(`Fetched Ads OpenAPI spec from ${specUrl} is not the expected OpenAPI 3.0.3 document.`); +} + +function removeExcludedFields(value) { + if (Array.isArray(value)) { + for (let index = value.length - 1; index >= 0; index -= 1) { + if (value[index] === 'adPrefetchMs') { + value.splice(index, 1); + } + } + value.forEach(removeExcludedFields); + return; + } + + if (value && typeof value === 'object') { + delete value.adPrefetchMs; + Object.values(value).forEach(removeExcludedFields); + } +} + +removeExcludedFields(spec); + +const httpMethods = new Set(['get', 'put', 'post', 'delete', 'patch', 'options', 'head', 'trace']); +const titleCase = (value) => + value + .replace(/([a-z])([A-Z])/g, '$1 $2') + .split(/[-_\s]+/) + .filter(Boolean) + .map((part) => `${part.charAt(0).toUpperCase()}${part.slice(1)}`) + .join(' '); +const operationName = (method, path) => + `${method}-${path + .replace(/^\/api\/v1\//, '') + .replace(/[{}]/g, '') + .replace(/[^a-zA-Z0-9]+/g, '-') + .replace(/^-|-$/g, '')}`; +const tagForPath = (path) => { + const segments = path.split('/').filter(Boolean); + const resource = segments[2] === 'channels' && segments[4] ? segments[4] : segments[2]; + + return titleCase(resource ?? 'Ads'); +}; + +for (const [path, pathItem] of Object.entries(spec.paths)) { + for (const [method, operation] of Object.entries(pathItem)) { + if (!httpMethods.has(method)) { + continue; + } + + operation.operationId ??= operationName(method, path); + operation.summary ??= `${titleCase(method)} ${path.replace(/^\/api\/v1/, '') || '/'}`; + operation.tags ??= [tagForPath(path)]; + } +} + +await mkdir(dirname(OUTPUT_PATH), { recursive: true }); +await rm('ads/api/reference', { recursive: true, force: true }); +await writeFile(OUTPUT_PATH, `${JSON.stringify(spec, null, 2)}\n`); + +console.log(`Fetched Ads OpenAPI spec from ${specUrl} into ${OUTPUT_PATH}`); diff --git a/sidebarsAds.ts b/sidebarsAds.ts index d245baee0c58..d15a3a19ec71 100644 --- a/sidebarsAds.ts +++ b/sidebarsAds.ts @@ -1,5 +1,5 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; -import signalingApiSidebar from './ads/api/signaling/sidebar'; +import adsApiSidebar from './ads/api/reference/sidebar'; const sidebars: SidebarsConfig = { ads: [ @@ -127,13 +127,13 @@ const sidebars: SidebarsConfig = { customProps: { icon: '*️⃣', }, - link: { type: 'generated-index', slug: 'api' }, + link: { type: 'doc', id: 'api/index' }, items: [ { type: 'link', - label: 'Signaling Service', + label: 'Ads REST API', customProps: { icon: '🛜' }, - href: '/ads/api/signaling/theoads-api', + href: '/ads/api/reference/optiview-ads-api', }, { type: 'link', @@ -144,13 +144,13 @@ const sidebars: SidebarsConfig = { ], }, ], - signalingApi: [ + adsApi: [ { type: 'link', label: '« Back', - href: '/ads/', + href: '/ads/api/', }, - ...signalingApiSidebar, + ...adsApiSidebar, ], };