2026-11-17
▼ ▲ gmailpostmastertools.domains.list
Description : 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.
Scopes : https://www.googleapis.com/auth/postmaster.readonly
Parameters :
pageSize
Description : Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.
Location : query
Format : int32
Type : integer
pageToken
Description : 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.
Type : string
Location : query
Path : v1beta1/domains
Flat Path : v1beta1/domains
HTTP Method : GET
▼ ▲ gmailpostmastertools.domains.get
Path : v1beta1/{+name}
Parameter Order : name
Flat Path : v1beta1/domains/{domainsId}
Description : Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.
HTTP Method : GET
Parameters :
name
Location : path
Description : The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
Required : Yes
Type : string
Pattern : ^domains/[^/]+$
Scopes : https://www.googleapis.com/auth/postmaster.readonly
▼ ▲ gmailpostmastertools.domains.trafficStats.get
Parameter Order : name
Scopes : https://www.googleapis.com/auth/postmaster.readonly
Path : v1beta1/{+name}
Parameters :
name
Description : The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.
Required : Yes
Pattern : ^domains/[^/]+/trafficStats/[^/]+$
Location : path
Type : string
Description : Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
Flat Path : v1beta1/domains/{domainsId}/trafficStats/{trafficStatsId}
HTTP Method : GET
▼ ▲ gmailpostmastertools.domains.trafficStats.list
Description : List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
Scopes : https://www.googleapis.com/auth/postmaster.readonly
Parameter Order : parent
Path : v1beta1/{+parent}/trafficStats
HTTP Method : GET
Flat Path : v1beta1/domains/{domainsId}/trafficStats
Parameters :
parent
Required : Yes
Type : string
Pattern : ^domains/[^/]+$
Description : The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
Location : path
startDate.month
Format : int32
Type : integer
Description : Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Location : query
startDate.year
Description : Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Type : integer
Location : query
Format : int32
startDate.day
Location : query
Description : Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
Format : int32
Type : integer
endDate.year
Format : int32
Description : Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Location : query
Type : integer
pageSize
Format : int32
Location : query
Description : Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
Type : integer
pageToken
Description : The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to `ListTrafficStats` method.
Location : query
Type : string
endDate.day
Description : Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
Location : query
Format : int32
Type : integer
endDate.month
Format : int32
Description : Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Location : query
Type : integer