از برچسب‌های دارایی استفاده کنید

توجه: YouTube Content ID API برای استفاده شرکای محتوای YouTube در نظر گرفته شده است و برای همه توسعه دهندگان یا همه کاربران YouTube قابل دسترسی نیست. اگر API شناسه محتوای YouTube را به‌عنوان یکی از سرویس‌های فهرست شده در Google API Console نمی‌بینید، برای کسب اطلاعات بیشتر درباره YouTube Partner Program به مرکز راهنمایی YouTube مراجعه کنید.

برچسب های دارایی ایجاد کنید

API از دو روش برای ایجاد برچسب دارایی پشتیبانی می کند:

• متد assetLabels.insert را فراخوانی کنید. بدنه درخواست یک منبع assetLabel است که در آن ویژگی labelName نام منحصر به فرد برچسب جدید را مشخص می کند. اگر برچسبی با همین نام از قبل وجود داشته باشد، API یک کد پاسخ HTTP 409 (Conflict) را برمی‌گرداند.

  کوئری زیر متد assetLabels.insert را برای ایجاد یک برچسب جدید به نام Explorer Test فراخوانی می کند. متن درخواست نمونه به شرح زیر است:

  {
    "labelName": "Explorer Test"
  }

  درخواست هیچ پارامتر پرس و جو را تنظیم نمی کند. با این حال، اگر حساب Google شما با چندین حساب مالک محتوا مرتبط است، باید مقداری را برای پارامتر onBehalfOfContentOwner نیز تعیین کنید.

  [no parameters set]

• برای به‌روزرسانی برچسب‌های یک دارایی، روش assets.update را فراخوانی کنید. در درخواست، ویژگی label[] منبع asset را به لیستی از برچسب‌های مرتبط با دارایی تنظیم کنید. API به طور خودکار برچسب‌های دارایی جدیدی را برای هر برچسبی در فهرست ایجاد می‌کند که قبلاً به‌طور صریح به عنوان منابع assetLabel ایجاد نشده است.

برچسب‌های دارایی مالک محتوا را فهرست کنید

برای بازیابی لیستی از برچسب‌های دارایی صاحب محتوا، روش assetLabels.list را فراخوانی کنید.

• به طور پیش‌فرض، API همه برچسب‌های دارایی را برای مالک محتوا برمی‌گرداند.
• اگر مقداری را برای پارامتر query labelPrefix تنظیم کنید، API فقط برچسب‌های دارایی مالک محتوا را که با رشته مشخص شده شروع می‌شوند، برمی‌گرداند.

کوئری زیر متد assetLabels.list را برای بازیابی همه برچسب‌ها برای صاحب محتوا فراخوانی می‌کند. با این حال، توجه داشته باشید که اگر حساب Google شما با چندین حساب مالک محتوا مرتبط است، باید مقداری را برای پارامتر onBehalfOfContentOwner تعیین کنید در غیر این صورت درخواست خطای 400 (Bad Request) را برمی‌گرداند.

[no parameters set]

کوئری زیر همان روش را فراخوانی می کند اما مقدار پارامتر labelPrefix را روی news تنظیم می کند. در نتیجه، تنها برچسب هایی که API برمی گرداند، برچسب هایی هستند که با آن رشته شروع می شوند.

labelPrefix=news

برچسب‌های دارایی را به‌روزرسانی کنید

هنگام فراخوانی روش assets.update می‌توانید برچسب‌های دارایی را با تنظیم مقدار ویژگی label[] به‌روزرسانی کنید. وقتی یک دارایی را به روز می کنید، لیست برچسب های قبلی آن حذف می شود و با لیست ارسال شده در درخواست API جایگزین می شود. به این ترتیب، اگر می‌خواهید لیست قبلی برچسب‌ها را حفظ کنید، باید از روش assets.list برای بازیابی لیست اصلی برچسب‌ها استفاده کنید و سپس مقدار ویژگی label[] را تغییر دهید. اگر مقدار دارایی خالی باشد، API برچسب هایی را که قبلاً با دارایی مرتبط بوده اند حذف می کند.

شما می توانید یک برچسب را با چندین دارایی مرتبط کنید و همچنین چندین برچسب را با یک دارایی اختصاص دهید. برچسب ها ممکن است حاوی فاصله باشند، به این معنی که یک برچسب می تواند بیش از یک کلمه باشد. کاراکترهای ممنوعه عبارتند از: براکت های زاویه دار، کاما، دو نقطه و کاراکترهای عمودی لوله (|). هر برچسب باید حداقل دو بایت باشد و نباید بیشتر از 30 بایت باشد. هر صاحب محتوا می تواند تا 30 برچسب برای یک دارایی اضافه کند. حداکثر طول کل برای همه برچسب ها برای یک دارایی معین 500 بایت است.

دارایی ها را بر اساس برچسب جستجو کنید

برای بازیابی فهرستی از دارایی‌های مرتبط با یک برچسب یا گروهی از برچسب‌ها، روش assetSearch.list را فراخوانی کنید و با استفاده از پارامتر query labels فهرستی از برچسب‌های دارایی را با کاما جدا کنید.

• به‌طور پیش‌فرض، API فهرستی از دارایی‌ها را برمی‌گرداند که همه برچسب‌های دارایی مشخص شده را دارند.
• اگر درخواست API شما پارامتر includeAnyProvidedLabel را روی true تنظیم کند، API هر دارایی را که حداقل با یکی از برچسب‌های مشخص شده مطابقت داشته باشد را برمی‌گرداند.