Blogger API . pages

Instance Methods

close()

Close httplib2 connections.

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

Deletes a page by blog id and page id.

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

Gets a page by blog id and page id.

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

Inserts a page.

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

Lists pages.

list_next()

Retrieves the next page of results.

patch(blogId, pageId, body=None, publish=None, revert=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, publish=None, revert=None, x__xgafv=None)

Updates a page by blog id and page id.

Method Details

close()
Close httplib2 connections.
delete(blogId, pageId, useTrash=None, x__xgafv=None)
Deletes a page by blog id and page id.

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

Args:
  blogId: string, A parameter (required)
  pageId: 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:

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

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

  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:

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

Args:
  blogId: string, A parameter (required)
  fetchBodies: boolean, A parameter
  maxResults: integer, A parameter
  pageToken: string, A parameter
  status: string, A parameter (repeated)
    Allowed values
      LIVE - 
      DRAFT - 
      SOFT_TRASHED - 
  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:

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

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

  publish: boolean, A parameter
  revert: 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:

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

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

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

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

  publish: boolean, A parameter
  revert: 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:

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