API documentation for domains_v1.types package.
Classes
AuthorizationCode
Defines an authorization code.
ConfigureContactSettingsRequest
Request for the ConfigureContactSettings method.
ConfigureDnsSettingsRequest
Request for the ConfigureDnsSettings method.
ConfigureManagementSettingsRequest
Request for the ConfigureManagementSettings method.
ContactNotice
Notices related to contact information.
Values:
CONTACT_NOTICE_UNSPECIFIED (0):
The notice is undefined.
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT (1):
Required when setting the privacy field of
ContactSettings to PUBLIC_CONTACT_DATA, which
exposes contact data publicly.
ContactPrivacy
Defines a set of possible contact privacy settings for a
Registration.
ICANN <https://icann.org/>__ maintains the WHOIS database, a
publicly accessible mapping from domain name to contact information,
and requires that each domain name have an entry. Choose from these
options to control how much information in your ContactSettings
is published.
Values:
CONTACT_PRIVACY_UNSPECIFIED (0):
The contact privacy settings are undefined.
PUBLIC_CONTACT_DATA (1):
All the data from ContactSettings is publicly available.
When setting this option, you must also provide a
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the
contact_notices field of the request.
PRIVATE_CONTACT_DATA (2):
None of the data from ContactSettings is publicly
available. Instead, proxy contact data is published for your
domain. Email sent to the proxy email address is forwarded
to the registrant's email address. Cloud Domains provides
this privacy proxy service at no additional cost.
REDACTED_CONTACT_DATA (3):
Some data from ContactSettings is publicly available.
The actual information redacted depends on the domain. For
details, see the registration privacy
article <https://support.google.com/domains/answer/3251242>__.
ContactSettings
Defines the contact information associated with a Registration.
ICANN <https://icann.org/>__ requires all domain names to have
associated contact information. The registrant_contact is
considered the domain's legal owner, and often the other contacts
are identical.
DeleteRegistrationRequest
Request for the DeleteRegistration method.
DnsSettings
Defines the DNS configuration of a Registration, including name
servers, DNSSEC, and glue records.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DomainNotice
Notices about special properties of certain domains.
Values:
DOMAIN_NOTICE_UNSPECIFIED (0):
The notice is undefined.
HSTS_PRELOADED (1):
Indicates that the domain is preloaded on the HTTP Strict
Transport Security list in browsers. Serving a website on
such domain requires an SSL certificate. For details, see
how to get an SSL
certificate <https://support.google.com/domains/answer/7638036>__.
ExportRegistrationRequest
Request for the ExportRegistration method.
GetRegistrationRequest
Request for the GetRegistration method.
ListRegistrationsRequest
Request for the ListRegistrations method.
ListRegistrationsResponse
Response for the ListRegistrations method.
ManagementSettings
Defines renewal, billing, and transfer settings for a
Registration.
OperationMetadata
Represents the metadata of the long-running operation. Output only.
RegisterDomainRequest
Request for the RegisterDomain method.
RegisterParameters
Parameters required to register a new domain.
Registration
The Registration resource facilitates managing and configuring
domain name registrations.
There are several ways to create a new Registration resource:
To create a new Registration resource, find a suitable domain
name by calling the SearchDomains method with a query to see
available domain name options. After choosing a name, call
RetrieveRegisterParameters to ensure availability and obtain
information like pricing, which is needed to build a call to
RegisterDomain.
Another way to create a new Registration is to transfer an
existing domain from another registrar. First, go to the current
registrar to unlock the domain for transfer and retrieve the
domain's transfer authorization code. Then call
RetrieveTransferParameters to confirm that the domain is
unlocked and to get values needed to build a call to
TransferDomain.
ResetAuthorizationCodeRequest
Request for the ResetAuthorizationCode method.
RetrieveAuthorizationCodeRequest
Request for the RetrieveAuthorizationCode method.
RetrieveRegisterParametersRequest
Request for the RetrieveRegisterParameters method.
RetrieveRegisterParametersResponse
Response for the RetrieveRegisterParameters method.
RetrieveTransferParametersRequest
Request for the RetrieveTransferParameters method.
RetrieveTransferParametersResponse
Response for the RetrieveTransferParameters method.
SearchDomainsRequest
Request for the SearchDomains method.
SearchDomainsResponse
Response for the SearchDomains method.
TransferDomainRequest
Request for the TransferDomain method.
TransferLockState
Possible states of a Registration's transfer lock.
Values: TRANSFER_LOCK_STATE_UNSPECIFIED (0): The state is unspecified. UNLOCKED (1): The domain is unlocked and can be transferred to another registrar. LOCKED (2): The domain is locked and cannot be transferred to another registrar.
TransferParameters
Parameters required to transfer a domain from another registrar.
UpdateRegistrationRequest
Request for the UpdateRegistration method.