Gmail Postmaster Tools API . domains

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.

Args:
  name: string, The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A registered domain resource in the Postmaster API.
  "createTime": "A String", # Timestamp when the user registered this domain. Assigned by the server.
  "name": "A String", # The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
  "permission": "A String", # User’s permission for this domain. Assigned by the server.
}

list(pageSize=None, pageToken=None, x__xgafv=None)

Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.

Args:
  pageSize: integer, Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to `ListDomains` method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListDomains.
  "domains": [ # The list of domains.
    { # A registered domain resource in the Postmaster API.
      "createTime": "A String", # Timestamp when the user registered this domain. Assigned by the server.
      "name": "A String", # The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
      "permission": "A String", # User’s permission for this domain. Assigned by the server.
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}

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.