Blogger API v3 . blogs

Instance Methods

get(blogId=*, x__xgafv=None)

Gets a blog by id.

list(userId=*, x__xgafv=None)

Lists blogs by user id, possibly filtered.

Method Details

get(blogId=*, x__xgafv=None)
Gets a blog by id.

Args:
  blogId: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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

Args:
  userId: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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