Blogger API v3 . pages

Instance Methods

delete(blogId=*, pageId=*, x__xgafv=None)

Deletes a page by blog id and page id.

get(blogId=*, pageId=*, x__xgafv=None, view=None)

Gets a page by blog id and page id.

insert(blogId=*, body=None, isDraft=None, x__xgafv=None)

Inserts a page.

list(blogId=*, status=None, maxResults=None, pageToken=None, x__xgafv=None, fetchBodies=None, view=None)

Lists pages.

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

patch(blogId=*, pageId=*, body=None, revert=None, publish=None, x__xgafv=None)

Patches a page.

publish(blogId=*, pageId=*, x__xgafv=None)

Publishes a page.

revert(blogId=*, pageId=*, x__xgafv=None)

Reverts a published or scheduled page to draft state.

update(blogId=*, pageId=*, body=None, revert=None, publish=None, x__xgafv=None)

Updates a page by blog id and page id.

Method Details

delete(blogId=*, pageId=*, x__xgafv=None)
Deletes a page by blog id and page id.

Args:
  blogId: string, A parameter (required)
  pageId: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(blogId=*, pageId=*, x__xgafv=None, view=None)
Gets a page by blog id and page id.

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

Returns:
  An object of the form:

    {
      "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
      "content": "A String", # The body content of this Page, in HTML.
      "kind": "A String", # The kind of this entity. Always blogger#page.
      "author": { # The author of this Page.
        "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.
      },
      "url": "A String", # The URL that this Page is displayed at.
      "title": "A String", # The title of this entity. This is the name displayed in the Admin user
          # interface.
      "updated": "A String", # RFC 3339 date-time when this Page was last updated.
      "blog": { # Data about the blog containing this Page.
        "id": "A String", # The identifier of the blog containing this page.
      },
      "etag": "A String", # Etag of the resource.
      "published": "A String", # RFC 3339 date-time when this Page was published.
      "id": "A String", # The identifier for this resource.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
    }
insert(blogId=*, body=None, isDraft=None, x__xgafv=None)
Inserts a page.

Args:
  blogId: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
    "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
    "content": "A String", # The body content of this Page, in HTML.
    "kind": "A String", # The kind of this entity. Always blogger#page.
    "author": { # The author of this Page.
      "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.
    },
    "url": "A String", # The URL that this Page is displayed at.
    "title": "A String", # The title of this entity. This is the name displayed in the Admin user
        # interface.
    "updated": "A String", # RFC 3339 date-time when this Page was last updated.
    "blog": { # Data about the blog containing this Page.
      "id": "A String", # The identifier of the blog containing this page.
    },
    "etag": "A String", # Etag of the resource.
    "published": "A String", # RFC 3339 date-time when this Page was published.
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }

  isDraft: boolean, A parameter
  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 page for admin resources (either LIVE or DRAFT).
      "content": "A String", # The body content of this Page, in HTML.
      "kind": "A String", # The kind of this entity. Always blogger#page.
      "author": { # The author of this Page.
        "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.
      },
      "url": "A String", # The URL that this Page is displayed at.
      "title": "A String", # The title of this entity. This is the name displayed in the Admin user
          # interface.
      "updated": "A String", # RFC 3339 date-time when this Page was last updated.
      "blog": { # Data about the blog containing this Page.
        "id": "A String", # The identifier of the blog containing this page.
      },
      "etag": "A String", # Etag of the resource.
      "published": "A String", # RFC 3339 date-time when this Page was published.
      "id": "A String", # The identifier for this resource.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
    }
list(blogId=*, status=None, maxResults=None, pageToken=None, x__xgafv=None, fetchBodies=None, view=None)
Lists pages.

Args:
  blogId: string, A parameter (required)
  status: string, A parameter (repeated)
  maxResults: integer, A parameter
  pageToken: string, A parameter
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  fetchBodies: boolean, A parameter
  view: string, A parameter

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    "items": [ # The list of Pages for a Blog.
      {
          "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
          "content": "A String", # The body content of this Page, in HTML.
          "kind": "A String", # The kind of this entity. Always blogger#page.
          "author": { # The author of this Page.
            "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.
          },
          "url": "A String", # The URL that this Page is displayed at.
          "title": "A String", # The title of this entity. This is the name displayed in the Admin user
              # interface.
          "updated": "A String", # RFC 3339 date-time when this Page was last updated.
          "blog": { # Data about the blog containing this Page.
            "id": "A String", # The identifier of the blog containing this page.
          },
          "etag": "A String", # Etag of the resource.
          "published": "A String", # RFC 3339 date-time when this Page was published.
          "id": "A String", # The identifier for this resource.
          "selfLink": "A String", # The API REST URL to fetch this resource from.
        },
    ],
    "kind": "A String", # The kind of this entity. Always blogger#pageList.
    "etag": "A String", # Etag of the response.
  }
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(blogId=*, pageId=*, body=None, revert=None, publish=None, x__xgafv=None)
Patches a page.

Args:
  blogId: string, A parameter (required)
  pageId: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
    "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
    "content": "A String", # The body content of this Page, in HTML.
    "kind": "A String", # The kind of this entity. Always blogger#page.
    "author": { # The author of this Page.
      "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.
    },
    "url": "A String", # The URL that this Page is displayed at.
    "title": "A String", # The title of this entity. This is the name displayed in the Admin user
        # interface.
    "updated": "A String", # RFC 3339 date-time when this Page was last updated.
    "blog": { # Data about the blog containing this Page.
      "id": "A String", # The identifier of the blog containing this page.
    },
    "etag": "A String", # Etag of the resource.
    "published": "A String", # RFC 3339 date-time when this Page was published.
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }

  revert: boolean, A parameter
  publish: boolean, A parameter
  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 page for admin resources (either LIVE or DRAFT).
      "content": "A String", # The body content of this Page, in HTML.
      "kind": "A String", # The kind of this entity. Always blogger#page.
      "author": { # The author of this Page.
        "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.
      },
      "url": "A String", # The URL that this Page is displayed at.
      "title": "A String", # The title of this entity. This is the name displayed in the Admin user
          # interface.
      "updated": "A String", # RFC 3339 date-time when this Page was last updated.
      "blog": { # Data about the blog containing this Page.
        "id": "A String", # The identifier of the blog containing this page.
      },
      "etag": "A String", # Etag of the resource.
      "published": "A String", # RFC 3339 date-time when this Page was published.
      "id": "A String", # The identifier for this resource.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
    }
publish(blogId=*, pageId=*, x__xgafv=None)
Publishes a page.

Args:
  blogId: string, A parameter (required)
  pageId: 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 page for admin resources (either LIVE or DRAFT).
      "content": "A String", # The body content of this Page, in HTML.
      "kind": "A String", # The kind of this entity. Always blogger#page.
      "author": { # The author of this Page.
        "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.
      },
      "url": "A String", # The URL that this Page is displayed at.
      "title": "A String", # The title of this entity. This is the name displayed in the Admin user
          # interface.
      "updated": "A String", # RFC 3339 date-time when this Page was last updated.
      "blog": { # Data about the blog containing this Page.
        "id": "A String", # The identifier of the blog containing this page.
      },
      "etag": "A String", # Etag of the resource.
      "published": "A String", # RFC 3339 date-time when this Page was published.
      "id": "A String", # The identifier for this resource.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
    }
revert(blogId=*, pageId=*, x__xgafv=None)
Reverts a published or scheduled page to draft state.

Args:
  blogId: string, A parameter (required)
  pageId: 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 page for admin resources (either LIVE or DRAFT).
      "content": "A String", # The body content of this Page, in HTML.
      "kind": "A String", # The kind of this entity. Always blogger#page.
      "author": { # The author of this Page.
        "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.
      },
      "url": "A String", # The URL that this Page is displayed at.
      "title": "A String", # The title of this entity. This is the name displayed in the Admin user
          # interface.
      "updated": "A String", # RFC 3339 date-time when this Page was last updated.
      "blog": { # Data about the blog containing this Page.
        "id": "A String", # The identifier of the blog containing this page.
      },
      "etag": "A String", # Etag of the resource.
      "published": "A String", # RFC 3339 date-time when this Page was published.
      "id": "A String", # The identifier for this resource.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
    }
update(blogId=*, pageId=*, body=None, revert=None, publish=None, x__xgafv=None)
Updates a page by blog id and page id.

Args:
  blogId: string, A parameter (required)
  pageId: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
    "status": "A String", # The status of the page for admin resources (either LIVE or DRAFT).
    "content": "A String", # The body content of this Page, in HTML.
    "kind": "A String", # The kind of this entity. Always blogger#page.
    "author": { # The author of this Page.
      "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.
    },
    "url": "A String", # The URL that this Page is displayed at.
    "title": "A String", # The title of this entity. This is the name displayed in the Admin user
        # interface.
    "updated": "A String", # RFC 3339 date-time when this Page was last updated.
    "blog": { # Data about the blog containing this Page.
      "id": "A String", # The identifier of the blog containing this page.
    },
    "etag": "A String", # Etag of the resource.
    "published": "A String", # RFC 3339 date-time when this Page was published.
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }

  revert: boolean, A parameter
  publish: boolean, A parameter
  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 page for admin resources (either LIVE or DRAFT).
      "content": "A String", # The body content of this Page, in HTML.
      "kind": "A String", # The kind of this entity. Always blogger#page.
      "author": { # The author of this Page.
        "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.
      },
      "url": "A String", # The URL that this Page is displayed at.
      "title": "A String", # The title of this entity. This is the name displayed in the Admin user
          # interface.
      "updated": "A String", # RFC 3339 date-time when this Page was last updated.
      "blog": { # Data about the blog containing this Page.
        "id": "A String", # The identifier of the blog containing this page.
      },
      "etag": "A String", # Etag of the resource.
      "published": "A String", # RFC 3339 date-time when this Page was published.
      "id": "A String", # The identifier for this resource.
      "selfLink": "A String", # The API REST URL to fetch this resource from.
    }