Blogger API: שימוש ב-API

באמצעות ה-API של Blogger אפשר לשלב תוכן מ-Blogger באפליקציה באמצעות ממשקי API ל-REST. לפני שמתחילים, צריך להגדיר הרשאה.

מבוא

המסמך הזה מיועד למפתחים שרוצים לכתוב אפליקציות שיכולות ליצור אינטראקציה עם ה-API של Blogger. Blogger הוא כלי ליצירת אתרים שמאפשרים לאנשים לפרסם את המחשבות שלהם על בסיס מתמשך.

אם אתם לא מכירים את המושגים של Blogger, מומלץ לקרוא את המאמר תחילת העבודה לפני שמתחילים לתכנת.

הרשאת בקשות וזיהוי האפליקציה

כל בקשה שהאפליקציה שלך שולחת לממשקי ה-API של Blogger צריכה לזהות את האפליקציה ל-Google. יש שתי דרכים לזהות את האפליקציה שלכם: באמצעות אסימון OAuth 2.0 (שגם מאשר את הבקשה) ו/או שימוש במפתח ה-API של האפליקציה. כך קובעים באילו מהאפשרויות האלה להשתמש:

  • אם הבקשה מחייבת הרשאה (למשל, בקשה לקבלת מידע פרטי של אדם פרטי), היא חייבת לכלול בבקשה אסימון OAuth 2.0. האפליקציה יכולה גם לספק את מפתח ה-API, אבל היא לא חייבת.
  • אם הבקשה לא דורשת הרשאה (למשל, בקשה לנתונים ציבוריים), האפליקציה צריכה לספק את מפתח ה-API או אסימון OAuth 2.0, או את שניהם – בהתאם לאפשרות שהכי מתאימה לכם.

הסבר על פרוטוקולים של הרשאות

כדי לאשר בקשות, האפליקציה חייבת להשתמש בפרוטוקול OAuth 2.0. אין תמיכה בפרוטוקולים אחרים של הרשאות. אם באפליקציה נעשה שימוש בכניסה באמצעות חשבון Google, היבטים מסוימים של ההרשאות מטפלים בשבילכם.

הרשאת בקשות עם פרוטוקול OAuth 2.0

בקשות שנשלחות לממשקי ה-API של Blogger עבור נתוני משתמשים לא ציבוריים חייבות לקבל הרשאה על ידי משתמש מאומת.

התהליך הזה מתבצע באמצעות מזהה לקוח OAuth.

קבלת מזהה לקוח ב-OAuth

אפשר גם ליצור כרטיס בדף פרטי כניסה.

הפרטים או ה"זרימה" של תהליך ההרשאה עם OAuth 2.0 עשויים להשתנות מעט, בהתאם לסוג האפליקציה שאתם מפתחים. התהליך הכללי הבא חל על כל סוגי האפליקציות:

  1. כשהאפליקציה צריכה גישה לנתונים של משתמשים, היא מעבירה ל-Google בקשת גישה בהיקף ספציפי.
  2. Google מציגה למשתמש מסך הסכמה ומבקשת לאשר לאפליקציה לשלוח בקשה לחלק מהנתונים שלו.
  3. אם המשתמש מסכים, האפליקציה מקבלת מ-Google אסימון גישה לטווח קצר.
  4. האפליקציה מבקשת את נתוני המשתמש ומצרפת לבקשה את אסימון הגישה.
  5. אם Google תקבע שהבקשה והאסימון תקפים, היא תחזיר את הנתונים המבוקשים.

חלק מתהליכי העבודה כוללים שלבים נוספים, כמו שימוש באסימוני רענון כדי לקבל אסימוני גישה חדשים. למידע מפורט על תהליכי העבודה לסוגים שונים של אפליקציות, ניתן לעיין בתיעוד של OAuth 2.0 של Google.

אלו הם הפרטים של היקף OAuth 2.0 עבור ממשקי ה-API של Blogger:

https://www.googleapis.com/auth/blogger

כדי לבקש גישה באמצעות פרוטוקול OAuth 2.0, האפליקציה שלכם זקוקה למידע על ההיקף ולמידע ש-Google מספקת בזמן רישום האפליקציה (כמו מזהה לקוח וסוד לקוח).

טיפ: ספריות הלקוח של Google APIs יכולות לטפל בחלק מתהליך ההרשאה עבורכם. הם זמינים במגוון שפות תכנות. לפרטים נוספים, יש לעיין בדף עם ספריות ודוגמאות.

קבלת מפתח API ושימוש בו

בקשות שנשלחות לממשקי ה-API של Blogger לנתונים ציבוריים חייבות לכלול מזהה, שיכול להיות מפתח API או אסימון גישה.

לקבלת מפתח

אפשר גם ליצור כרטיס בדף פרטי כניסה.

אחרי שיש לכם מפתח API, האפליקציה יכולה לצרף את פרמטר השאילתה key=yourAPIKey לכל כתובות ה-URL של הבקשות.

מפתח ה-API בטוח להטמעה בכתובות URL, אין צורך בקידוד שלו.

עבודה עם בלוגים

אחזור של בלוג

אפשר לאחזר מידע על בלוג מסוים על ידי שליחת בקשת GET HTTP ל-URI של הבלוג. ה-URI של בלוג מופיע בפורמט הבא:

https://www.googleapis.com/blogger/v3/blogs/blogId

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/2399953?key=YOUR-API-KEY

לא צריך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה מצליחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ונתוני הבלוג:

{
  "kind": "blogger#blog",
  "id": "2399953",
  "name": "Blogger Buzz",
  "description": "The Official Buzz from Blogger at Google",
  "published": "2007-04-23T22:17:29.261Z",
  "updated": "2011-08-02T06:01:15.941Z",
  "url": "http://buzz.blogger.com/",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953",
  "posts": {
    "totalItems": 494,
    "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts"
  },
  "pages": {
    "totalItems": 2,
    "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/pages"
  },
  "locale": {
    "language": "en",
    "country": "",
    "variant": ""
  }
}

אחזור בלוג לפי כתובת ה-URL שלו

אפשר לאחזר בלוג באמצעות כתובת ה-URL שלו, על ידי שליחת בקשת GET HTTP ל-URI הבא עם פרמטר url:

https://www.googleapis.com/blogger/v3/blogs/byurl?url=blog-url

בקשה

https://www.googleapis.com/blogger/v3/blogs/byurl?url=http://code.blogger.com/

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ועם הייצוג המלא של הבלוג שזוהה:

{
 "kind": "blogger#blog",
 "id": "3213900",
 "name": "Blogger Developers Network",
 "description": "The official Blogger Developers Network weblog.",
 "published": "2007-02-09T10:13:10-08:00",
 "updated": "2012-04-15T19:38:01-07:00",
 "url": "http://code.blogger.com/",
 "selfLink": "https://www.googleapis.com/blogger/v3/blogs/3213900",
 "posts": {
  "totalItems": 55,
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/3213900/posts"
 },
 "pages": {
  "totalItems": 1,
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/3213900/pages"
 },
 "locale": {
  "language": "en",
  "country": "US",
  "variant": ""
 }
}

אחזור בלוגים של משתמש

אפשר לאחזר רשימה של בלוגים של משתמש על ידי שליחת בקשת GET מסוג HTTP ל-URI של אוסף הבלוגים:

https://www.googleapis.com/blogger/v3/users/userId/blogs

בקשה

GET https://www.googleapis.com/blogger/v3/users/self/blogs
Authorization: /* OAuth 2.0 token here */

הערה: המשתמש צריך להיות מאומת כדי לרשום את הבלוגים שלו, לכן צריך לספק את כותרת ה-HTTP Authorization עם בקשת ה-GET.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ועם הייצוג המלא של רשימת הבלוגים של המשתמש:

{
  "kind": "blogger#blogList",
  "items": [
    {
      "kind": "blogger#blog",
      "id": "4967929378133675647",
      "name": "Brett's Test Blawg",
      "description": "",
      "published": "2010-10-06T23:33:31.662Z",
      "updated": "2011-08-08T06:50:02.005Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/",
      "selfLink": "https://www.googleapis.com/blogger/v3/blogs/4967929378133675647",
      "posts": {
        "totalItems": 13,
        "selfLink": "https://www.googleapis.com/blogger/v3/blogs/4967929378133675647/posts"
      },
      "pages": {
        "totalItems": 1,
        "selfLink": "https://www.googleapis.com/blogger/v3/blogs/4967929378133675647/pages"
      },
      "locale": {
        "language": "en",
        "country": "",
        "variant": ""
      }
    }
  ]
}

עבודה עם פוסטים

אחזור פוסטים מבלוג

אפשר לאחזר רשימת פוסטים מבלוג נתון על ידי שליחת בקשת GET ל-URI של אוסף הפוסטים. ה-URI לאוסף פוסטים הוא בפורמט הבא:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts

בקשה

לדוגמה:

GET https://www.googleapis.com/blogger/v3/blogs/2399953/posts?key=YOUR-API-KEY

לא צריך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה מצליחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ורשימת הפוסטים:

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ",
  "items": [
    {
      "kind": "blogger#post",
      "id": "7706273476706534553",
      "blog": {
        "id": "2399953"
      },
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.947Z",
      "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
      "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553",
      "title": "Latest updates, August 1st",
      "content": "elided for readability",
      "author": {
        "id": "401465483996",
        "displayName": "Brett Wiltshire",
        "url": "http://www.blogger.com/profile/01430672582309320414",
        "image": {
          "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
         }
      },
      "replies": {
        "totalItems": "0",
        "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553/comments"
      }
    },
    {
      "kind": "blogger#post",
      "id": "6069922188027612413",
      elided for readability
    }
  ]
}

אחזור פוסט ספציפי

כדי לאחזר פוסט ספציפי מבלוג, אפשר לשלוח בקשת GET ל-URI של משאב הפוסטים. הפורמט של ה-URI למשאב של פוסטים הוא:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553?key=YOUR-API-KEY

לא צריך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ואת תוכן הפוסט:

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553/comments"
  }
}

חיפוש פוסט

כדי לחפש פוסטים מבלוג, אפשר לשלוח בקשת GET ל-URI של חיפוש הפוסט עם הפרמטר q של שאילתת החיפוש:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search?q=query terms

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/3213900/posts/search?q=documentation&key=YOUR-API-KEY

לא צריך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ואת תוכן הפוסט:

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAj86CpB8QzJTEAQ",
  "items": [
  {
    "kind": "blogger#post",
    "id": "1387873546480002228",
    "blog": {
      "id": "3213900"
    },
    "published": "2012-03-23T01:58:00-07:00",
    "updated": "2012-03-23T01:58:12-07:00",
    "url": "http://code.blogger.com/2012/03/blogger-documentation-has-moved-to.html",
    "selfLink": "https://www.googleapis.com/blogger/v3/blogs/3213900/posts/1387873546480002228",
    "title": "Blogger Documentation has moved to developers.google.com",
    "content": "content elided for readability",
    "author": {
      "id": "16258312240222542576",
      "displayName": "Brett Morgan",
      "url": "http://www.blogger.com/profile/16258312240222542576",
      "image": {
        "url": "https://resources.blogblog.com/img/b16-rounded.gif"
      }
    },
    "replies": {
      "totalItems": "0",
      "selfLink": "https://www.googleapis.com/blogger/v3/blogs/3213900/posts/1387873546480002228/comments"
    }
  },
  ...
  ]
}

הוספת פוסט

כדי להוסיף פוסט לבלוג, אפשר לשלוח בקשת POST ל-URI של אוסף הפוסטים עם גוף הפוסט JSON:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/

בקשה

POST https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/
Authorization: /* OAuth 2.0 token here */
Content-Type: application/json

{
  "kind": "blogger#post",
  "blog": {
    "id": "8070105920543249955"
  },
  "title": "A new post",
  "content": "With <b>exciting</b> content..."
}

חובה לעבור אימות כדי ליצור פוסט.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ואת תוכן הפוסט:

{
 "kind": "blogger#post",
 "id": "6819100329896798058",
 "blog": {
  "id": "8070105920543249955"
 },
 "published": "2012-05-20T20:08:00-07:00",
 "updated": "2012-05-20T20:08:35-07:00",
 "url": "http://brettmorgan-test2.blogspot.com/2012/05/new-post.html",
 "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058",
 "title": "A new post",
 "content": "With <b>exciting</b> content...",
 "author": {
  "id": "16258312240222542576",
  "displayName": "Brett Morgan",
  "url": "http://www.blogger.com/profile/16258312240222542576",
  "image": {
   "url": "https://resources.blogblog.com/img/b16-rounded.gif"
  }
 },
 "replies": {
  "totalItems": "0",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058/comments"
 }
}

מחיקת פוסט

אפשר למחוק פוסט בבלוג על ידי שליחת בקשת DELETE ל-URI של משאב הפוסט:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId

בקשה

לדוגמה:

DELETE https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058
Authorization: /* OAuth 2.0 token here */

חובה לבצע אימות כדי למחוק פוסט.

תשובה

אם הבקשה מצליחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP.

אחזור פוסט לפי הנתיב שלו

אפשר לאחזר פוסט מבלוג על ידי שליחת בקשת GET ל-URI של הנתיב של הפוסטים עם הפרמטר path. ה-URI של פוסטים לפי בקשת נתיב מופיע בפורמט הבא:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath?path=post-path

בקשה

https://www.googleapis.com/blogger/v3/blogs/2399953/posts/bypath?path=/2011/08/latest-updates-august-1st.html&key=YOUR-API-KEY

לא צריך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ואת תוכן הפוסט:

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/7706273476706534553/comments"
  }
}

עדכון פוסט

אפשר לעדכן פוסט בבלוג על ידי שליחת בקשת PUT ל-URI של משאב הפוסט עם גוף JSON של פוסט:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId

בקשה

PUT https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/3445355871727114160
Authorization: /* OAuth 2.0 token here */
Content-Type: application/json

{
 "kind": "blogger#post",
 "id": "3445355871727114160",
 "blog": {
  "id": "8070105920543249955"
 },
 "url": "http://brettmorgan-test2.blogspot.com/2012/05/new-post_20.html",
 "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/3445355871727114160",
 "title": "An updated post",
 "content": "With really <b>exciting</b> content..."
}

כדי לעדכן פוסט צריך לאמת אותו.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ואת תוכן הפוסט:

{
 "kind": "blogger#post",
 "id": "6819100329896798058",
 "blog": {
  "id": "8070105920543249955"
 },
 "published": "2012-05-20T20:08:00-07:00",
 "updated": "2012-05-20T20:08:35-07:00",
 "url": "http://brettmorgan-test2.blogspot.com/2012/05/new-post.html",
 "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058",
 "title": "An updated post",
 "content": "With really <b>exciting</b> content...",
 "author": {
  "id": "16258312240222542576",
  "displayName": "Brett Morgan",
  "url": "http://www.blogger.com/profile/16258312240222542576",
  "image": {
   "url": "https://resources.blogblog.com/img/b16-rounded.gif"
  }
 },
 "replies": {
  "totalItems": "0",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058/comments"
 }
}

עדכון פוסט בסמנטיקה של תיקונים

אפשר לעדכן פוסט עם סמנטיקה של תיקונים על ידי שליחת בקשת PATCH ל-URI של המשאב של הפוסט עם גוף פוסט JSON:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId

בקשה

לדוגמה:

PATCH https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/3445355871727114160
Authorization: /* OAuth 2.0 token here */
Content-Type: application/json

{
 "content": "With absolutely <b>fabulous</b> content..."
}

כדי לעדכן פוסט צריך לאמת אותו.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ואת תוכן הפוסט:

{
 "kind": "blogger#post",
 "id": "6819100329896798058",
 "blog": {
  "id": "8070105920543249955"
 },
 "published": "2012-05-20T20:08:00-07:00",
 "updated": "2012-05-20T20:08:35-07:00",
 "url": "http://brettmorgan-test2.blogspot.com/2012/05/new-post.html",
 "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058",
 "title": "An updated post",
 "content": "With absolutely <b>fabulous</b> content...",
 "author": {
  "id": "16258312240222542576",
  "displayName": "Brett Morgan",
  "url": "http://www.blogger.com/profile/16258312240222542576",
  "image": {
   "url": "https://resources.blogblog.com/img/b16-rounded.gif"
  }
 },
 "replies": {
  "totalItems": "0",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/8070105920543249955/posts/6819100329896798058/comments"
 }
}

איך לעבוד עם תגובות

אחזור תגובות לפוסט

כדי לאחזר רשימת תגובות לפוסט אפשר לשלוח בקשת GET ל-URI של אוסף התגובות. הפורמט של ה-URI לאוסף תגובות הוא:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/2399953/posts/6069922188027612413/comments?key=YOUR-API-KEY

"אין צורך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה מצליחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ורשימת התגובות:

{
  "kind": "blogger#commentList",
  "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ",
  "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ",
  "items": [
    {
       "kind": "blogger#comment",
       "id": "9200761938824362519",
       "post": {
         "id": "6069922188027612413"
       },
       "blog": {
         "id": "2399953"
       },
       "published": "2011-07-28T19:19:57.740Z",
       "updated": "2011-07-28T21:29:42.015Z",
       "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
       "content": "elided",
       "author": {
         "id": "530579030283",
         "displayName": "elided",
         "url": "elided",
         "image": {
           "url": "elided"
         }
       }
    },
    {
      "kind": "blogger#comment",
      "id": "400101178920857170",
      elided for readability
    }
  ]
}

אחזור תגובה ספציפית

כדי לאחזר תגובה ספציפית מפוסט, שולחים בקשת GET ל-URI של משאב התגובות. הפורמט של ה-URI למשאב של תגובות הוא:

https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519?key=YOUR-API-KEY

"אין צורך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה מצליחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ונתוני התגובה:

{
  "kind": "blogger#comment",
  "id": "9200761938824362519",
  "post": {
    "id": "6069922188027612413"
  },
  "blog": {
    "id": "2399953"
  },
  "published": "2011-07-28T19:19:57.740Z",
  "updated": "2011-07-28T21:29:42.015Z",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
  "content": "elided",
  "author": {
    "id": "530579030283",
    "displayName": "elided",
    "url": "elided",
    "image": {
      "url": "elided"
    }
  }
}

עבודה עם דפים

אחזור דפים מבלוג

אפשר לאחזר רשימת דפים בבלוג על ידי שליחת בקשת GET ל-URI של אוסף הדפים. הפורמט של ה-URI לאוסף דפים הוא:

https://www.googleapis.com/blogger/v3/blogs/blogId/pages

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/4967929378133675647/pages?key=YOUR-API-KEY

"אין צורך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה תתבצע בהצלחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ועם רשימת הדפים:

{
  "kind": "blogger#pageList",
  "items": [
    {
      "kind": "blogger#page",
      "id": "273541696466681878",
      "blog": {
        "id": "4967929378133675647"
      },
      "published": "2011-07-14T16:16:00.000Z",
      "updated": "2011-07-14T16:16:23.602Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
      "selfLink": "https://www.googleapis.com/blogger/v3/blogs/4967929378133675647/pages/273541696466681878",
      "title": "Static Content",
      "content": "elided for readability",
      "author": {
        "id": "901569848744",
        "displayName": "brett",
        "url": "http://www.blogger.com/profile/16258312240222542576",
        "image": {
          "url": "https://resources.blogblog.com/img/b16-rounded.gif"
        }
      }
    }
  ]
}

אחזור דף ספציפי

אפשר לאחזר דף ספציפי מבלוג על ידי שליחת בקשת GET ל-URI של משאב הדפים. ה-URI למשאב של דפים הוא בפורמט הבא:

https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId

בקשה

GET https://www.googleapis.com/blogger/v3/blogs/4967929378133675647/pages/273541696466681878?key=YOUR-API-KEY

"אין צורך לאמת את המשתמש כדי לאחזר בלוג ציבורי. האפליקציה לא צריכה לכלול כותרת HTTP Authorization בקשר לבקשת בלוג ציבורי. עם זאת, צריך לספק את מפתח ה-API.

ב-Blogger יש גם בלוגים פרטיים, המחייבים אימות.

תשובה

אם הבקשה מצליחה, השרת ישיב עם קוד הסטטוס 200 OK HTTP ונתוני הדף:

{
  "kind": "blogger#page",
  "id": "273541696466681878",
  "blog": {
    "id": "4967929378133675647"
  },
  "published": "2011-07-14T16:16:00.000Z",
  "updated": "2011-07-14T16:16:23.602Z",
  "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
  "selfLink": "https://www.googleapis.com/blogger/v3/blogs/4967929378133675647/pages/273541696466681878",
  "title": "Static Content",
  "content": "elided for readability",
  "author": {
    "id": "901569848744",
    "displayName": "brett",
    "url": "http://www.blogger.com/profile/16258312240222542576",
    "image": {
      "url": "https://resources.blogblog.com/img/b16-rounded.gif"
    }
  }
}

עבודה עם משתמשים

אחזור משתמש

אפשר לאחזר את פרטי המשתמש על ידי שליחת בקשת GET מסוג HTTP ל-URI של משאב המשתמש:

https://www.googleapis.com/blogger/v3/users/userId

בקשה

GET https://www.googleapis.com/blogger/v3/users/self
Authorization: /* OAuth 2.0 token here */

הערה: המשתמש צריך להיות מאומת כדי לרשום את הפרטים שלו, ולכן אתם צריכים להוסיף את כותרת ה-HTTP Authorization עם בקשת ה-GET.

תשובה

אם הבקשה מצליחה, השרת משיב עם קוד הסטטוס 200 OK HTTP וקישור לרשימה של הבלוגים של המשתמש:

{
  "kind": "blogger#user",
  "id": "901569848744",
  "selfLink": "https://www.googleapis.com/blogger/v3/users/901569848744",
  "blogs": {
    "selfLink": "https://www.googleapis.com/blogger/v3/users/901569848744/blogs"
  }
}

פרמטרים רגילים של שאילתה

תוכלו להשתמש בפרמטרים הבאים של שאילתות בכל השיטות ובכל המשאבים בממשקי ה-API של Blogger.

הפרמטרים של שאילתות שחלים על כל הפעולות של ממשקי ה-API של Blogger מתועדים בקטע פרמטרים של המערכת.