REST Resource: references

منبع: مرجع

یک مرجع، محتوای واقعی یک دارایی را نشان می‌دهد. یوتیوب ویدیوهای تازه آپلود شده را با کتابخانه‌ای از منابع مقایسه می‌کند تا به طور خودکار ادعاهایی را برای مالک(گان) دارایی ایجاد کند.

نمایش JSON 
{
  "kind": string,
  "status": string,
  "statusReason": string,
  "length": number,
  "hashCode": string,
  "urgent": boolean,
  "fpDirect": boolean,
  "contentType": string,
  "audioswapEnabled": boolean,
  "ignoreFpMatch": boolean,
  "origination": {
    object (Origination)
  },
  "excludedIntervals": [
    {
      object (ExcludedInterval)
    }
  ],
  "id": string,
  "assetId": string,
  "duplicateLeader": string,
  "claimId": string,
  "videoId": string
}
فیلدها
kind

string

نوع منبع API. برای منابع reference ، مقدار youtubePartner#reference است.

status

string

وضعیت مرجع. مقادیر قابل قبول عبارتند از:

  • activating - مرجع در انتظار فعال‌سازی است.
  • active - مرجع فعال است و به طور فعال تطبیق می‌دهد.
  • checking - مرجع با مراجع موجود مقایسه می‌شود تا تداخلات مرجع شناسایی شود.
  • checking_quota - مرجع در انتظار تأیید سهمیه است.
  • computing_fingerprint - اثر انگشت مرجع در حال محاسبه است.
  • deactivating - مرجع در حال غیرفعال شدن است.
  • deleted - مرجع حذف شده است.
  • inactive - مرجع غیرفعال است.
  • live_streaming_processing - مرجع از یک پخش زنده ویدیویی در حال پردازش است.
statusReason

string

توضیحی در مورد چگونگی ورود یک مرجع به وضعیت فعلی خود. این مقدار فقط در صورتی وجود دارد که وضعیت مرجع inactive یا deleted باشد. مقادیر قابل قبول عبارتند از:

  • ACTIVATION_QUOTA_EXCEEDED - سهمیه فعال‌سازی از حد مجاز فراتر رفت.
  • ALMOST_ENTIRELY_EXCLUDED - مرجع تقریباً به طور کامل حذف شده است.
  • ASSET_MERGE_FAILED - مرجع به دلیل شکست ادغام دارایی غیرفعال شد.
  • BATCH - پردازش در حین مصرف دسته‌ای ناموفق بود.
  • BULK_UPDATER - وضعیت توسط به‌روزرسانی انبوه به‌روزرسانی شد.
  • CLAIM_DISABLED_FOR_MATCHING - تطبیق در درخواست غیرفعال شده است.
  • CLOSED_BY_OWNER - توسط مالک دارایی بسته شده است.
  • DUPLICATE_FOR_OWNERS - مرجع، مرجع دیگری را برای همان مالک کپی می‌کند.
  • ERROR_DURING_ACTIVATION - هنگام فعال‌سازی خطایی رخ داد.
  • INSUFFICIENT_LENGTH - طول مرجع برای انگشت‌نگاری کافی نیست.
  • NON_PERFORMING - مرجع به دلیل عدم کارایی غیرفعال شد.
  • PROCESSING_FAILED - دریافت یا پردازش مرجع ناموفق بود.
  • PROCESSING_QUOTA_EXCEEDED - سهمیه پردازش از حد مجاز فراتر رفت.
  • REFERENCE_WAS_REMOVED - فایل مرجع منبع حذف شد.
  • USER_WAS_REMOVED - حساب کاربری حذف شد.
  • VIDEO_WAS_REMOVED - ویدیوی منبع حذف شد.
  • VIDEO_WIPED_OUT - ویدیو حذف یا پاک شده است.
length

number

طول مرجع بر حسب ثانیه.

hashCode

string

کد هش MD5 مربوط به محتوای مرجع. منسوخ شده! این کد دیگر پر نمی‌شود.

urgent

boolean

این مقدار را روی true تنظیم کنید تا نشان دهد یوتیوب باید پردازش شناسه محتوا را برای یک فایل ویدیویی در اولویت قرار دهد. یوتیوب فایل‌های ویدیویی فوری را قبل از سایر فایل‌هایی که به عنوان فوری علامت‌گذاری نشده‌اند، پردازش می‌کند. این تنظیم در درجه اول برای ویدیوهای رویدادهای زنده یا سایر ویدیوهایی که نیاز به پردازش حساس به زمان دارند، استفاده می‌شود. هرچه یوتیوب پردازش شناسه محتوا را برای یک ویدیو زودتر تکمیل کند، یوتیوب زودتر می‌تواند ویدیوهای آپلود شده توسط کاربر را با آن ویدیو مطابقت دهد.

علامت‌گذاری همه فایل‌هایتان به عنوان فوری می‌تواند پردازش آن فایل‌ها را به تأخیر بیندازد.

fpDirect

boolean

هنگام آپلود یک مرجع، این مقدار را روی true تنظیم کنید تا نشان دهد که مرجع یک اثر انگشت از پیش تولید شده است.

contentType

string

نوع محتوایی که مرجع نشان می‌دهد.

مقادیر قابل قبول عبارتند از:

  • audio
  • audiovisual
  • video
audioswapEnabled

boolean

مقدار این فیلد را روی true تنظیم کنید تا نشان دهد محتوای مرجع باید در برنامه AudioSwap یوتیوب گنجانده شود.

ignoreFpMatch

boolean

این مقدار را روی true تنظیم کنید تا نشان دهد که از مرجع نباید برای تولید ادعاها استفاده شود. این فیلد فقط در مراجع AudioSwap استفاده می‌شود.

origination

object ( Origination )

شیء origination شامل اطلاعاتی است که منبع مرجع را توصیف می‌کند.

excludedIntervals[]

object ( ExcludedInterval )

فهرست فواصل زمانی از این مرجع که در طول فرآیند تطبیق نادیده گرفته می‌شوند.

id

string

مقداری که یوتیوب اختصاص می‌دهد و برای شناسایی منحصر به فرد یک مرجع از آن استفاده می‌کند.

assetId

string

شناسه‌ای که به طور منحصر به فرد، دارایی مرتبط با مرجع را مشخص می‌کند.

duplicateLeader

string

شناسه‌ای که به طور منحصر به فرد مرجعی را که این مرجع کپی می‌کند، مشخص می‌کند. این فیلد فقط در صورتی وجود دارد که وضعیت مرجع به دلیل REASON_DUPLICATE_FOR_OWNERS inactive باشد.

claimId

string

این فیلد در صورتی وجود دارد که مرجع با مرتبط کردن یک دارایی با یک ویدیوی یوتیوب موجود که در یک کانال یوتیوب مرتبط با حساب CMS شما آپلود شده است، ایجاد شده باشد. در این صورت، این فیلد حاوی شناسه ادعایی است که نشان‌دهنده ارتباط حاصل بین دارایی و ویدیو است.

videoId

string

این فیلد در صورتی وجود دارد که مرجع با مرتبط کردن یک دارایی با یک ویدیوی یوتیوب موجود که در یک کانال یوتیوب مرتبط با حساب CMS شما آپلود شده است، ایجاد شده باشد. در این صورت، این فیلد حاوی شناسه ویدیوی منبع است.

بازه زمانی مستثنی شده

یک پنجره زمانی درون مرجع تعریف می‌کند که در طول فرآیند تطبیق نادیده گرفته خواهد شد.

نمایش JSON 
{
  "low": number,
  "high": number,
  "origin": string,
  "timeCreated": string
}
فیلدها
low

number

زمان شروع (شامل) بر حسب ثانیه از پنجره زمانی. مقدار می‌تواند هر مقداری بین 0 تا high باشد. هر بازه باید مقداری را برای این فیلد مشخص کند.

high

number

زمان پایان (شامل) پنجره زمانی بر حسب ثانیه. این مقدار می‌تواند هر مقداری بزرگتر از low باشد. اگر high بزرگتر از طول مرجع باشد، فاصله بین low و انتهای مرجع حذف خواهد شد. هر فاصله باید مقداری را برای این فیلد مشخص کند.

origin

string

منبع درخواست برای حذف بازه از تطبیق شناسه محتوا. مقادیر قابل قبول عبارتند از:

  • content_id_api - بازه حذف‌شده به‌صورت دستی با استفاده از API شناسه محتوا ایجاد شده است.
  • content_manager - بازه حذف‌شده در YouTube Studio یا Content Manager ایجاد شده است.
  • ingestion - بازه زمانی حذف شده در یک فید محتوای آپلود شده مشخص شده است.
  • invalid_segment - قطعه موجود در مرجع برای تطبیق نامعتبر است.
  • permanent_exclusion - این بخش توسط یوتیوب برای تطبیق نامعتبر تشخیص داده شده است.
  • reference_conflict - بازه حذف شده از یک تداخل مرجع ناشی شده است.
  • unknown - منبع محرومیت ناشناخته است.
timeCreated

string

تاریخ و زمانی که استثنا ایجاد شده است. مقدار در قالب RFC 3339 ( YYYY-MM-DDThh:mm:ss.000Z ) مشخص شده است.

روش‌ها

get

 اطلاعات مربوط به مرجع مشخص شده را بازیابی می‌کند.

insert

یک مرجع را به یکی از روش‌های زیر ایجاد می‌کند:

  • اگر درخواست شما آپلود یک فایل مرجع باشد، یوتیوب مرجع را از محتوای ارائه شده ایجاد می‌کند.

list

 فهرستی از منابع را بر اساس شناسه یا فهرست منابع برای دارایی مشخص شده بازیابی می‌کند.

patch

 یک مرجع را وصله می‌کند.

update

 یک مرجع را به‌روزرسانی می‌کند.