میانای برنامهسازی کاربردی Google Sites نسخه کلاسیک به برنامههای شما اجازه میدهد به محتوای درون Google Sites دسترسی داشته باشند، آن را منتشر کنند، و تغییر دهند. علاوهبراین، برنامه شما میتواند فهرستی از فعالیتهای اخیر را درخواست کند، سابقه بازبینی را واکشی کند، و پیوستها و فایلها را بارگذاری/بارگیری کند.
مخاطبان
این سند فرض میکند که شما ایدههای کلی پشت پروتکل Google Data APIs را درک میکنید.
این سند برای برنامهنویسانی درنظر گرفته شده است که میخواهند برنامههای کارخواهی بنویسند که بتوانند با Google Sites تعامل داشته باشند. این راهنما مجموعهای از نمونههای تعاملهای پایه با میانای برنامهسازی کاربردی دادهها را بااستفاده از XML/HTTP خام، همراه با توضیحات ارائه میدهد. پساز خواندن این سند، میتوانید با خواندن نمونههای مختص زبان که در راهنماهای دیگر در نوار پیمایش سمت راست یافت میشود، درباره تعامل با API بااستفاده از کتابخانههای کارخواه ما بیشتر بدانید.
برای مرجع مطالب این راهنما، به راهنمای مرجع مراجعه کنید.
درحال صدور مجوز درخواستها
وقتی برنامهتان دادههای غیرعمومی کاربر را درخواست میکند، باید حاوی یک کد مجازسازی باشد. این کد همچنین برنامه شما را برای Google شناسایی میکند.
درباره پروتکلهای صدور مجوز
برنامه شما باید از OAuth 2.0 برای صدور مجوز درخواستها استفاده کند. از هیچ پروتکل مجوز دیگری پشتیبانی نمیشود. اگر برنامهتان از ورود به سیستم با Google استفاده میکند، برخیاز جنبههای صدور مجوز برای شما مدیریت میشود.
مجاز کردن درخواستها با OAuth 2.0
درخواستهای ارسالشده به Google Sites Data API برای دادههای غیرعمومی کاربر باید توسط کاربر اصالتسنجیشده مجاز شود.
جزئیات فرایند مجوز، یا «جریان»، برای OAuth 2.0 تا حدودی بسته به نوع برنامهای که مینویسید متفاوت است. فرایند کلی زیر برای همه انواع درخواستها اعمال میشود:
- وقتی برنامهتان را ایجاد میکنید، آن را بااستفاده از Google API Console ثبت میکنید. سپس Google اطلاعاتی را که بعداً نیاز خواهید داشت، مانند شناسه کارخواه و رمز کارخواه، ارائه میدهد.
- Google Sites Data API را در Google API Console فعال کنید. (اگر API در «کنسول API» فهرست نشده است، این مرحله را رد کنید.)
- وقتی برنامهتان به دسترسی به دادههای کاربر نیاز دارد، از Google درخواست محدوده دسترسی خاصی میکند.
- Google صفحه رضایت را به کاربر نشان میدهد و از او میخواهد به برنامه شما اجازه دهد برخیاز دادههایش را درخواست کند.
- اگر کاربر تأیید کند، Google کد دسترسی کوتاهمدتی به برنامه شما میدهد.
- برنامه شما دادههای کاربر را درخواست میکند و کد دسترسی را به درخواست پیوست میکند.
- اگر Google تشخیص دهد که درخواست و کد شما معتبر است، دادههای درخواستی را برمیگرداند.
برخیاز جریانها شامل مراحل اضافی هستند، مانند استفاده از ژتونهای بازآوری برای دریافت کد دسترسی جدید. برای اطلاعات دقیق درباره جریانهای انواع مختلف برنامهها، به اسناد OAuth 2.0 Google مراجعه کنید.
اطلاعات دامنه OAuth 2.0 برای Google Sites Data API در اینجا آمده است:
https://sites.google.com/feeds/
برای درخواست دسترسی بااستفاده از OAuth 2.0، برنامه شما به اطلاعات دامنه و همچنین اطلاعاتی که Google هنگام ثبت برنامه ارائه میدهد (مانند شناسه کارخواه و رمز کارخواه) نیاز دارد.
مشخص کردن نسخه
هر درخواستی که به Google Sites Data API ارسال میکنید باید نسخه ۱.۴ را مشخص کند. برای مشخص کردن شماره نسخه،
از سرایند HTTP GData-Version استفاده کنید:
GData-Version: 1.4
یا اگر نمیتوانید سرایندهای HTTP را تنظیم کنید، میتوانید v=1.4 را بهعنوان پارامتر پُرسمان در نشانی وب مشخص کنید. اما
سرایند HTTP درصورت امکان ترجیح داده میشود.
توجه: کتابخانههای کارخواه سرایندهای نسخه مناسب را بهطور خودکار ارائه میدهند، بنابراین
هنگام استفاده از کتابخانه کارخواه، از پارامتر پُرسمان v=1.4 استفاده نکنید.
فید سایت
از فید سایت میتوان برای فهرست کردن Google Sites که کاربر مالک آن است یا اجازه مشاهده آن را دارد و همچنین اصلاح عنوان سایت موجود استفاده کرد. برای دامنههای G Suite، همچنین میتوان از آن برای ایجاد یا کپی کردن کل سایت استفاده کرد.
سایتهای فهرستگان
برای فهرست کردن سایتهایی که کاربر به آنها دسترسی دارد، درخواست GET اصالتسنجیشدهای به نشانی وب زیر ارسال کنید:
https://sites.google.com/feeds/site/domainName| پارامتر فید | شرح |
|---|---|
domainName | «site» یا دامنه میزبانیشده G Suite شما (مثلاً example.com). |
پاسخ حاوی فیدی با فهرستی از سایتها خواهد بود:
GET /feeds/site/domainName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> HTTP/1.1 200 OK <feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:gAcl="http://schemas.google.com/acl/2007" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0"> <id>https://sites.google.com/feeds/site/site</id> <updated>2009-12-02T17:47:34.406Z</updated> <title>Site</title> <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="https://sites.google.com/feeds/site/site"/> <link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml" href="https://sites.google.com/feeds/feeds/site/domainName"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName"/> <link rel="next" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/?start-index=2"/> <generator version="1" uri="http://sites.google.com/">Google Sites</generator> <openSearch:startIndex>1</openSearch:startIndex> <entry gd:etag="W/"CkUAQH4_eil7I2A9WxNaFk4.""> <id>https://sites.google.com/feeds/site/site/myTestSite</id> <updated>2009-12-01T01:17:21.042Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-01T01:17:21.042Z</app:edited> <title>myTestSite</title> <summary/> <link rel="alternate" type="text/html" href="http://sites.google.com/site/myTestSite/"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/myTestSite"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myTestSite"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myTestSite"/> <sites:siteName>myTestSite</sites:siteName> <sites:theme>default</sites:theme> </entry> <entry gd:etag="W/"DkQGQHczfA9WxNaFk4.""> <id>https://sites.google.com/feeds/site/domainName/myOtherTestSite</id> <updated>2009-12-01T02:25:21.987Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-01T02:25:21.987Z</app:edited> <title>myOtherTestSite</title> <summary>A new site to hold memories</summary> <category scheme="http://schemas.google.com/sites/2008#tag" term="Memories Site"/> <link rel="alternate" type="text/html" href="http://sites.google.com/site/myOtherTestSite"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/myOtherTestSite"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myOtherTestSite"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myOtherTestSite"/> <sites:siteName>myOtherTestSite</sites:siteName> <sites:theme>iceberg</sites:theme> </entry> ... </feed>
سایتها بهترتیب حروف الفبا فهرست شدهاند.
ایجاد سایتهای جدید
توجه: این ویژگی فقط برای دامنههای G Suite دردسترس است.
سایتهای جدید را میتوان با ایجاد یک POST HTTP در فید سایت تهیه کرد، برای مثال:
POST /feeds/site/example.com HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:sites="http://schemas.google.com/sites/2008"> <title>Source Site</title> <summary>A new site to hold memories</summary> <sites:theme>slate</sites:theme> </entry>
درخواست بالا یک Google Site جدید با زمینه «slate» تحت دامنه G Suite example.com ایجاد میکند.
نشانی وب سایت http://sites.google.com/a/example.com/source-site/ خواهد بود.
اگر سایت باموفقیت ایجاد شود، سرور با 201 Created پاسخ خواهد داد.
ورودی پاسخ حاوی عناصری است که توسط سرور اضافه شده است، مانند پیوندی به
سایت، پیوندی به فید ACL سایت، نام سایت، عنوان و خلاصه.
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:gAcl="http://schemas.google.com/acl/2007"
xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006"
xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch"
xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0"
gd:etag="W/"DEECR38l7I2A9WxNaF0Q."">
<id>https://sites.google.com/feeds/site/example.com/source-site</id>
<updated>2009-12-02T23:31:06.184Z</updated>
<app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-02T23:31:06.184Z</app:edited>
<title>New Test Site</title>
<summary>A new site to hold memories</summary>
<link rel="alternate" type="text/html" href="http://sites.google.com/a/example.com/source-site/"/>
<link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/example.com/source-site"/>
<link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/source-site"/>
<link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/source-site"/>
<sites:siteName>source-site</sites:siteName>
<sites:theme>slate</sites:theme>
</entry>
کپی کردن سایت
توجه: این ویژگی فقط برای دامنههای G Suite دردسترس است.
سایت موجود را میتوان به همان روش ایجاد سایت جدید تکرار کرد. اما در ورودی Atom درخواست POST،
<link> را با rel='source' که به فید سایت موردنظر برای کپی کردن اشاره میکند اضافه کنید. هر سایتی که کپی شده باشد این پیوند را خواهد داشت. در اینجا مثالی برای تکرار سایت آورده شده است:
POST /feeds/site/example.com HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom"> <link rel="http://schemas.google.com/sites/2008#source" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/source-site"/> <title>Copy of New Test Site</title> <summary>A newer site to hold memories</summary> </entry>
درخواست بالا سایت را در http://sites.google.com/a/example.com/source-site/ کپی میکند.
نکتههای مهم:
- فقط سایتها و الگوهای سایتی که کاربر اصالتسنجیشده مالک آنها است میتوانند کپی شوند.
- الگوی سایت را هم میتوان کپی کرد. اگر تنظیم «انتشار این سایت بهعنوان الگو» در صفحه تنظیمات Google Sites علامت زده شده باشد، سایت الگو است.
- میتوانید سایتی را از دامنه دیگری کپی کنید، مشروط بر اینکه بهعنوان مالک در سایت منبع فهرست شده باشید.
بهروزرسانی فراداده سایت
برای بهروزرسانی عنوان یا خلاصه سایت، یک PUT HTTP به پیوند edit ورودی سایت ارسال کنید.
برای مثال، نمونه زیر عنوان سایت قبلی را به New Test Site2 و شرح آن را به Newer description بهروزرسانی میکند.
PUT /feeds/site/example.com/source-site HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:gAcl="http://schemas.google.com/acl/2007" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0" gd:etag="W/"DEECR38l7I2A9WxNaF0Q.""> <id>https://sites.google.com/feeds/site/example.com/source-site</id> <updated>2009-12-02T23:31:06.184Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-02T23:31:06.184Z</app:edited> <title>New Test Site2</title> <summary>Newer description</summary> <category scheme="http://schemas.google.com/sites/2008#tag" term="Category"/> <link rel="alternate" type="text/html" href="http://sites.google.com/a/example.com/source-site/"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/example.com/source-site"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/source-site"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/source-site"/> <sites:siteName>source-site</sites:siteName> </entry>
افزودن دستهها
توجه: این ویژگی فقط برای دامنههای G Suite دردسترس است.
سایتهای G Suite برای دامنه شما شامل فرادادههای دستهبندی هستند که برای دستهبندی سایتها در دامنه شما مفید است. برای افزودن یا بهروزرسانی فراداده دسته، یک PUT HTTP به پیوند edit ورودی سایتتان که شامل برچسب category است ارسال کنید. خط پررنگ را در مثال زیر ببینید:
PUT /feeds/site/example.com/source-site HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:gAcl="http://schemas.google.com/acl/2007" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0" gd:etag="W/"DEECR38l7I2A9WxNaF0Q.""> <id>https://sites.google.com/feeds/site/example.com/source-site</id> <updated>2009-12-02T23:31:06.184Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-02T23:31:06.184Z</app:edited> <title>My Team website</title> <summary>This site contains contact information and a summary of major efforts our team owns</summary> <category scheme="http://schemas.google.com/sites/2008#tag" term="Team Site"/> <link rel="alternate" type="text/html" href="http://sites.google.com/a/example.com/my-team-site/"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/example.com/my-team-site"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/my-team-site"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/my-team-site"/> <sites:siteName>my-team-site</sites:siteName> </entry>
این نمونه سایت موجودی را ویرایش میکند و دسته «سایت تیم» را اضافه میکند.
همچنین میتوانید با افزودن برچسبهای <category> بیشتر، چند دسته اضافه کنید. خطوط پررنگ را در مثال زیر ببینید:
PUT /feeds/site/example.com/my-team-site HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:gAcl="http://schemas.google.com/acl/2007" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0" gd:etag="W/"DEECR38l7I2A9WxNaF0Q.""> <id>https://sites.google.com/feeds/site/example.com/my-team-site</id> <updated>2009-12-02T23:31:06.184Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-02T23:31:06.184Z</app:edited> <title>My Team website</title> <summary>This site contains contact information and a summary of major efforts our team owns</summary> <category scheme="http://schemas.google.com/sites/2008#tag" term="Team Site/"> <category scheme="http://schemas.google.com/sites/2008#tag" term="Legal Department/"> <link rel="alternate" type="text/html" href="http://sites.google.com/a/example.com/my-team-site/"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/example.com/my-team-site"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/my-team-site"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/example.com/my-team-site"/> <sites:siteName>my-team-site</sites:siteName> </entry>
این مثال دو دسته اضافه میکند: «سایت تیم» و «بخش حقوقی»
تخصیصهای نشانی وب
تخصیص نشانی وب به کاربران Sites امکان میدهد دامنههای خودشان را به Google Site تخصیص دهند. برای مثال، میتوان از http://www.mydomainsite.com
بهجای http://sites.google.com/a/domain.com/mysite استفاده کرد. بسته به اینکه سایت شما کجا میزبانی میشود، میتوانید تخصیصهای نشانی وب سایت را بهصورت دستی اصلاح کنید. برای اطلاعات بیشتر، مقاله مرکز راهنمایی ما را ببینید.
درحال واکشی تخصیصهای نشانی وب سایت
برای برگرداندن تخصیصهای نشانی وب برای یک سایت، ورودی/فید سایت را با پارامتر with-mappings=true واکشی کنید:
GET /feeds/site/domainName?with-mappings=true HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> HTTP/1.1 200 OK <feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:gAcl="http://schemas.google.com/acl/2007" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0"> ... <entry gd:etag="W/"DkQGQHczfA9WxNaFk4.""> <id>https://sites.google.com/feeds/site/domainName/myOtherTestSite</id> <updated>2009-12-01T02:25:21.987Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-01T02:25:21.987Z</app:edited> <title>myOtherTestSite</title> <summary>A new site to hold memories</summary> <link rel="alternate" type="text/html" href="http://sites.google.com/site/myOtherTestSite"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/myOtherTestSite"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myOtherTestSite"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myOtherTestSite"/> <link rel='webAddressMapping' href='http://www.mysitemapping.com'> <link rel='webAddressMapping' href='http://www.mysitemapping2.com'> <link rel='webAddressMapping' href='http://www.myothermapping.org'> </entry> ... </feed>
نگاشتهای موجود بهصورت link با rel='webAddressMapping' نشان داده میشود. برای مثال، در نمونه بالا
سه webAddressMapping وجود دارد که به سایت
http://sites.google.com/site/myOtherTestSite اشاره میکند.
اصلاح تخصیص نشانی وب
توجه: همه عملیات GET/POST/PUT باید پارامتر with-mappings=true را هنگام کار با تخصیص نشانی وب مشخص کنند. اگر پارامتر وجود نداشته باشد، webAddressMappings در ورودیهای سایت (GET) برگردانده نخواهد شد یا هنگام بهروزرسانی/برداشتن (PUT) نگاشتها از ورودی درنظر گرفته نخواهد شد.
برای افزودن، بهروزرسانی، یا حذف کردن نگاشت، کافی است هنگام ایجاد سایتهای جدید یا بهروزرسانی فراداده سایت، چنین پیوندی را مشخص، تغییر، یا حذف کنید. پارامتر with-mappings=true باید در URI فید سایت گنجانده شود.
توجه: برای بهروزرسانی نگاشتهای نشانی، باید سرپرست سایت باشید، یا درصورت وجود سایت میزبانیشده G Suite، سرپرست دامنه باشید.
برای مثال، درخواست زیر نگاشت http://www.mysitemapping.com را به http://www.my-new-sitemapping.com بهروز میکند،
و http://www.mysitemapping2.com را با حذف پیوند از ورودی برمیدارد:
PUT /feeds/site/domainName?with-mappings=true HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry gd:etag="W/"DkQGQHczfA9WxNaFk4.""> <id>https://sites.google.com/feeds/site/domainName/myOtherTestSite</id> <updated>2009-12-01T02:25:21.987Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-01T02:25:21.987Z</app:edited> <title>myOtherTestSite</title> <summary>A new site to hold memories</summary> <link rel="alternate" type="text/html" href="http://sites.google.com/site/myOtherTestSite"/> <link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/myOtherTestSite"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myOtherTestSite"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/site/domainName/myOtherTestSite"/> <link rel='webAddressMapping' href='www.my-new-sitemapping.com'> <!-- missing mapping2 will be deleted --> <link rel='webAddressMapping' href='http://www.myothermapping.org'> </entry>
توجه: تخصیص نشانی وب را میتوان در زمان ایجاد/کپی کردن سایت نیز مشخص کرد.
فید فعالیتها
میتوانید فعالیتهای اخیر (تغییرات) یک سایت را با واکشی فید فعالیت واکشی کنید. هر ورودی در فید فعالیت حاوی اطلاعاتی درباره تغییری است که در «سایت» ایجاد شده است.
برای جستجوی فید فعالیت، یک HTTP GET به نشانی وب فید فعالیت ارسال کنید:
https://sites.google.com/feeds/activity/domainName/siteName
| پارامتر فید | شرح |
|---|---|
domainName | «site» یا دامنه میزبانیشده G Suite شما (مثلاً example.com). |
siteName | نام فضای وب سایت شما؛ در نشانی وب سایت یافت میشود (مثلاً myCoolSite). |
نمونه درخواست و پاسخ:
GET /feeds/activity/site/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/"> <id>https://sites.google.com/feeds/activity/site/siteName</id> <updated>2009-09-10T05:24:23.120Z</updated> <title>Activity</title> <link rel="alternate" type="text/html" href="http://sites.google.com/site/siteName/system/app/pages/recentChanges"/> <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="https://sites.google.com/feeds/activity/site/siteName"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/activity/site/siteName"/> <generator version="1" uri="http://sites.google.com">Google Sites</generator> <openSearch:startIndex>1</openSearch:startIndex> <entry xmlns:gd="http://schemas.google.com/g/2005" gd:etag="W/"CU4GQ3szfSl7ImA9WxNRFUg.""> <id>https://sites.google.com/feeds/activity/site/siteName/940375996952876062</id> <updated>2009-09-10T03:38:42.585Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#deletion" label="deletion"/> <title>home</title> <summary type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">User deleted <a href="http://sites.google.com/site/siteName/home">home</a> </div> </summary> <link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml" href="https://sites.google.com/feeds/revision/site/siteName/5409745539831916487"/> <link rel="http://schemas.google.com/sites/2008#current" type="application/atom+xml" href="https://sites.google.com/feeds/content/site/siteName/5409745539831916487"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/activity/site/siteName/940375996952876062"/> <author> <name>User</name> <email>user@gmail.com</email> </author> </entry> <entry xmlns:gd="http://schemas.google.com/g/2005" gd:etag="W/"CU8DQn45fyl7ImA9WxNRFUg.""> <id>https://sites.google.com/feeds/activity/site/siteName/7165439066235480082</id> <updated>2009-09-10T03:37:53.027Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#edit" label="edit"/> <title>home</title> <summary type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">User2 edited <a href="http://sites.google.com/site/siteName/home">home</a> </div> </summary> <link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml" href="https://sites.google.com/feeds/revision/site/siteName/5409745539831916487"/> <link rel="http://schemas.google.com/sites/2008#current" type="application/atom+xml" href="https://sites.google.com/feeds/content/site/siteName/5409745539831916487"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/activity/site/siteName/7165439066235480082"/> <author> <name>User</name> <email>user@gmail.com</email> </author> </entry> <entry xmlns:gd="http://schemas.google.com/g/2005" gd:etag="W/"CU8AR3s4cSl7ImA9WxNRFUg.""> <id>https://sites.google.com/feeds/activity/site/siteName/127448462987345884</id> <updated>2009-09-10T03:37:26.539Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#creation" label="creation"/> <title>home</title> <summary type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">User3 created <a href="http://sites.google.com/site/siteName/home">home</a> </div> </summary> <link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml" href="https://sites.google.com/feeds/revision/site/siteName/5409745539831916487"/> <link rel="http://schemas.google.com/sites/2008#current" type="application/atom+xml" href="https://sites.google.com/feeds/content/site/siteName/5409745539831916487"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/activity/site/siteName/127448462987345884"/> <author> <name>User3</name> <email>user3@gmail.com</email> </author> </entry> </feed>
توجه: برای دسترسی به این فید باید مشارکتکننده یا مالک سایت باشید.
کارخواه شما باید سرایند Authorization صحیح را ارسال کند و به کد بهدستآمده در
درخواستهای صدور مجوز ارجاع دهد.
فید بازبینی
برای واکشی سابقه ویرایش برای هر ورودی محتوا، یک HTTP GET به پیوند ویرایش ورودی ارسال کنید:
https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID
| پارامتر فید | شرح |
|---|---|
domainName | «site» یا دامنه میزبانیشده G Suite شما (مثلاً example.com). |
siteName | نام فضای وب سایت شما؛ در نشانی وب سایت یافت میشود (مثلاً myCoolSite). |
برای پیدا کردن پیوند بازبینیها برای صفحه/نظر/پیوست/مورد فهرست دادهشده، ابتدا ورودی را از
فید محتوا بااستفاده از CONTENT_ENTRY_ID آن بازیابی کنید. ورودی بازیابیشده حاوی یک <atom:link> به فید بازبینی خواهد بود.
برای مثال:
<link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml"
href="https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID"/>
نمونه درخواست و پاسخ:
GET /feeds/revision/domainName/siteName/CONTENT_ENTRY_ID HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0"> <id>https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID</id> <updated>2009-09-10T04:33:35.337Z</updated> <title>Revisions</title> <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID"/> <generator version="1" uri="http://sites.google.com">Google Sites</generator> <openSearch:startIndex>1</openSearch:startIndex> <entry gd:etag="W/"CU4GQmA9WxNRFUg.""> <id>https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID/2</id> <updated>2009-09-10T03:38:42.045Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <title>Home</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">Latest content here</div> </content> <link rel="alternate" type="text/html" href="http://sites.google.com/domainName/siteName/CONTENT_ENTRY_ID/system/app/pages/admin/compare?wuid=wuid%3Agx%3A4f67c7&rev1=2"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID/2"/> <author> <name>User</name> <email>user@gmail.com</email> </author> <sites:pageName>home</sites:pageName> <sites:revision>2</sites:revision> </entry> <entry gd:etag="W/"CU8DQ388eSl7ImA9WxNRFUg.""> <id>https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID/1</id> <updated>2009-09-10T03:37:52.171Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <title>Home</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">Older content here</div> </content> <link rel="alternate" type="text/html" href="http://sites.google.com/domainName/siteName/CONTENT_ENTRY_ID/system/app/pages/admin/compare?wuid=wuid%3Agx%3A4bc7&rev1=1"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/CONTENT_ENTRY_ID/1"/> <author> <name>User</name> <email>user@gmail.com</email> </author> <sites:pageName>home</sites:pageName> <sites:revision>1</sites:revision> </entry> </feed>
توجه: برای دسترسی به این فید باید مشارکتکننده یا مالک سایت باشید.
کارخواه شما باید سرایند Authorization صحیح را ارسال کند و به کد دریافتی در درخواستهای صدور مجوز ارجاع دهد.
فید محتوا
درحال بازیابی محتوا
فید محتوا محتوای فعلی «سایتها» را فهرست میکند. درخواست GET اصالتسنجیشدهای به نشانی وب زیر ارسال کنید:
https://sites.google.com/feeds/content/domainName/siteName
| پارامتر فید | شرح |
|---|---|
domainName | «site» یا دامنه میزبانیشده G Suite شما (مثلاً example.com). |
siteName | نام فضای وب سایت شما؛ در نشانی وب سایت یافت میشود (مثلاً myCoolSite). |
نتیجه فیدی است که صفحه اول ورودیهای محتوا را در «سایت» فهرست میکند. هر ورودی در فید نشاندهنده نوع متفاوتی از ورودی محتوا است،
مانند webpage، filecabinet، attachment، comment، و غیره. عنصر
<category scheme="http://schemas.google.com/g/2005#kind"> نوع ورودی را تعیین میکند. برای مشاهده فهرست مقادیر پشتیبانیشده kind،
راهنمای مرجع را ببینید.
توجه: این فید ممکن است به اصالتسنجی نیاز داشته باشد یا نداشته باشد؛ بسته به اجازههای همرسانی سایت.
اگر «سایت» غیرعمومی است، کارخواه شما باید سرایند Authorization صحیح را ارسال کند (همانطور که در مثال بالا دیده میشود)
و به کد بهدستآمده در درخواستهای صدور مجوز ارجاع دهد.
GET /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0"> <id>https://sites.google.com/feeds/content/domainName/siteName</id> <updated>2009-08-31T01:39:20.286Z</updated> <title>Content</title> <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName"/> <link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName"/> <link rel="http://schemas.google.com/g/2005#batch" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/batch""/> <link rel="next" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/?start-index=2"/> <generator version="1" uri="http://sites.google.com">Google Sites</generator> <openSearch:startIndex>1</openSearch:startIndex> <entry gd:etag="W/"Ck8GQXk7fil7ImA9WxNSFk0.""> <id>https://sites.google.com/feeds/content/domainName/siteName/7322156894</id> <updated>2009-08-30T02:53:40.706Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-08-30T02:53:40.706Z</app:edited> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <title>Subpage</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">Page html content here</div> </content> <link rel="http://schemas.google.com/sites/2008#parent" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/6492205817"/> <link rel="alternate" type="text" href="http://sites.google.com/site/siteName/subpage"/> <link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/7322156894"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/7322156894"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/7322156894"/> <author> <name>User</name> <email>user@gmail.com</email> </author> <sites:pageName>subpage</sites:pageName> <sites:revision>5</sites:revision> </entry> <entry gd:etag="W/"CkMBQH08fCl7ImA9WxNSFk0.""> <id>https://sites.google.com/feeds/content/domainName/siteName/5930635231</id> <updated>2009-08-30T02:47:31.374Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-08-30T02:47:31.374Z</app:edited> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#listitem" label="listpage"/> <title/> <link rel="http://schemas.google.com/sites/2008#parent" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/5930635231"/> <link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/5930635231"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/5930635231"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/5930635231"/> <author> <name>User</name> <email>user@gmail.com</email> </author> <sites:revision>1</sites:revision> <gs:field index="A" name="Issue/Feature">Implement cool feature X</gs:field> <gs:field index="B" name="Priority">P2</gs:field> <gs:field index="C" name="Owner"/> <gs:field index="D" name="Resolved"/> </entry> <entry gd:etag="W/"AkYHQ3ozcCl7ImA9WxJaE08.""> <id>https://sites.google.com/feeds/content/domainName/siteName/1265948545471894517</id> <updated>2009-08-03T19:35:32.488Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-08-03T19:35:32.488Z</app:edited> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#filecabinet" label="filecabinet"/> <title>files</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">Page html content here</div> </content> <link rel="alternate" type="text" href="https://sites.google.com/domainName/siteName/files"/> <link rel="http://schemas.google.com/sites/2008#revision" type="application/atom+xml" href="https://sites.google.com/feeds/revision/domainName/siteName/12671894517"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/12671894517"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/12671894517"/> <author> <name>User</name> <email>user@gmail.com</email> </author> <gd:feedLink href="httpn://sites.google.com/feeds/content/domainName/siteName?parent=12671894517"/> <sites:pageName>files</sites:pageName> <sites:revision>1</sites:revision> </entry> ... </feed>
توجه: این فقط چند نتیجه اول است. برای ورق زدن کل فید محتوا، پیوند «بعدی» فید را دنبال کنید:
<link rel="next" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/?start-index=2"/>
برای توضیح عناصر مشترک با Atom، به مرجع پروتکل دادههای Google مراجعه کنید.
عناصری که معنای خاصی برای API نسخه کلاسیک Sites دارند در زیر شرح داده شدهاند. برخیاز ورودیهای نوع دارای ویژگیهای اضافی (که در زیر فهرست نشدهاند) خواهند بود، درحالیکه
دیگران نخواهند داشت. برای مثال، ورودی listitem ممکن است عناصر <gs:field> داشته باشد، درحالیکه ورودی webpage ندارد.
| عنصر | شرح |
|---|---|
<content ...> | نوشتار داخلی بدنه HTML صفحه است. برای برخی ورودیها (مثلاً پیوستها)، این عنصر حاوی مشخصه src خواهد بود که به فایل اشاره میکند. |
<link rel="alternate" ...> | پیوند به صفحه یا مورد در Google Sites. |
<link rel="http://schemas.google.com/sites/2008#revision" ...> | مشخصه href به فید بازبینی ورودی اشاره میکند. |
<link rel="http://schemas.google.com/sites/2008#parent" ...> | مشخصه href به ورودی ولی ورودی اشاره میکند. |
<link rel="http://schemas.google.com/sites/2008#template" ...> | مشخصه href به صفحه الگوی ورودی اشاره میکند. |
<category scheme="http://schemas.google.com/g/2005#kind" ...> | label نوع ورودی است. |
<category term="http://schemas.google.com/g/2005#template" ...> | label=template نشاندهنده این است که ورودی الگو است. |
<gd:feedLink> | مشخصه href به فرزندان ولی ورودی اشاره میکند. |
<sites:pageName> | نام فضای وب صفحه؛ مطابق با نام در نشانی وب صفحه. |
<sites:revision> | شماره بازبینی فعلی. |
نمونههای پُرسمان فید محتوا
میتوانید بااستفاده از برخیاز پارامترهای پُرسمان Google Data API استاندارد و پارامترهای مختص classic Sites API، در فید محتوا جستجو کنید. برای اطلاعات دقیقتر و فهرست کامل پارامترهای پشتیبانیشده، راهنمای مرجع را ببینید.
درحال بازیابی انواع ورودیهای خاص
برای واکشی فقط نوع خاصی از ورودی، از پارامتر kind استفاده کنید. این مثال فقط webpage ورودی را برمیگرداند:
GET /feeds/content/domainName/siteName?kind=webpage
برای برگرداندن بیش از یک نوع ورودی، هر kind را با «،» جدا کنید. این مثال ورودیهای filecabinet و listpage را برمیگرداند:
GET /feeds/content/domainName/siteName?kind=filecabinet,listpage
بهعنوان جایگزین، میتوانید از قالب استاندارد برای پُرسمان Google Data /-/category بهجای پارامتر kind استفاده کنید:
GET /feeds/content/domainName/siteName/-/filecabinet|listpage
درحال بازیابی الگوهای صفحه
این مثال فقط template صفحه را برمیگرداند:
GET /feeds/content/domainName/siteName/-/template
برای برگرداندن همه انواع ورودی و لحاظ کردن صفحههای template، از این مورد استفاده کنید:
GET /feeds/content/domainName/siteName/-/template|-template
درحال بازیابی صفحه براساس مسیر
اگر مسیر نسبی صفحهای را در Google Site میدانید، میتوانید از پارامتر path برای واکشی آن صفحه خاص استفاده کنید.
این نمونه صفحه واقع در
http://sites.google.com/site/siteName/path/to/the/page را برمیگرداند:
GET /feeds/content/domainName/siteName?path=/path/to/the/page
بازیابی همه ورودیهای زیر صفحه اصلی
اگر شناسه ورودی صفحهای را میدانید، میتوانید از پارامتر parent برای واکشی همه ورودیهای فرزند آن (درصورت وجود) استفاده کنید:
GET /feeds/content/domainName/siteName?parent=CONTENT_ENTRY_ID
ازجمله پیشنویسها یا ورودیهای حذفشده
برای گنجاندن ورودیهای پیشنویس یا حذفشده، بهترتیب از پارامترهای include-drafts یا include-deleted استفاده کنید.
این نمونه شامل ورودیهای پیشنویس در فید محتوا است:
GET /feeds/content/domainName/siteName?include-drafts=true
جستجوی کل نوشتار
برای جستجو در کل محتوای سایت، از پارامتر q برای جستجوی کل نوشتار استفاده کنید:
GET /feeds/content/domainName/siteName?q=Text%20I%20am%20looking%20for
درحال ایجاد محتوا
محتوای جدید (صفحههای وب، صفحههای فهرست، صفحههای قفسه فایل، صفحههای اعلامیه، و غیره) را میتوان با ارسال HTTP POST
به فید محتوا ایجاد کرد:
https://sites.google.com/feeds/content/domainName/siteName
برای مشاهده فهرست انواع ورودیهای پشتیبانیشده، پارامتر kind را در راهنمای مرجع ببینید.
درحال ایجاد موارد / صفحههای جدید
این نمونه webpage جدیدی را در سطح بالای «سایت» ایجاد میکند، شامل XHTML برای بدنه صفحه است،
و عنوان سرصفحه را روی «عنوان صفحه وب جدید» تنظیم میکند:
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 328 Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <title>New Webpage Title</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">HTML body goes here</div> </content> </entry>
اگر موفقیتآمیز باشد، سرور با 201 Created و نسخهای از ورودی پاسخ میدهد.
ایجاد موارد/صفحهها تحت مسیرهای نشانی وب سفارشی
بهطور پیشفرض، مثال قبلی تحت نشانی وب
http://sites.google.com/domainName/siteName/new-webpage-title ایجاد میشود و
عنوان صفحه آن «عنوان صفحه وب جدید» خواهد بود. یعنی <atom:title> برای نشانی وب به new-webpage-title نرمالسازی میشود.
برای سفارشیسازی مسیر نشانی وب صفحه، میتوانید عنصر <sites:pageName> را تنظیم کنید.
این مثال filecabinet جدیدی با عنوان صفحه «فضای ذخیرهسازی فایل» ایجاد میکند، اما صفحه را
با مشخص کردن عنصر <sites:pageName>
در نشانی وب http://sites.google.com/domainName/siteName/files ایجاد میکند.
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 393 Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom" xmlns:sites="http://schemas.google.com/sites/2008"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#filecabinet" label="filecabinet"/> <title>File Storage</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">A list of files is below.</div> </content> <sites:pageName>files</sites:pageName> </entry>
سرور از قوانین تقدم زیر برای نامگذاری مسیر نشانی وب صفحه استفاده میکند:
<sites:pageName>، درصورت وجود. بایدa-z, A-Z, 0-9, -, _را برآورده کند.<atom:title>، اگر pageName وجود نداشته باشد، نباید تهی باشد. عادیسازی برای پیرایش + جمع کردن فاصله سفید به «-» و برداشتن نویسههایی است که باa-z, A-Z, 0-9, -, _مطابقت ندارند.
برای مثال، «Custom_Page2» توسط سرور پذیرفته میشود.
درحال ایجاد زیرصفحه
برای ایجاد زیرصفحه (فرزند) در زیر صفحه اصلی، <link rel="http://schemas.google.com/sites/2008#parent"> را در ورودی Atom جدیدتان اضافه کنید. مشخصه href پیوند را روی پیوند به خود ورودی ولی تنظیم کنید.
این نمونه announcement جدیدی با عنوان «اعلامیه» در زیر صفحه اعلامیه اصلی با شناسه ورودی PARENT_ENTRY_ID ایجاد میکند. محتوای XHTML برای متن اصلی صفحه نیز گنجانده شده است:
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 470 Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#announcement" label="announcement"/> <link rel="http://schemas.google.com/sites/2008#parent" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/PARENT_ENTRY_ID"/> <title>announcement</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">This weekend. My place.</div> </content> </entry>
الگوهای صفحه
درحال ایجاد الگوهای صفحه
فرایند ایجاد الگوی صفحه مانند ایجاد موارد/صفحههای جدید و
ایجاد زیرصفحهها است. تفاوت در افزودن category با عبارت و برچسب تنظیمشده روی «http://schemas.google.com/g/2005#template»
و «template» است.
این مثال الگوی webpage جدیدی ایجاد میکند.
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 464 Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom" xmlns:sites="http://schemas.google.com/sites/2008"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <category scheme="http://schemas.google.com/g/2005#labels" term="http://schemas.google.com/g/2005#template" label="template"/> <title>Webpage Template</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">This weekend. My place.</div> </content> </entry>
ایجاد کردن صفحه از الگو
Similar to creating page templates, you can instantiate a new page from a template by including a <link> with rel='http://schemas.google.com/sites/2008#template' pointing
to the self link of a page template.
این مثال یک صفحه filecabinet جدید از یک الگوی صفحه موجود ایجاد میکند که یک فایلکابینت را تعریف میکند.
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 464 Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom" xmlns:sites="http://schemas.google.com/sites/2008"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#filecabinet" label="filecabinet"/> <title>File Cabinet Page From Template</title> <link rel='http://schemas.google.com/sites/2008#template' type='application/atom+xml' href='https://sites.google.com/feeds/content/domainName/siteName/ENTRY_ID'/> </entry>
توجه: با اینکه الگو <category> را تعریف میکند، همچنان باید آن را در ورودیتان بگنجانید. همچنین توجه داشته باشید که اگر عنصر <content> را اضافه کنید، سرور آن را رد خواهد کرد.
درحال بارگذاری فایل
درست مانند Google Sites، این API به شما امکان میدهد پیوستها را در صفحات کابینت فایل و صفحات اصلی بارگذاری کنید.
برای بارگذاری پیوست در والد، درخواست HTTP POST را به نشانی وب فید محتوا ارسال کنید:
https://sites.google.com/feeds/content/domainName/siteName
بدنه POST باید یک درخواست چندبخشی MIME باشد تا محتوای فایل را با یک <atom:entry> حاوی فراداده پیوست ترکیب کند. <atom:entry> باید به پیوند به خود ورودی اصلی ارجاع دهد تا مشخص شود پیوست کجا ایجاد خواهد شد.
برای اطلاعات بیشتر، ایجاد زیرصفحه را ببینید.
درحال بارگذاری پیوست
در اینجا مثالی از بارگذاری فایل PDF در کابینت فایل با شناسه PARENT_ENTRY_ID آورده شده است. پیوست با عنوان «فایل PDF» و شرح (اختیاری) «بسته منابع انسانی» ایجاد خواهد شد.
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 7221984 Content-Type: multipart/related; boundary=END_OF_PART --END_OF_PART Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#attachment" label="attachment"/> <link rel="http://schemas.google.com/sites/2008#parent" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/PARENT_ENTRY_ID"/> <title>PDF File</title> <summary>HR packet</summary> </entry> --END_OF_PART Content-Type: application/pdf ... pdf contents here ... --END_OF_PART--
اگر بارگذاری موفقیتآمیز باشد، سرور با 201 Created و نسخهای از ورودی پیوست جدید ایجادشده پاسخ میدهد.
بارگذاری پیوست در پوشه
برای بارگذاری پیوست در پوشه موجود در filecabinet، دستهای را اضافه کنید که مشخصه «term» آن روی نام پوشه تنظیم شده باشد:
<category scheme="http://schemas.google.com/sites/2008#folder" term="FolderName">پیوستهای وب
پیوستهای وب نوع خاصی از پیوستها هستند. درواقع، اینها پیوندهایی به فایلهای دیگر در وب هستند که میتوانید به فهرستهای فایلدان خود اضافه کنید. این ویژگی مشابه روش بارگذاری «افزودن فایل ازطریق نشانی وب» در واسط کاربر Google Sites است.
توجه: پیوستهای وب را فقط میتوان در کابینت فایل ایجاد کرد. نمیتوان آنها را در انواع دیگر صفحهها بارگذاری کرد.
این مثال یک webattachment را تحت فایل کابینت ارجاع داده شده توسط شناسه FILECABINET_ENTRY_ID ایجاد میکند.
عنوان و شرح (اختیاری) آن بهترتیب روی «GoogleLogo» و «رنگهای زیبا» تنظیم شده است.
POST /feeds/content/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Type: application/atom+xml Content-Length: 531 <entry xmlns="http://www.w3.org/2005/Atom"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webattachment" label="webattachment"/> <link rel="http://schemas.google.com/sites/2008#parent" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/FILECABINET_ENTRY_ID"/> <title>GoogleLogo</title> <summary>nice colors</summary> <content type="image/gif" src="http://www.google.com/images/logo.gif"></content> </entry>
POST پیوندی در فایلکابینت کاربر ایجاد میکند که به تصویر در «http://www.google.com/images/logo.gif» اشاره میکند.
درحال بهروزرسانی محتوا
فراداده (عنوان، pageName، و غیره) و محتوای صفحه هر صفحهای را میتوان با یک درخواست PUT به پیوند edit ویرایش کرد.
بدنه درخواست باید حاوی ورودی Atom باشد که صفحه بهروزشده را توصیف میکند. استثنای این قانون ورودی پیوست است که در آن ورودی فقط میتواند برای بهروزرسانی فراداده پیوست استفاده شود.
برای تغییر محتوای فایل پیوستشده، کافی است دادههای خام را بهعنوان بدنه درخواست PUT به پیوند edit-media پیوست اضافه کنید. همچنین میتوانید هم فراداده و هم محتوای فایل پیوستشده را بهطور همزمان بااستفاده از درخواست چندبخشی MIME بهروز کنید.
برای اطمینان از اینکه بهروزرسانی شما تغییرات مشتری دیگری را رونویسی نمیکند، مقدار ETag ورودی اصلی را اضافه کنید. میتوانید این کار را با ارائه مقدار ETag در سرصفحه HTTP If-Match یا با گنجاندن مشخصه gd:etag ورودی اصلی در ورودی بهروزشده انجام دهید. برای تعیین مقدار ETag ورودی اصلی، مشخصه gd:etag عنصر <entry> را بررسی کنید.
برای ورودیهای رسانه، ETag رسانه ممکن است در مشخصه gd:etag پیوند edit-media دردسترس باشد.
اگر میخواهید ورودی را بهروز کنید، صرفنظر از اینکه شخص دیگری آن را از زمانی که شما بازیابی کردهاید بهروز کرده است یا نه، از
If-Match: * استفاده کنید و ETag را اضافه نکنید. برای اطلاعات بیشتر درباره ETags، به
راهنمای مرجع Google Data APIs مراجعه کنید.
بهروزرسانی فراداده یا محتوای html مورد
برای بهروزرسانی فراداده یا محتوای HTML یک ورودی، یک HTTP PUT به پیوند edit ورودی ارسال کنید.
در زیر نمونهای از بهروزرسانی ورودی listpage (که با شناسه ENTRY_ID نشان داده شده است) با تغییرات زیر آورده شده است:
- عنوان به «محتوای بهروزشده» تغییر میکند
- محتوای HTML بهروزرسانیشده
- عنوان ستون اول فهرست به «مالک» بهروزرسانی شده است
- مسیر نشانی وب صفحه توسط عنصر
<sites:pageName>اصلاح شده است
PUT /feeds/content/domainName/siteName/ENTRY_ID Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 816 Content-Type: application/atom+xml <entry xmlns="http://www.w3.org/2005/Atom" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:gd="http://schemas.google.com/g/2005" gd:etag="W/"CEEBRn0ymA9WxJWEUw.""> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#listpage" label="listpage"/> <title>Updated Title</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">Updated Content</div> </content> <gs:worksheet name="listpage"/> <gs:header row="1"/> <gs:data startRow="2"> <gs:column index="A" name="Owner"/> <gs:column index="B" name="Description"/> <gs:column index="C" name="Completed"/> </gs:data> <sites:pageName>newPagePath</sites:pageName> </entry>
توجه: ورودی (همانطور که توسط سرور برگردانده میشود) عناصر بیشتری نسبت به مثال بالا خواهد داشت.
جایگزین کردن محتوای پیوست
در زیر مثالی از جایگزینی محتوای یک پیوست، اما بدون تغییر فراداده آن آورده شده است. ازآنجاییکه درخواست حاوی محتوای جدید است،
از پیوند edit-media ورودی پیوست استفاده میشود.
PUT /feeds/media/content/domainName/siteName/ATTACHMENT_ENTRY_ID Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Length: 70581 Content-Type: application/msword ... doc contents here ...
درحال بهروزرسانی فراداده پیوست + محتوا
در زیر نمونهای از بهروزرسانی همزمان فراداده پیوست و محتوای آن آورده شده است. نام پیوستها به «عنوان جدید» بهروزرسانی میشود و محتوای آن با محتوای فایل zip .جایگزین میشود. ازآنجاییکه درخواست حاوی محتوای فایل جدید است، از پیوند edit-media ورودی پیوست استفاده میشود.
توجه داشته باشید که گنجاندن ETag برای فراداده، If-Match ضمنی را برای محتوای رسانه نیز فراهم میکند، زیرا هرگونه بهروزرسانی در
محتوای رسانه باعث تغییر ETag فراداده میشود.
PUT /feeds/media/content/domainName/siteName/ATTACHMENT_ENTRY_ID Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> Content-Type: multipart/related; boundary="END_OF_PART" --END_OF_PART Content-Type: application/atom+xml <?xml version='1.0' encoding='UTF-8'?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:gd="http://schemas.google.com/g/2005" gd:etag="BxAaTxRZAyp7ImBq"> <link rel="http://schemas.google.com/sites/2008#parent" type="application/atom+xml" href="https://sites.google.com/feeds/content/domainName/siteName/ATTACHMENT_ENTRY_ID"/> <title>New Title</title> </entry> --END_OF_PART Content-Type: application/zip ... zip contents here ... --END_OF_PART
درحال حذف محتوا
برای برداشتن یک مورد از Google Site، ابتدا ورودی را بازیابی کنید، سپس یک درخواست DELETE
به نشانی وب edit ورودی ارسال کنید. این همان نشانی وبی است که هنگام بهروزرسانی فراداده یا محتوای html یک مورد استفاده میشود.
DELETE /feeds/content/domainName/siteName/ENTRY_ID Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> If-Match: <ETag or * here>
اگر ورودی باموفقیت حذف شده باشد، سرور با HTTP 200 OK پاسخ میدهد.
اگر میخواهید مطمئن شوید که ورودیای را که از زمان بازیابی توسط مشتری دیگری تغییر کرده است حذف نمیکنید،
سرصفحه HTTP If-Match را که حاوی مقدار ETag ورودی اصلی است اضافه کنید. میتوانید مقدار ETag ورودی اصلی را با بررسی مشخصه gd:etag عنصر <entry> تعیین کنید.
اگر میخواهید ورودی را بدون توجه به اینکه شخص دیگری آن را از زمان بازیابی شما بهروزرسانی کرده است یا نه حذف کنید، از
If-Match: * استفاده کنید و ETag را اضافه نکنید. (در این حالت، نیازی نیست ورودی را قبلاز حذف بازیابی کنید.)
برای اطلاعات بیشتر درباره ETags، به راهنمای مرجع Google Data APIs مراجعه کنید.
درحال بارگیری پیوستها
وقتی ورودی پیوست داشته باشید، میتوانید فایل را با ارسال HTTP GET اصالتسنجیشده به پیوند src <content> ورودی بارگیری کنید. نمونهای از پیوند محتوای PDF:
<content type="application/pdf" src="http://502377765-a-google-com-s-sites.googlegroups.com/feeds/media/content/domainName/siteName/678942036"/>
فید ACL
نمای کلی اجازههای همرسانی (ACL)
هر ورودی ACL در فید ACL نشاندهنده نقش دسترسی یک نهاد خاص است، خواه یک کاربر، گروهی از کاربران، یک دامنه، یا دسترسی پیشفرض (که یک سایت عمومی است). ورودیها فقط برای نهادهایی با دسترسی صریح نشان داده میشوند - یک ورودی برای هر نشانی ایمیل در پانل «افراد دارای دسترسی» در صفحه همرسانی واسط کاربر Google Sites نشان داده میشود. بنابراین، سرپرستان دامنه نشان داده نخواهند شد، هرچند که دسترسی ضمنی به سایت دارند.
نقشها
عنصر نقش نشاندهنده سطح دسترسیای است که یک نهاد میتواند داشته باشد. چهار مقدار ممکن برای عنصر gAcl:role وجود دارد:
- خواننده — بیننده (معادل دسترسی فقط خواندنی).
- نویسنده — همیار (معادل دسترسی خواندن/ نوشتن).
- مالک — معمولاً سرپرست سایت (معادل دسترسی خواندن/ نوشتن).
دوربین تفنگ
عنصر دامنه نشاندهنده نهادی است که این سطح دسترسی را دارد. پنج نوع ممکن برای عنصر gAcl:scope وجود دارد:
- user — مقدار نشانی ایمیل، مثلاً «user@gmail.com».
- group — نشانی ایمیل «گروه Google»، مثلاً «group@domain.com».
- domain — نام دامنه G Suite، مثلاً «domain.com».
- دعوتشده — کاربری که به سایت دعوت شده است، اما هنوز به ACL سایت اضافه نشده است. (اگر gdata نسخه ۱.۳ یا پایینتر مشخص شده باشد، دردسترس نیست.)
- پیشفرض — فقط یک دامنه ممکن از نوع «پیشفرض» وجود دارد که هیچ مقداری ندارد
(مثلاً
<gAcl:scope type="default">). این دامنه خاص دسترسیای را کنترل میکند که هر کاربر بهطور پیشفرض در سایت عمومی دارد.
توجه: دامنهها نمیتوانند مقدار gAcl:role
تنظیمشده روی دسترسی «مالک» داشته باشند، آنها فقط میتوانند خواننده یا نویسنده باشند.
درباره گستره «دعوت».
وقتی یک یا چند کاربر را که ازقبل حساب Google ندارند به ACL اضافه میکنید، API دامنه دعوت را برمیگرداند. میانای برنامهسازی کاربردی نشانی وبی را با یک کد جاسازیشده برمیگرداند که باید آن را به کاربران دعوتشدهتان ارائه دهید تا بتوانند دعوت را بپذیرند.
این روش دعوت به شما امکان میدهد کاربران غیرGoogle را بدون اطلاع قبلی از نشانی ایمیلی که میخواهند استفاده کنند دعوت کنید. تا زمانی که کاربران روی نشانی وب دعوت با کد جاسازیشده کلیک کنند، میتوانند بااستفاده از هر نشانی ایمیلی که میخواهند برای دسترسی ثبتنام کنند. علاوهبراین، چندین کاربر میتوانند از این نشانی وب برای پذیرفتن دعوت استفاده کنند، بنابراین این روش میتواند برای دعوت کردن یک کاربر یا گروهی از کاربران مفید باشد.
توجه: دامنه «دعوت» فقط در gdata نسخه ۱.۴ و بالاتر دردسترس است. اگر بهطور صریح نسخه ۱.۳ یا پایینتر را مشخص کنید، این کار انجام نخواهد شد.
درحال بازیابی فید ACL
از فید ACL میتوان برای کنترل اجازههای همرسانی سایت استفاده کرد و ازطریق URI زیر قابلدسترسی است:
https://sites.google.com/feeds/acl/site/domainName/siteName
| پارامتر فید | شرح |
|---|---|
domainName | «site» یا دامنه میزبانیشده G Suite شما (مثلاً example.com). |
siteName | نام فضای وب سایت شما؛ در نشانی وب سایت یافت میشود (مثلاً myCoolSite). |
شایان ذکر است که هر ورودی در فید سایت حاوی پیوندی به این فید است:
<link rel="http://schemas.google.com/acl/2007#accessControlList" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName"/>
برای بازیابی اجازههای همرسانی سایت، یک GET HTTP به URI فید ACL ارسال کنید:
GET /feeds/acl/site/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here>
سرور با 200 OK و فیدی از ورودیهای ACL پاسخ خواهد داد:
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/"
xmlns:gAcl="http://schemas.google.com/acl/2007" xmlns:sites="http://schemas.google.com/sites/2008"
xmlns:gs="http://schemas.google.com/spreadsheets/2006" xmlns:dc="http://purl.org/dc/terms"
xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gd="http://schemas.google.com/g/2005"
xmlns:thr="http://purl.org/syndication/thread/1.0">
<id>https://sites.google.com/feeds/acl/site/domainName/siteName</id>
<updated>2009-12-03T22:01:05.963Z</updated>
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/acl/2007#accessRule"/>
<title>Acl</title>
<link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName"/>
<link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName"/>
<link rel="self" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName"/>
<generator version="1" uri="http://sites.google.com">Google Sites</generator>
<openSearch:startIndex>1</openSearch:startIndex>
<entry>
<id>https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserA%40gmail.com</id>
<updated>2009-12-03T22:01:05.963Z</updated>
<app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-03T22:01:05.963Z</app:edited>
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/acl/2007#accessRule"/>
<link rel="self" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserA%40google.com"/>
<link rel="edit" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserA%40google.com"/>
<gAcl:scope type="user" value="userA@google.com"/>
<gAcl:role value="owner"/>
</entry>
<entry>
<id>https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserB%40gmail.com</id>
<updated>2009-12-03T22:01:05.963Z</updated>
<app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-03T22:01:05.963Z</app:edited>
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/acl/2007#accessRule"/>
<link rel="self" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserB%40gmail.com"/>
<link rel="edit" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserB%40gmail.com"/>
<gAcl:scope type="user" value="userB@gmail.com"/>
<gAcl:role value="writer"/>
</entry>
<entry>
<id>https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserC%40gmail.com</id>
<updated>2009-12-03T22:01:05.963Z</updated>
<app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-03T22:01:05.963Z</app:edited>
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/acl/2007#accessRule"/>
<link rel="self" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserC%40gmail.com"/>
<link rel="edit" type="application/atom+xml"
href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3AuserC%40gmail.com"/>
<gAcl:scope type="user" value="userC@gmail.com"/>
<gAcl:role value="reader"/>
</entry>
...
</feed>
همرسانی کردن سایت
فید ACL درخواستهای GET، POST، و PUT را میپذیرد. برای درج نقش جدید در جارزن ACL، کافی است درخواست POST را به جارزن ACL سایت ارسال کنید.
توجه: برخیاز ACLهای همرسانی ممکن است فقط درصورتی امکانپذیر باشند که دامنه برای مجاز کردن چنین اجازههایی پیکربندی شده باشد (مثلاً اگر همرسانی خارج از دامنه برای دامنههای G Suite فعال باشد، و غیره).
این مثال مشارکتکننده (نویسنده) جدیدی به سایت اضافه میکند:
POST /feeds/acl/site/domainName/siteName HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:gAcl='http://schemas.google.com/acl/2007'> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/acl/2007#accessRule'/> <gAcl:role value='writer'/> <gAcl:scope type='user' value='new_writer@example.com'/> </entry>
درصورت درج موفقیتآمیز، 201 Created و ورودی جدید برگردانده میشود:
<entry> <id>https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_writer%40example.com</id> <updated>2009-12-03T22:01:05.963Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-03T22:01:05.963Z</app:edited> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/acl/2007#accessRule"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_writer%40example.com"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_writer%40example.com"/> <gAcl:role value='writer'/> <gAcl:scope type='user' value='new_writer@example.com'/> </entry>
دعوت کردن از کاربران ازطریق گستره «دعوت»
اگر کاربرانی را اضافه کنید که حساب Google ندارند، میانای برنامهسازی کاربردی نشانی وبی را برمیگرداند که باید آن را به کاربرانی که میخواهید دعوت کنید ارائه دهید. پساز کلیک کردن روی نشانی وب، آنها میتوانند با ورود به سیستم با حساب موجود یا ایجاد حساب جدید، به سایت دسترسی پیدا کنند.
دعوت موفقیتآمیز 201 Created و ورودی جدیدی را برمیگرداند که شامل نشانی وبی است که باید به کاربر بدهید:
<entry> <id>https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_invite%40example.com</id> <updated>2009-12-03T22:01:05.963Z</updated> <app:edited xmlns:app="http://www.w3.org/2007/app">2009-12-03T22:01:05.963Z</app:edited> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/acl/2007#accessRule"/> <link rel="http://schemas.google.com/sites/2008#invite" type="text/html"href="domainName/siteName?invite=inviteToken"/> <link rel="self" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_invite%40example.com"/> <link rel="edit" type="application/atom+xml" href="https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_invite%40example.com"/> <gAcl:role value='writer'/> <gAcl:scope type='invite' value='new_invite%40example.com'/> </entry>
همرسانی در سطح گروه و دامنه
مشابه همرسانی سایت با یک کاربر، میتوانید سایتی را در سراسر
گروه Google یا دامنه G Suite همرسانی کنید. مقادیر scope لازم در زیر فهرست شده است.
همرسانی با نشانی ایمیل گروه:
<gAcl:scope type="group" value="group@example.com"/>
همرسانی با کل دامنه:
<gAcl:scope type="domain" value="example.com"/>
همرسانی در سطح دامنه فقط برای دامنههای G Suite پشتیبانی میشود و فقط برای دامنهای که سایت در آن میزبانی میشود. برای مثال، http://sites.google.com/a/domain1.com/siteA فقط میتواند کل «سایت» را با domain1.com همرسانی کند، نه domain2.com. سایتهایی که در دامنه G Suite میزبانی نمیشوند (مثلاً http://sites.google.com/site/siteB) نمیتوانند دامنهها را دعوت کنند.
درحال اصلاح اجازههای همرسانی
برای بهروزرسانی ورودی ACL، ورودی را درصورت لزوم اصلاح کنید و درخواست HTTP PUT را به
پیوند edit ورودی صادر کنید که بهسادگی
عنصر <link> است که مشخصه «rel» آن روی «edit» تنظیم شده است. برای مثال قبلی، آن پیوند عبارت است از:
<link rel='edit' type='application/atom+xml'
href='https://sites.google.com/feeds/acl/site/domainName/siteName/user%3Anew_writer%40example.com'/>قطعه کد زیر نقش new_writer@gmail.com را به «خواننده» تغییر میدهد:
PUT /feeds/acl/site/domainName/siteName/user%3Anew_writer%40example.com HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:gAcl='http://schemas.google.com/acl/2007'> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/acl/2007#accessRule'/> <gAcl:role value='reader'/> <gAcl:scope type='user' value='new_writer@gmail.com'/> </entry>
درحال برداشتن اجازههای همرسانی
برای برداشتن اجازههای این کاربر، درخواست DELETE را برای همان پیوند edit که برای درخواست PUT استفاده شده بود صادر کنید:
DELETE /feeds/acl/site/domainName/siteName/user%3Anew_writer%40example.com HTTP/1.1 Host: sites.google.com GData-Version: 1.4 Authorization: <your authorization header here>
سرور با 200 OK پاسخ خواهد داد.
موضوعات ویژه
بازیابی مجدد فید یا ورودی
اگر میخواهید فید یا ورودیای را که قبلاً بازیابی کردهاید بازیابی کنید، میتوانید کارایی را بهبود بخشید با گفتن به سرور برای ارسال فهرست یا ورودی فقط درصورتیکه از آخرین باری که آن را بازیابی کردهاید تغییر کرده باشد.
برای انجام این نوع بازیابی شرطی، درخواست HTTP GET ارسال کنید که شامل سرایند HTTP
If-None-Match باشد. در سرصفحه، ETag فهرست یا ورودی را مشخص کنید که میتوانید آن را در
مشخصه gd:etag عنصر <feed> یا عنصر <entry> پیدا کنید.
نمونهای از استفاده از فید سایت:
GET /feeds/site/domainName/myOtherTestSite/ GData-Version: 1.4 If-None-Match: W/"Ck8GQXk7fil7ImA9WxNSFk0."
وقتی سرور این درخواست را دریافت میکند، بررسی میکند تا ببیند آیا موردی که درخواست کردهاید همان ETag را دارد که
ETag مشخص کردهاید. اگر ETagها مطابقت داشته باشند، مورد تغییر نکرده است و سرور رمز وضعیت HTTP 304 Not Modified یا رمز وضعیت HTTP 412 Precodition Failed را برمیگرداند. هر دوی این
کدهای وضعیت نشان میدهند موردی که قبلاً بازیابی کردهاید بهروز است.
اگر ETagها مطابقت نداشته باشند، یعنی مورد از آخرین باری که آن را درخواست کردهاید اصلاح شده است و سرور مورد را برمیگرداند.
برای اطلاعات بیشتر درباره ETags، به راهنمای مرجع Google Data APIs مراجعه کنید.
پردازش دستهای
درخواستهای دستهای به کارخواه شما امکان میدهد چندین عملیات را در یک درخواست اجرا کند، بهجای اینکه هر عملیات را بهصورت جداگانه ارسال کند.
سرور تا حد امکان تغییرات درخواستی را انجام میدهد و اطلاعات وضعیتی را برمیگرداند که میتوانید از آن برای ارزیابی موفقیت یا شکست هر عملیات استفاده کنید. برای جزئیات بیشتر درباره پردازش دستهای در Google Data API، به پردازش دستهای با Google Data APIs مراجعه کنید
هر عملیات در فید دستهای دارای یک عنصر <id> است، بهجز عملیات درج.
این عنصر همان نشانی وب درخواستی است که معمولاً هنگام بهروزرسانی، حذف، یا پُرسمان فید محتوا استفاده میکنید.
برای مثال، اگر درحال بهروزرسانی ویرایشی هستید، <id> را روی پیوند edit برای ورودی موردنظر تنظیم کنید.
از این شناسه برای شناسایی ورودی هدف استفاده میشود. ورودیهای جدید عنصر <id> ندارند چون هنوز ایجاد نشدهاند. درعوض میتوانید مقدار رشتهای را در <batch:id> تعریف کنید که در پاسخ سرور برگردانده میشود و برای جستجوی ورودی مربوطه استفاده میشود.
برای ایجاد درخواست دستهای، یک فید دستهای بسازید و یک HTTP POST به پیوند دستهای فید ارسال کنید:
<link rel="http://schemas.google.com/g/2005#batch" type="application/atom+xml"
href="https://sites.google.com/feeds/content/site/siteName/batch"/>
مثال زیر نشان میدهد که چگونه میتوان ورودی صفحه وب را جستجو، درج، بهروزرسانی، و حذف کرد:
POST /feeds/content/site/siteName/batch HTTP/1.1 Host: sites.google.com Accept: */* If-Match: * GData-Version: 1.4 Authorization: <your authorization header here> <feed xmlns="http://www.w3.org/2005/Atom" xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gd="http://schemas.google.com/g/2005" xmlns:batch='http://schemas.google.com/gdata/batch'> <entry> <id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID1</id> <batch:operation type="query"/> </entry> <entry> <batch:id>1</batch:id> <batch:operation type='insert'/> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <title>New Webpage1</title> <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml">HTML body goes here</div> </content> </entry> <entry gd:etag=""YDgpeyI.""> <id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID2</id> <batch:operation type='update'/> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/> <title>Updated Title for Webpage2</title> ... <batch:operaation type="update"/> </entry> <entry gd:etag=""YassseyI.""> <id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID3</id> <batch:operation type='delete'/> </entry> </feed>
فید برگرداندهشده شامل یک ورودی نتیجه برای هر عملیات خواهد بود:
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/"
xmlns:sites="http://schemas.google.com/sites/2008" xmlns:gs="http://schemas.google.com/spreadsheets/2006"
xmlns:dc="http://purl.org/dc/terms" xmlns:batch="http://schemas.google.com/gdata/batch"
xmlns:gd="http://schemas.google.com/g/2005" xmlns:thr="http://purl.org/syndication/thread/1.0">
<id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID1</id>
<updated>2009-11-10T22:44:08.369Z</updated>
<title>Batch Feed</title>
<entry gd:etag=""YDgpsdfeyI."">
<id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID1</id>
<published>2009-08-31T04:42:45.251Z</published>
<updated>2009-10-25T22:46:13.729Z</updated>
<app:edited xmlns:app="http://www.w3.org/2007/app">2009-10-25T22:46:13.671Z</app:edited>
<category scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/sites/2008#webpage" label="webpage"/>
<title>Page Title</title>
...
<batch:status code="200" reason="Success"/>
<batch:operation type="query"/>
</entry>
<entry gd:etag=""YDsseyI."">
<id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID4</id>
<published>2009-11-10T22:44:08.531Z</published>
<updated>2009-11-10T22:44:08.560Z</updated>
<app:edited xmlns:app="http://www.w3.org/2007/app">2009-11-10T22:44:08.531Z</app:edited>
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/sites/2008#webpage" label="webpage"/>
<title>New Webpage1</title>
<content type="xhtml">
<div xmlns="http://www.w3.org/1999/xhtml">
<table cellspacing="0" class="sites-layout-name-one-column sites-layout-hbox">
<tbody>
<tr>
<td class="sites-layout-tile sites-tile-name-content-1">
<div>HTML body goes here</div>
</td>
</tr>
</tbody>
</table>
</div>
</content>
...
<batch:id>1</batch:id>
<batch:status code="201" reason="Created"/>
<batch:operation type="insert"/>
</entry>
<entry gd:etag=""YDkpeyI."">
<id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID2</id>
<updated>2009-11-10T22:44:09.296Z</updated>
<title>Updated Title for Webpage2</title>
...
<sites:pageName>updated-title-for-webpage2</sites:pageName>
<sites:revision>5</sites:revision>
<batch:status code="200" reason="Success"/>
<batch:operation type="update"/>
</entry>
<entry>
<id>https://sites.google.com/feeds/content/site/siteName/ENTRY_ID3</id>
<title>Deleted</title>
<content>Deleted</content>
<batch:status code="200" reason="Success"/>
<batch:operation type="delete"/>
</entry>
</feed>