Class DomainsResource

The "domains" collection of methods.

Inheritance
object
DomainsResource
Inherited Members
Namespace: Google.Apis.PostmasterTools.v2
Assembly: Google.Apis.PostmasterTools.v2.dll
Syntax
public class DomainsResource

Constructors

DomainsResource(IClientService)

Constructs a new resource.

Declaration
public DomainsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

DomainStats

Gets the DomainStats resource.

Declaration
public virtual DomainsResource.DomainStatsResource DomainStats { get; }
Property Value
Type Description
DomainsResource.DomainStatsResource

Users

Gets the Users resource.

Declaration
public virtual DomainsResource.UsersResource Users { get; }
Property Value
Type Description
DomainsResource.UsersResource

Methods

Create(CreateDomainRequest)

Developer Preview: Adds a domain to the user's account. Returns INVALID_ARGUMENT if a domain is not provided. Returns ALREADY_EXISTS if the domain is already registered by the user.

Declaration
public virtual DomainsResource.CreateRequest Create(CreateDomainRequest body)
Parameters
Type Name Description
CreateDomainRequest body

The body of the request.
Returns
Type Description
DomainsResource.CreateRequest

Delete(string)

Developer Preview: Deletes a domain from the user's account. Returns NOT_FOUND if the domain is not registered by the user.

Declaration
public virtual DomainsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The domain to delete.
Returns
Type Description
DomainsResource.DeleteRequest

Get(string)

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.

Declaration
public virtual DomainsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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).
Returns
Type Description
DomainsResource.GetRequest

GetComplianceStatus(string)

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

Declaration
public virtual DomainsResource.GetComplianceStatusRequest GetComplianceStatus(string name)
Parameters
Type Name Description
string name

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

GetVerificationToken(string)

Developer Preview: Gets a verification token used for verifying a user's ownership over a domain.

Declaration
public virtual DomainsResource.GetVerificationTokenRequest GetVerificationToken(string name)
Parameters
Type Name Description
string name

Required. The resource name of the verification token to retrieve. Format: domains/{domain}/verificationToken
Returns
Type Description
DomainsResource.GetVerificationTokenRequest

List()

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.

Declaration
public virtual DomainsResource.ListRequest List()
Returns
Type Description
DomainsResource.ListRequest

Verify(VerifyDomainRequest, string)

Developer Preview: Verifies a user's ownership of a domain at the DNS level. Note that this is distinct from checking if the user has OWNER status within IRDB.

Declaration
public virtual DomainsResource.VerifyRequest Verify(VerifyDomainRequest body, string name)
Parameters
Type Name Description
VerifyDomainRequest body

The body of the request.
string name

Required. The domain to verify.
Returns
Type Description
DomainsResource.VerifyRequest