Adds a new integration for a clipping profile, allowing you to configure settings for platforms like YouTube.
Request
Request syntax:
POST /clipping-profiles/Clipping Profile ID/integrations
Request URL variable:
Define the following variable when submitting the above request:
VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). | Description |
---|---|
Clipping Profile ID Required | Identifies a clipping profile by its system-defined or external ID. Use the Get Multiple Clipping Profiles endpoint to retrieve a list of clipping profiles and their IDs. |
Request body parameters:
Pass the following request body parameters (pass only the fields you want to update):
Name | Data Type | Description |
---|---|---|
name | String | The name of this clipping profile integration |
metamap | Dictionary | Key/Value[String] pairs contain the following keys: category, description[required], keywords, privacyStatus[true/false], and title[required] |
service | String | The type of service. Valid values: youtube |
Authentication
Pass a digital signature based off of msg.
Response
A successful request returns a 200 OK response that contains the following properties:
Name | Data Type | Description |
---|---|---|
@id | String | Indicates the relative path to an endpoint that returns this clipping profile configuration. |
@type | String | Returns ClippingProfileIntegrations. |
created | String | Identifies the date and time (UTC) this integration was create.Syntax: {YYYY-MM-DDThh:mm:ss.ssssss}Z Example: 2024-04-04T16:35:46.054Z |
lastmod | Boolean | Identifies the date and time (UTC) this integration was create. Syntax: {YYYY-MM-DDThh:mm:ss.ssssss}Z Example: 2024-04-04T16:35:46.054Z |
name | String | The name of this clipping profile integration |
profile | String | GUID representing the clipping profile system-generated ID |
service | String | The type of third party service. |
metamap | Dictionary | Key/Value[String] pairs contain the following keys: category, description, keywords, privacyStatus, profile_id and title. The category, description, keywords, and title value can be set to @title, @external_id, or use any metadata you created. To use an existing metadata key you must start with a dollar symbol ($) and the key name you created. For example, if you created a metadata field called "happy" you’ll need to set the value as $happy. |
Sample Request/Response
Call the clipping_profiles_integrations_create module (Python 3) to update a clipping profile integration. This module imports names from the api_auth module.
Request:
import json
from pprint import PrettyPrinter
import requests
from api_auth import APICredentials, APIParams
pp = PrettyPrinter().pprint
class ClippingProfiles:
"""Class Description"""
def __init__(self, source_list):
"""dummy"""
self.profile_id = None
for key, value in source_list.items():
setattr(self, key, value)
self.host = "https://services.uplynk.com"
self.headers = {"Content-Type": "application/json"}
def run(self):
"""dummy"""
self._get_youtube_login_url()
def _get_youtube_login_url(self):
"""dummy"""
url = f"{self.host}/api/v4/clipping-profiles/{self.profile_id}/integrations"
payload = {
"name": "My Youtube",
"service": "youtube",
"metamap": {
"description": "$blue_colors",
"title": "@desc"
},
}
response = requests.post(
url,
params=APIParams(APICredentials()).get_params({}),
data=json.dumps(payload),
headers=self.headers,
timeout=15
)
pp(response.json())
class_variables = {"profile_id": "be1af15490e24399bb6c4f2a36384d66"}
ClippingProfiles(class_variables).run()
Response:
{
"@id": "/api/v4/clipping-profiles/be1af15490e24399bb6c4f2a36384d66/integrations/c3eb485e9b374945a623abc3b883eb78",
"@type": "ClippingProfileIntegrations",
"authenticated": False,
"created": "2024-05-07T15:48:18.982Z",
"id": "c3eb485e9b374945a623abc3b883eb78",
"lastmod": "2024-05-07T15:48:18.982Z",
"metamap": {
"category": "",
"description": "$blue_colors",
"keywords": "",
"privacyStatus": "",
"title": "@desc",
},
"name": "My Youtube",
"profile": "be1af15490e24399bb6c4f2a36384d66",
"service": "youtube",
}