# Social Video Product Placement Detector (`kayhermes/social-video-product-placement-detector`) Actor

- **URL**: https://apify.com/kayhermes/social-video-product-placement-detector.md
- **Developed by:** [Khoa Nguyen](https://apify.com/kayhermes) (community)
- **Categories:** Social media
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Social Video Product Placement Detector

Detect product placement signals from supplied transcripts, OCR, logos, objects, links, promo codes, commercial language, and disclosures.

### Input
Provide `videos[]`, `records[]`, an Apify `datasetId`, or public CSV/JSON `sourceUrls`.

### Output
Detailed Dataset rows, `OUTPUT`, and `REPORT.html`. Monitoring Actors use a persistent Key-Value Store baseline.

### Important limitation
The MVP consumes supplied transcript/OCR/object/logo signals and does not perform native video vision.

Use authorized data and require human review before campaign, moderation, legal, or commercial decisions.

# Actor input Schema

## `videos` (type: `array`):

Detect product placement signals from supplied transcripts, OCR, logos, objects, links, promo codes, commercial language, and disclosures.
## `datasetId` (type: `string`):

Optional Apify dataset ID containing video records to analyze.
## `sourceUrls` (type: `array`):

Optional URLs pointing to CSV or JSON files containing video records.
## `options` (type: `object`):

Optional analysis settings that control detector behavior.
## `stateStoreName` (type: `string`):

Optional named key-value store used to persist processing state.
## `maxItems` (type: `integer`):

Maximum number of source records to process in one run.
## `webhookUrl` (type: `string`):

Optional webhook URL that receives alert or completion notifications.
## `productCatalog` (type: `array`):

Products, brands, aliases, domains, logo labels, and object labels to match.

## Actor input object example

```json
{
  "videos": [
    {
      "videoId": "video-1",
      "creatorId": "creator-9",
      "caption": "Use code GLOW20 and shop now for Lumina Glow Serum #ad",
      "openingTranscript": "Lumina serum changed my routine",
      "detectedLogos": [
        "lumina logo"
      ],
      "objectLabels": [
        "serum bottle"
      ],
      "links": [
        "https://lumina.example/products/glow"
      ]
    },
    {
      "videoId": "video-2",
      "caption": "Buy now, link in bio for AquaMax bottle",
      "links": [
        "https://aquamax.example/bottle"
      ],
      "disclosureFlag": false
    }
  ],
  "sourceUrls": [],
  "options": {},
  "maxItems": 10000,
  "productCatalog": [
    {
      "productId": "p1",
      "productName": "Glow Serum",
      "brand": "Lumina",
      "aliases": [
        "lumina serum"
      ],
      "domains": [
        "lumina.example"
      ],
      "logoLabels": [
        "lumina logo"
      ],
      "objectLabels": [
        "serum bottle"
      ]
    },
    {
      "productId": "p2",
      "productName": "Hydra Bottle",
      "brand": "AquaMax",
      "aliases": [
        "aquamax bottle"
      ],
      "domains": [
        "aquamax.example"
      ]
    }
  ]
}
````

# Actor output Schema

## `results` (type: `string`):

No description

## `reportUrl` (type: `string`):

No description

## `summaryUrl` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("kayhermes/social-video-product-placement-detector").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("kayhermes/social-video-product-placement-detector").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call kayhermes/social-video-product-placement-detector --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=kayhermes/social-video-product-placement-detector",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Social Video Product Placement Detector",
        "version": "2.0",
        "x-build-id": "iF6nnluBo1cltkg3r"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/kayhermes~social-video-product-placement-detector/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-kayhermes-social-video-product-placement-detector",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/kayhermes~social-video-product-placement-detector/runs": {
            "post": {
                "operationId": "runs-sync-kayhermes-social-video-product-placement-detector",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/kayhermes~social-video-product-placement-detector/run-sync": {
            "post": {
                "operationId": "run-sync-kayhermes-social-video-product-placement-detector",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "videos": {
                        "title": "videos",
                        "type": "array",
                        "description": "Detect product placement signals from supplied transcripts, OCR, logos, objects, links, promo codes, commercial language, and disclosures.",
                        "default": [
                            {
                                "videoId": "video-1",
                                "creatorId": "creator-9",
                                "caption": "Use code GLOW20 and shop now for Lumina Glow Serum #ad",
                                "openingTranscript": "Lumina serum changed my routine",
                                "detectedLogos": [
                                    "lumina logo"
                                ],
                                "objectLabels": [
                                    "serum bottle"
                                ],
                                "links": [
                                    "https://lumina.example/products/glow"
                                ]
                            },
                            {
                                "videoId": "video-2",
                                "caption": "Buy now, link in bio for AquaMax bottle",
                                "links": [
                                    "https://aquamax.example/bottle"
                                ],
                                "disclosureFlag": false
                            }
                        ]
                    },
                    "datasetId": {
                        "title": "Source Dataset ID",
                        "type": "string",
                        "description": "Optional Apify dataset ID containing video records to analyze."
                    },
                    "sourceUrls": {
                        "title": "CSV or JSON source URLs",
                        "type": "array",
                        "description": "Optional URLs pointing to CSV or JSON files containing video records.",
                        "default": []
                    },
                    "options": {
                        "title": "Analysis options",
                        "type": "object",
                        "description": "Optional analysis settings that control detector behavior.",
                        "default": {}
                    },
                    "stateStoreName": {
                        "title": "Optional named state store",
                        "type": "string",
                        "description": "Optional named key-value store used to persist processing state."
                    },
                    "maxItems": {
                        "title": "Maximum records",
                        "minimum": 1,
                        "maximum": 100000,
                        "type": "integer",
                        "description": "Maximum number of source records to process in one run.",
                        "default": 10000
                    },
                    "webhookUrl": {
                        "title": "Alert or completion webhook",
                        "type": "string",
                        "description": "Optional webhook URL that receives alert or completion notifications."
                    },
                    "productCatalog": {
                        "title": "Product catalog",
                        "type": "array",
                        "description": "Products, brands, aliases, domains, logo labels, and object labels to match.",
                        "default": [
                            {
                                "productId": "p1",
                                "productName": "Glow Serum",
                                "brand": "Lumina",
                                "aliases": [
                                    "lumina serum"
                                ],
                                "domains": [
                                    "lumina.example"
                                ],
                                "logoLabels": [
                                    "lumina logo"
                                ],
                                "objectLabels": [
                                    "serum bottle"
                                ]
                            },
                            {
                                "productId": "p2",
                                "productName": "Hydra Bottle",
                                "brand": "AquaMax",
                                "aliases": [
                                    "aquamax bottle"
                                ],
                                "domains": [
                                    "aquamax.example"
                                ]
                            }
                        ]
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
