Blogger API . blogs

Instance Methods

close()

Close httplib2 connections.

get(blogId, maxPosts=None, view=None, x__xgafv=None)

Gets a blog by id.

getByUrl(url, view=None, x__xgafv=None)

Gets a blog by url.

listByUser(userId, fetchUserInfo=None, role=None, status=None, view=None, x__xgafv=None)

Lists blogs by user.

Method Details

close()
Close httplib2 connections.
get(blogId, maxPosts=None, view=None, x__xgafv=None)
Gets a blog by id.

Args:
  blogId: string, A parameter (required)
  maxPosts: integer, A parameter
  view: string, A parameter
    Allowed values
      VIEW_TYPE_UNSPECIFIED - 
      READER - 
      AUTHOR - 
      ADMIN - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "customMetaData": "A String", # The JSON custom meta-data for the Blog.
  "description": "A String", # The description of this blog. This is displayed underneath the title.
  "id": "A String", # The identifier for this resource.
  "kind": "A String", # The kind of this entry. Always blogger#blog.
  "locale": { # The locale this Blog is set to.
    "country": "A String", # The country this blog's locale is set to.
    "language": "A String", # The language this blog is authored in.
    "variant": "A String", # The language variant this blog is authored in.
  },
  "name": "A String", # The name of this blog. This is displayed as the title.
  "pages": { # The container of pages in this blog.
    "selfLink": "A String", # The URL of the container for pages in this blog.
    "totalItems": 42, # The count of pages in this blog.
  },
  "posts": { # The container of posts in this blog.
    "items": [ # The List of Posts for this Blog.
      {
        "author": { # The author of this Post.
          "displayName": "A String", # The display name.
          "id": "A String", # The identifier of the creator.
          "image": { # The creator's avatar.
            "url": "A String", # The creator's avatar URL.
          },
          "url": "A String", # The URL of the creator's Profile page.
        },
        "blog": { # Data about the blog containing this Post.
          "id": "A String", # The identifier of the Blog that contains this Post.
        },
        "content": "A String", # The content of the Post. May contain HTML markup.
        "customMetaData": "A String", # The JSON meta-data for the Post.
        "etag": "A String", # Etag of the resource.
        "id": "A String", # The identifier of this Post.
        "images": [ # Display image for the Post.
          {
            "url": "A String",
          },
        ],
        "kind": "A String", # The kind of this entity. Always blogger#post.
        "labels": [ # The list of labels this Post was tagged with.
          "A String",
        ],
        "location": { # The location for geotagged posts.
          "lat": 3.14, # Location's latitude.
          "lng": 3.14, # Location's longitude.
          "name": "A String", # Location name.
          "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
        },
        "published": "A String", # RFC 3339 date-time when this Post was published.
        "readerComments": "A String", # Comment control and display setting for readers of this post.
        "replies": { # The container of comments on this Post.
          "items": [ # The List of Comments for this Post.
            {
              "author": { # The author of this Comment.
                "displayName": "A String", # The display name.
                "id": "A String", # The identifier of the creator.
                "image": { # The creator's avatar.
                  "url": "A String", # The creator's avatar URL.
                },
                "url": "A String", # The URL of the creator's Profile page.
              },
              "blog": { # Data about the blog containing this comment.
                "id": "A String", # The identifier of the blog containing this comment.
              },
              "content": "A String", # The actual content of the comment. May include HTML markup.
              "id": "A String", # The identifier for this resource.
              "inReplyTo": { # Data about the comment this is in reply to.
                "id": "A String", # The identified of the parent of this comment.
              },
              "kind": "A String", # The kind of this entry. Always blogger#comment.
              "post": { # Data about the post containing this comment.
                "id": "A String", # The identifier of the post containing this comment.
              },
              "published": "A String", # RFC 3339 date-time when this comment was published.
              "selfLink": "A String", # The API REST URL to fetch this resource from.
              "status": "A String", # The status of the comment (only populated for admin users).
              "updated": "A String", # RFC 3339 date-time when this comment was last updated.
            },
          ],
          "selfLink": "A String", # The URL of the comments on this post.
          "totalItems": "A String", # The count of comments on this post.
        },
        "selfLink": "A String", # The API REST URL to fetch this resource from.
        "status": "A String", # Status of the post. Only set for admin-level requests.
        "title": "A String", # The title of the Post.
        "titleLink": "A String", # The title link URL, similar to atom's related link.
        "trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
        "updated": "A String", # RFC 3339 date-time when this Post was last updated.
        "url": "A String", # The URL where this Post is displayed.
      },
    ],
    "selfLink": "A String", # The URL of the container for posts in this blog.
    "totalItems": 42, # The count of posts in this blog.
  },
  "published": "A String", # RFC 3339 date-time when this blog was published.
  "selfLink": "A String", # The API REST URL to fetch this resource from.
  "status": "A String", # The status of the blog.
  "updated": "A String", # RFC 3339 date-time when this blog was last updated.
  "url": "A String", # The URL where this blog is published.
}
getByUrl(url, view=None, x__xgafv=None)
Gets a blog by url.

Args:
  url: string, A parameter (required)
  view: string, A parameter
    Allowed values
      VIEW_TYPE_UNSPECIFIED - 
      READER - 
      AUTHOR - 
      ADMIN - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "customMetaData": "A String", # The JSON custom meta-data for the Blog.
  "description": "A String", # The description of this blog. This is displayed underneath the title.
  "id": "A String", # The identifier for this resource.
  "kind": "A String", # The kind of this entry. Always blogger#blog.
  "locale": { # The locale this Blog is set to.
    "country": "A String", # The country this blog's locale is set to.
    "language": "A String", # The language this blog is authored in.
    "variant": "A String", # The language variant this blog is authored in.
  },
  "name": "A String", # The name of this blog. This is displayed as the title.
  "pages": { # The container of pages in this blog.
    "selfLink": "A String", # The URL of the container for pages in this blog.
    "totalItems": 42, # The count of pages in this blog.
  },
  "posts": { # The container of posts in this blog.
    "items": [ # The List of Posts for this Blog.
      {
        "author": { # The author of this Post.
          "displayName": "A String", # The display name.
          "id": "A String", # The identifier of the creator.
          "image": { # The creator's avatar.
            "url": "A String", # The creator's avatar URL.
          },
          "url": "A String", # The URL of the creator's Profile page.
        },
        "blog": { # Data about the blog containing this Post.
          "id": "A String", # The identifier of the Blog that contains this Post.
        },
        "content": "A String", # The content of the Post. May contain HTML markup.
        "customMetaData": "A String", # The JSON meta-data for the Post.
        "etag": "A String", # Etag of the resource.
        "id": "A String", # The identifier of this Post.
        "images": [ # Display image for the Post.
          {
            "url": "A String",
          },
        ],
        "kind": "A String", # The kind of this entity. Always blogger#post.
        "labels": [ # The list of labels this Post was tagged with.
          "A String",
        ],
        "location": { # The location for geotagged posts.
          "lat": 3.14, # Location's latitude.
          "lng": 3.14, # Location's longitude.
          "name": "A String", # Location name.
          "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
        },
        "published": "A String", # RFC 3339 date-time when this Post was published.
        "readerComments": "A String", # Comment control and display setting for readers of this post.
        "replies": { # The container of comments on this Post.
          "items": [ # The List of Comments for this Post.
            {
              "author": { # The author of this Comment.
                "displayName": "A String", # The display name.
                "id": "A String", # The identifier of the creator.
                "image": { # The creator's avatar.
                  "url": "A String", # The creator's avatar URL.
                },
                "url": "A String", # The URL of the creator's Profile page.
              },
              "blog": { # Data about the blog containing this comment.
                "id": "A String", # The identifier of the blog containing this comment.
              },
              "content": "A String", # The actual content of the comment. May include HTML markup.
              "id": "A String", # The identifier for this resource.
              "inReplyTo": { # Data about the comment this is in reply to.
                "id": "A String", # The identified of the parent of this comment.
              },
              "kind": "A String", # The kind of this entry. Always blogger#comment.
              "post": { # Data about the post containing this comment.
                "id": "A String", # The identifier of the post containing this comment.
              },
              "published": "A String", # RFC 3339 date-time when this comment was published.
              "selfLink": "A String", # The API REST URL to fetch this resource from.
              "status": "A String", # The status of the comment (only populated for admin users).
              "updated": "A String", # RFC 3339 date-time when this comment was last updated.
            },
          ],
          "selfLink": "A String", # The URL of the comments on this post.
          "totalItems": "A String", # The count of comments on this post.
        },
        "selfLink": "A String", # The API REST URL to fetch this resource from.
        "status": "A String", # Status of the post. Only set for admin-level requests.
        "title": "A String", # The title of the Post.
        "titleLink": "A String", # The title link URL, similar to atom's related link.
        "trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
        "updated": "A String", # RFC 3339 date-time when this Post was last updated.
        "url": "A String", # The URL where this Post is displayed.
      },
    ],
    "selfLink": "A String", # The URL of the container for posts in this blog.
    "totalItems": 42, # The count of posts in this blog.
  },
  "published": "A String", # RFC 3339 date-time when this blog was published.
  "selfLink": "A String", # The API REST URL to fetch this resource from.
  "status": "A String", # The status of the blog.
  "updated": "A String", # RFC 3339 date-time when this blog was last updated.
  "url": "A String", # The URL where this blog is published.
}
listByUser(userId, fetchUserInfo=None, role=None, status=None, view=None, x__xgafv=None)
Lists blogs by user.

Args:
  userId: string, A parameter (required)
  fetchUserInfo: boolean, A parameter
  role: string, A parameter (repeated)
    Allowed values
      VIEW_TYPE_UNSPECIFIED - 
      READER - 
      AUTHOR - 
      ADMIN - 
  status: string, Default value of status is LIVE. (repeated)
    Allowed values
      LIVE - 
      DELETED - 
  view: string, A parameter
    Allowed values
      VIEW_TYPE_UNSPECIFIED - 
      READER - 
      AUTHOR - 
      ADMIN - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "blogUserInfos": [ # Admin level list of blog per-user information.
    {
      "blog": { # The Blog resource.
        "customMetaData": "A String", # The JSON custom meta-data for the Blog.
        "description": "A String", # The description of this blog. This is displayed underneath the title.
        "id": "A String", # The identifier for this resource.
        "kind": "A String", # The kind of this entry. Always blogger#blog.
        "locale": { # The locale this Blog is set to.
          "country": "A String", # The country this blog's locale is set to.
          "language": "A String", # The language this blog is authored in.
          "variant": "A String", # The language variant this blog is authored in.
        },
        "name": "A String", # The name of this blog. This is displayed as the title.
        "pages": { # The container of pages in this blog.
          "selfLink": "A String", # The URL of the container for pages in this blog.
          "totalItems": 42, # The count of pages in this blog.
        },
        "posts": { # The container of posts in this blog.
          "items": [ # The List of Posts for this Blog.
            {
              "author": { # The author of this Post.
                "displayName": "A String", # The display name.
                "id": "A String", # The identifier of the creator.
                "image": { # The creator's avatar.
                  "url": "A String", # The creator's avatar URL.
                },
                "url": "A String", # The URL of the creator's Profile page.
              },
              "blog": { # Data about the blog containing this Post.
                "id": "A String", # The identifier of the Blog that contains this Post.
              },
              "content": "A String", # The content of the Post. May contain HTML markup.
              "customMetaData": "A String", # The JSON meta-data for the Post.
              "etag": "A String", # Etag of the resource.
              "id": "A String", # The identifier of this Post.
              "images": [ # Display image for the Post.
                {
                  "url": "A String",
                },
              ],
              "kind": "A String", # The kind of this entity. Always blogger#post.
              "labels": [ # The list of labels this Post was tagged with.
                "A String",
              ],
              "location": { # The location for geotagged posts.
                "lat": 3.14, # Location's latitude.
                "lng": 3.14, # Location's longitude.
                "name": "A String", # Location name.
                "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
              },
              "published": "A String", # RFC 3339 date-time when this Post was published.
              "readerComments": "A String", # Comment control and display setting for readers of this post.
              "replies": { # The container of comments on this Post.
                "items": [ # The List of Comments for this Post.
                  {
                    "author": { # The author of this Comment.
                      "displayName": "A String", # The display name.
                      "id": "A String", # The identifier of the creator.
                      "image": { # The creator's avatar.
                        "url": "A String", # The creator's avatar URL.
                      },
                      "url": "A String", # The URL of the creator's Profile page.
                    },
                    "blog": { # Data about the blog containing this comment.
                      "id": "A String", # The identifier of the blog containing this comment.
                    },
                    "content": "A String", # The actual content of the comment. May include HTML markup.
                    "id": "A String", # The identifier for this resource.
                    "inReplyTo": { # Data about the comment this is in reply to.
                      "id": "A String", # The identified of the parent of this comment.
                    },
                    "kind": "A String", # The kind of this entry. Always blogger#comment.
                    "post": { # Data about the post containing this comment.
                      "id": "A String", # The identifier of the post containing this comment.
                    },
                    "published": "A String", # RFC 3339 date-time when this comment was published.
                    "selfLink": "A String", # The API REST URL to fetch this resource from.
                    "status": "A String", # The status of the comment (only populated for admin users).
                    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
                  },
                ],
                "selfLink": "A String", # The URL of the comments on this post.
                "totalItems": "A String", # The count of comments on this post.
              },
              "selfLink": "A String", # The API REST URL to fetch this resource from.
              "status": "A String", # Status of the post. Only set for admin-level requests.
              "title": "A String", # The title of the Post.
              "titleLink": "A String", # The title link URL, similar to atom's related link.
              "trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
              "updated": "A String", # RFC 3339 date-time when this Post was last updated.
              "url": "A String", # The URL where this Post is displayed.
            },
          ],
          "selfLink": "A String", # The URL of the container for posts in this blog.
          "totalItems": 42, # The count of posts in this blog.
        },
        "published": "A String", # RFC 3339 date-time when this blog was published.
        "selfLink": "A String", # The API REST URL to fetch this resource from.
        "status": "A String", # The status of the blog.
        "updated": "A String", # RFC 3339 date-time when this blog was last updated.
        "url": "A String", # The URL where this blog is published.
      },
      "blog_user_info": { # Information about a User for the Blog.
        "blogId": "A String", # ID of the Blog resource.
        "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
        "kind": "A String", # The kind of this entity. Always blogger#blogPerUserInfo.
        "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog.
        "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
        "userId": "A String", # ID of the User.
      },
      "kind": "A String", # The kind of this entity. Always blogger#blogUserInfo.
    },
  ],
  "items": [ # The list of Blogs this user has Authorship or Admin rights over.
    {
      "customMetaData": "A String", # The JSON custom meta-data for the Blog.
      "description": "A String", # The description of this blog. This is displayed underneath the title.
      "id": "A String", # The identifier for this resource.
      "kind": "A String", # The kind of this entry. Always blogger#blog.
      "locale": { # The locale this Blog is set to.
        "country": "A String", # The country this blog's locale is set to.
        "language": "A String", # The language this blog is authored in.
        "variant": "A String", # The language variant this blog is authored in.
      },
      "name": "A String", # The name of this blog. This is displayed as the title.
      "pages": { # The container of pages in this blog.
        "selfLink": "A String", # The URL of the container for pages in this blog.
        "totalItems": 42, # The count of pages in this blog.
      },
      "posts": { # The container of posts in this blog.
        "items": [ # The List of Posts for this Blog.
          {
            "author": { # The author of this Post.
              "displayName": "A String", # The display name.
              "id": "A String", # The identifier of the creator.
              "image": { # The creator's avatar.
                "url": "A String", # The creator's avatar URL.
              },
              "url": "A String", # The URL of the creator's Profile page.
            },
            "blog": { # Data about the blog containing this Post.
              "id": "A String", # The identifier of the Blog that contains this Post.
            },
            "content": "A String", # The content of the Post. May contain HTML markup.
            "customMetaData": "A String", # The JSON meta-data for the Post.
            "etag": "A String", # Etag of the resource.
            "id": "A String", # The identifier of this Post.
            "images": [ # Display image for the Post.
              {
                "url": "A String",
              },
            ],
            "kind": "A String", # The kind of this entity. Always blogger#post.
            "labels": [ # The list of labels this Post was tagged with.
              "A String",
            ],
            "location": { # The location for geotagged posts.
              "lat": 3.14, # Location's latitude.
              "lng": 3.14, # Location's longitude.
              "name": "A String", # Location name.
              "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
            },
            "published": "A String", # RFC 3339 date-time when this Post was published.
            "readerComments": "A String", # Comment control and display setting for readers of this post.
            "replies": { # The container of comments on this Post.
              "items": [ # The List of Comments for this Post.
                {
                  "author": { # The author of this Comment.
                    "displayName": "A String", # The display name.
                    "id": "A String", # The identifier of the creator.
                    "image": { # The creator's avatar.
                      "url": "A String", # The creator's avatar URL.
                    },
                    "url": "A String", # The URL of the creator's Profile page.
                  },
                  "blog": { # Data about the blog containing this comment.
                    "id": "A String", # The identifier of the blog containing this comment.
                  },
                  "content": "A String", # The actual content of the comment. May include HTML markup.
                  "id": "A String", # The identifier for this resource.
                  "inReplyTo": { # Data about the comment this is in reply to.
                    "id": "A String", # The identified of the parent of this comment.
                  },
                  "kind": "A String", # The kind of this entry. Always blogger#comment.
                  "post": { # Data about the post containing this comment.
                    "id": "A String", # The identifier of the post containing this comment.
                  },
                  "published": "A String", # RFC 3339 date-time when this comment was published.
                  "selfLink": "A String", # The API REST URL to fetch this resource from.
                  "status": "A String", # The status of the comment (only populated for admin users).
                  "updated": "A String", # RFC 3339 date-time when this comment was last updated.
                },
              ],
              "selfLink": "A String", # The URL of the comments on this post.
              "totalItems": "A String", # The count of comments on this post.
            },
            "selfLink": "A String", # The API REST URL to fetch this resource from.
            "status": "A String", # Status of the post. Only set for admin-level requests.
            "title": "A String", # The title of the Post.
            "titleLink": "A String", # The title link URL, similar to atom's related link.
            "trashed": "A String", # RFC 3339 date-time when this Post was last trashed.
            "updated": "A String", # RFC 3339 date-time when this Post was last updated.
            "url": "A String", # The URL where this Post is displayed.
          },
        ],
        "selfLink": "A String", # The URL of the container for posts in this blog.
        "totalItems": 42, # The count of posts in this blog.
      },
      "published": "A String", # RFC 3339 date-time when this blog was published.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
      "status": "A String", # The status of the blog.
      "updated": "A String", # RFC 3339 date-time when this blog was last updated.
      "url": "A String", # The URL where this blog is published.
    },
  ],
  "kind": "A String", # The kind of this entity. Always blogger#blogList.
}