Gmail Postmaster Tools API (gmailpostmastertools:v2)

2026-02-11

5 new methods | New API

Additions

    Methods
  • gmailpostmastertools.domains.domainStats.query

      Path : v2/{+parent}/domainStats:query

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/postmaster
    • https://www.googleapis.com/auth/postmaster.traffic.readonly
    • Parameters :

        parent

          Description : Required. The parent resource name where the stats are queried. Format: domains/{domain}

          Type : string

          Required : Yes

          Location : path

          Pattern : ^domains/[^/]+$

      Description : Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain.

      Flat Path : v2/domains/{domainsId}/domainStats:query

      Parameter Order : parent

  • gmailpostmastertools.domains.getComplianceStatus

      Parameters :

        name

          Type : string

          Description : Required. The resource name of the domain's compliance status to retrieve. Format: `domains/{domain_id}/complianceStatus`.

          Location : path

          Pattern : ^domains/[^/]+/complianceStatus$

          Required : Yes

      Flat Path : v2/domains/{domainsId}/complianceStatus

      Path : v2/{+name}

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/postmaster
    • https://www.googleapis.com/auth/postmaster.traffic.readonly
    • HTTP Method : GET

      Description : Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.

  • gmailpostmastertools.domains.get

      Scopes :

    • https://www.googleapis.com/auth/postmaster
    • https://www.googleapis.com/auth/postmaster.domain
    • Description : Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.

      HTTP Method : GET

      Parameters :

        name

          Pattern : ^domains/[^/]+$

          Description : Required. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).

          Location : path

          Required : Yes

          Type : string

      Path : v2/{+name}

      Parameter Order : name

      Flat Path : v2/domains/{domainsId}

  • gmailpostmastertools.domains.list

      Flat Path : v2/domains

      Description : Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.

      HTTP Method : GET

      Path : v2/domains

      Parameters :

        pageSize

          Format : int32

          Location : query

          Type : integer

          Description : Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.

        pageToken

          Location : query

          Description : Optional. The next_page_token value returned from a previous List request, if any.

          Type : string

      Scopes :

    • https://www.googleapis.com/auth/postmaster
    • https://www.googleapis.com/auth/postmaster.domain
  • gmailpostmastertools.domainStats.batchQuery