REST Resource: albums

المرجع: ألبوم

تمثيل بألبوم في "صور Google" الألبومات هي حاويات لعناصر الوسائط. إذا شارك التطبيق ألبومًا، سيحتوي على خاصية shareInfo إضافية.

تمثيل JSON 
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
الحقول
id

string

معرِّف الألبوم هذا مُعرّف ثابت يمكن استخدامه بين الجلسات لتحديد هذا الألبوم.
title

string

اسم الألبوم المعروض للمستخدم في حسابه على "صور Google" يجب ألا تزيد هذه السلسلة عن 500 حرف.
productUrl

string

[الإخراج فقط] عنوان URL للألبوم في "صور Google" على المستخدم تسجيل الدخول إلى حسابه على "صور Google" للوصول إلى هذا الرابط.
isWriteable

boolean

[الإخراج فقط] True إذا كان بإمكانك إنشاء عناصر وسائط في هذا الألبوم. يستند هذا الحقل إلى النطاقات التي تم منحها وأذونات الألبوم. في حال تغيير النطاقات أو تغيير أذونات الألبوم، يتم تحديث هذا الحقل.
shareInfo

object (ShareInfo)

[للإخراج فقط] معلومات ذات صلة بالألبومات المشترَكة لا تتم تعبئة هذا الحقل إلا إذا كان الألبوم ألبومًا مشترَكًا، وأنشأ المطوِّر الألبوم ومنح المستخدم النطاق photoslibrary.sharing.
mediaItemsCount

string (int64 format)

[الإخراج فقط] عدد عناصر الوسائط في الألبوم
coverPhotoBaseUrl

string

[الإخراج فقط] عنوان URL بوحدات البايت الخاصة بصورة الغلاف يجب عدم استخدام هذه المَعلمة كما هي، إذ يجب إلحاق المَعلمات بعنوان URL هذا قبل استخدامها. اطّلِع على مستندات المطوّرين للحصول على قائمة كاملة بالمعلَمات المتوافقة. على سبيل المثال، يضبط '=w2048-h1024' أبعاد صورة الغلاف على عرض 2048 بكسل وارتفاعه 1024 بكسل.
coverPhotoMediaItemId

string

معرّف لعنصر الوسائط المرتبط بصورة الغلاف.

ShareInfo

معلومات حول الألبومات التي تتم مشاركتها لا يتم تضمين هذه المعلومات إلا إذا أنشأت الألبوم، وتتم مشاركته ويكون لديك نطاق المشاركة.

تمثيل JSON 
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
الحقول
sharedAlbumOptions

object (SharedAlbumOptions)

خيارات تتحكّم في ما إذا كان بإمكان أحد المستخدمين إضافة ملفات وسائط إلى ألبوم مشترَك أو التعليق عليه
shareableUrl

string

رابط يؤدي إلى ألبوم "صور Google" المشترك يمكن لأي مستخدم لديه الرابط الاطّلاع على محتوى الألبوم، لذا يجب التعامل معه بحرص.

يتم عرض المَعلمة shareableUrl فقط إذا تم تفعيل ميزة "المشاركة باستخدام رابط" في الألبوم. إذا سبق أن انضم مستخدم إلى ألبوم غير مشترَك باستخدام رابط، يمكنه استخدام productUrl في الألبوم للوصول إليه بدلاً من ذلك.

يتم إلغاء shareableUrl إذا أوقف المالك ميزة "المشاركة باستخدام رابط" في تطبيق "صور Google" أو إذا تم إلغاء مشاركة الألبوم.
shareToken

string

يشير هذا المصطلح إلى رمز مميّز يُستخدم للانضمام إلى تفاصيل ألبوم مشترَك أو مغادرته أو استرداده نيابةً عن مستخدم ليس المالك.

يتم إلغاء shareToken إذا أوقف المالك ميزة "المشاركة باستخدام رابط" في تطبيق "صور Google" أو إذا تم إلغاء مشاركة الألبوم.
isJoined

boolean

True إذا كان المستخدم منضمًا إلى الألبوم. وينطبق ذلك دائمًا على مالك الألبوم.
isOwned

boolean

True إذا كان المستخدم يملك الألبوم.
isJoinable

boolean

True إذا كان يمكن للمستخدمين الانضمام إلى الألبوم.

SharedAlbumOptions

الخيارات التي تتحكّم في مشاركة ألبوم.

تمثيل JSON 
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
الحقول
isCollaborative

boolean

صحيح إذا كان الألبوم المشترك يسمح للمتعاونين (المستخدمون الذين انضموا إلى الألبوم) بإضافة عناصر وسائط إليه. يكون الإعداد التلقائي بالقيمة "خطأ".
isCommentable

boolean

صحيح إذا كان الألبوم المشترك يسمح للمتعاونين (المستخدمون الذين انضموا إلى الألبوم) بإضافة تعليقات إلى الألبوم. يكون الإعداد التلقائي بالقيمة "خطأ".

الطُرق

addEnrichment

 لإضافة محتوى موسيقي في موضع محدّد في ألبوم محدّد

batchAddMediaItems

 لإضافة عنصر وسائط واحد أو أكثر في مكتبة مستخدم "صور Google" إلى ألبوم.

batchRemoveMediaItems

 لإزالة عنصر وسائط واحد أو أكثر من ألبوم محدَّد.

create

 ينشئ ألبومًا في مكتبة "صور Google" للمستخدم.

get

 لعرض الألبوم استنادًا إلى albumId المحددة.

list

 يسرد جميع الألبومات المعروضة لمستخدم في علامة تبويب "الألبومات" بتطبيق "صور Google".

patch

 تعديل الألبوم باستخدام علامة id المحدّدة

share

 وضع علامة على ألبوم على أنّه مشترك ويمكن للمستخدمين الآخرين الوصول إليه

unshare

 وضع علامة على ألبوم تمت مشاركته سابقًا باعتباره خاصًا