ProjectsLocationsRegistrations
class ProjectsLocationsRegistrations extends Resource (View source)
The "registrations" collection of methods.
Typical usage is:
$domainsService = new Google\Service\CloudDomains(...);
$registrations = $domainsService->projects_locations_registrations;
Methods
Updates a Registration
's contact settings. Some changes require
confirmation by the domain's registrant contact . Caution: Please consider
carefully any changes to contact privacy settings when changing from
REDACTED_CONTACT_DATA
to PUBLIC_CONTACT_DATA.
There may be a delay in
reflecting updates you make to registrant contact information such that any
changes you make to contact privacy (including from REDACTED_CONTACT_DATA
to PUBLIC_CONTACT_DATA
) will be applied without delay but changes to
registrant contact information may take a limited time to be publicized. This
means that changes to contact privacy from REDACTED_CONTACT_DATA
to
PUBLIC_CONTACT_DATA
may make the previous registrant contact data public
until the modified registrant contact details are published.
Updates a Registration
's DNS settings. (registrations.configureDnsSettings)
Updates a Registration
's management settings.
Deletes a Registration
resource. This method works on any Registration
resource using Subscription or Commitment billing, provided that the resource was created at least 1 day in the past.
Deprecated: For more information, see Cloud Domains feature
deprecation Exports a Registration
resource, such that it is no longer
managed by Cloud Domains. When an active domain is successfully exported, you
can continue to use the domain in Google Domains
until it expires. The calling user becomes the domain's sole owner in Google
Domains, and permissions for the domain are subsequently managed there. The
domain does not renew automatically unless the new owner sets up billing in
Google Domains. (registrations.export)
Gets the details of a Registration
resource. (registrations.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (registrations.getIamPolicy)
Deprecated: For more information, see Cloud Domains feature
deprecation Imports a domain name from Google
Domains for use in Cloud Domains. To transfer a
domain from another registrar, use the TransferDomain
method instead. Since
individual users can own domains in Google Domains, the calling user must
have ownership permission on the domain. (registrations.import)
Initiates the Push Transfer
process to transfer the domain to another
registrar. The process might complete instantly or might require confirmation
or additional work. Check the emails sent to the email address of the
registrant. The process is aborted after a timeout if it's not completed.
Lists the Registration
resources in a project.
Updates select fields of a Registration
resource, notably labels
. To
update other fields, use the appropriate custom update method: To update
management settings, see ConfigureManagementSettings
To update DNS
configuration, see ConfigureDnsSettings
* To update contact information,
see ConfigureContactSettings
(registrations.patch)
Registers a new domain name and creates a corresponding Registration
resource. Call RetrieveRegisterParameters
first to check availability of
the domain name and determine parameters like price that are needed to build
a call to this method. A successful call creates a Registration
resource in
state REGISTRATION_PENDING
, which resolves to ACTIVE
within 1-2 minutes,
indicating that the domain was successfully registered. If the resource ends
up in state REGISTRATION_FAILED
, it indicates that the domain was not
registered successfully, and you can safely delete the resource and retry
registration. (registrations.register)
Renews a recently expired domain. This method can only be called on domains
that expired in the previous 30 days. After the renewal, the new expiration
time of the domain is one year after the old expiration time and you are
charged a yearly_price
for the renewal. (registrations.renewDomain)
Resets the authorization code of the Registration
to a new random string.
Gets the authorization code of the Registration
for the purpose of
transferring the domain to another registrar. You can call this method only
after 60 days have elapsed since the initial domain registration. Domains
that have the REQUIRE_PUSH_TRANSFER
property in the list of
domain_properties
don't support authorization codes and must use the
InitiatePushTransfer
method to initiate the process to transfer the domain
to a different registrar. (registrations.retrieveAuthorizationCode)
Lists the DNS records from the Google Domains DNS zone for domains that use
the deprecated google_domains_dns
in the Registration
's dns_settings
.
Lists the deprecated domain and email forwarding configurations you set up in
the deprecated Google Domains UI. The configuration is present only for
domains with the google_domains_redirects_data_available
set to true
in
the Registration
's dns_settings
. A forwarding configuration might not
work correctly if required DNS records are not present in the domain's
authoritative DNS Zone. (registrations.retrieveGoogleDomainsForwardingConfig)
Deprecated: For more information, see Cloud Domains feature
deprecation Lists domain names from Google
Domains that can be imported to Cloud Domains using
the ImportDomain
method. Since individual users can own domains in Google
Domains, the list of domains returned depends on the individual user making
the call. Domains already managed by Cloud Domains are not returned.
Gets parameters needed to register a new domain name, including price and up-
to-date availability. Use the returned values to call RegisterDomain
.
Deprecated: For more information, see Cloud Domains feature
deprecation Gets parameters needed to transfer a domain name from another
registrar to Cloud Domains. For domains already managed by Google
Domains, use ImportDomain
instead. Use the
returned values to call TransferDomain
.
Searches for available domain names similar to the provided query.
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (registrations.setIamPolicy)
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND
error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
Deprecated: For more information, see Cloud Domains feature
deprecation Transfers a domain name from another registrar to Cloud
Domains. For domains already managed by Google
Domains, use ImportDomain
instead. Before calling
this method, go to the domain's 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 this method. A successful call creates a
Registration
resource in state TRANSFER_PENDING
. It can take several days
to complete the transfer process. The registrant can often speed up this
process by approving the transfer through the current registrar, either by
clicking a link in an email from the registrar or by visiting the registrar's
website. A few minutes after transfer approval, the resource transitions to
state ACTIVE
, indicating that the transfer was successful. If the transfer
is rejected or the request expires without being approved, the resource can
end up in state TRANSFER_FAILED
. If transfer fails, you can safely delete
the resource and retry the transfer. (registrations.transfer)
Details
Operation
configureContactSettings(string $registration, ConfigureContactSettingsRequest $postBody, array $optParams = [])
Updates a Registration
's contact settings. Some changes require
confirmation by the domain's registrant contact . Caution: Please consider
carefully any changes to contact privacy settings when changing from
REDACTED_CONTACT_DATA
to PUBLIC_CONTACT_DATA.
There may be a delay in
reflecting updates you make to registrant contact information such that any
changes you make to contact privacy (including from REDACTED_CONTACT_DATA
to PUBLIC_CONTACT_DATA
) will be applied without delay but changes to
registrant contact information may take a limited time to be publicized. This
means that changes to contact privacy from REDACTED_CONTACT_DATA
to
PUBLIC_CONTACT_DATA
may make the previous registrant contact data public
until the modified registrant contact details are published.
(registrations.configureContactSettings)
Operation
configureDnsSettings(string $registration, ConfigureDnsSettingsRequest $postBody, array $optParams = [])
Updates a Registration
's DNS settings. (registrations.configureDnsSettings)
Operation
configureManagementSettings(string $registration, ConfigureManagementSettingsRequest $postBody, array $optParams = [])
Updates a Registration
's management settings.
(registrations.configureManagementSettings)
Operation
delete(string $name, array $optParams = [])
Deletes a Registration
resource. This method works on any Registration
resource using Subscription or Commitment billing, provided that the resource was created at least 1 day in the past.
When an active registration is successfully deleted, you can continue to use
the domain in Google Domains until it expires. The
calling user becomes the domain's sole owner in Google Domains, and
permissions for the domain are subsequently managed there. The domain does
not renew automatically unless the new owner sets up billing in Google
Domains. After January 2024 you will only be able to delete Registration
resources when state
is one of: EXPORTED
, EXPIRED
,REGISTRATION_FAILED
or TRANSFER_FAILED
. See Cloud Domains feature
deprecation for more details. (registrations.delete)
Operation
export(string $name, ExportRegistrationRequest $postBody, array $optParams = [])
Deprecated: For more information, see Cloud Domains feature
deprecation Exports a Registration
resource, such that it is no longer
managed by Cloud Domains. When an active domain is successfully exported, you
can continue to use the domain in Google Domains
until it expires. The calling user becomes the domain's sole owner in Google
Domains, and permissions for the domain are subsequently managed there. The
domain does not renew automatically unless the new owner sets up billing in
Google Domains. (registrations.export)
Registration
get(string $name, array $optParams = [])
Gets the details of a Registration
resource. (registrations.get)
Policy
getIamPolicy(string $resource, array $optParams = [])
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (registrations.getIamPolicy)
Operation
import(string $parent, ImportDomainRequest $postBody, array $optParams = [])
Deprecated: For more information, see Cloud Domains feature
deprecation Imports a domain name from Google
Domains for use in Cloud Domains. To transfer a
domain from another registrar, use the TransferDomain
method instead. Since
individual users can own domains in Google Domains, the calling user must
have ownership permission on the domain. (registrations.import)
Operation
initiatePushTransfer(string $registration, InitiatePushTransferRequest $postBody, array $optParams = [])
Initiates the Push Transfer
process to transfer the domain to another
registrar. The process might complete instantly or might require confirmation
or additional work. Check the emails sent to the email address of the
registrant. The process is aborted after a timeout if it's not completed.
This method is only supported for domains that have the
REQUIRE_PUSH_TRANSFER
property in the list of domain_properties
. The
domain must also be unlocked before it can be transferred to a different
registrar. For more information, see Transfer a registered domain to another
registrar. (registrations.initiatePushTransfer)
ListRegistrationsResponse
listProjectsLocationsRegistrations(string $parent, array $optParams = [])
Lists the Registration
resources in a project.
(registrations.listProjectsLocationsRegistrations)
Operation
patch(string $name, Registration $postBody, array $optParams = [])
Updates select fields of a Registration
resource, notably labels
. To
update other fields, use the appropriate custom update method: To update
management settings, see ConfigureManagementSettings
To update DNS
configuration, see ConfigureDnsSettings
* To update contact information,
see ConfigureContactSettings
(registrations.patch)
Operation
register(string $parent, RegisterDomainRequest $postBody, array $optParams = [])
Registers a new domain name and creates a corresponding Registration
resource. Call RetrieveRegisterParameters
first to check availability of
the domain name and determine parameters like price that are needed to build
a call to this method. A successful call creates a Registration
resource in
state REGISTRATION_PENDING
, which resolves to ACTIVE
within 1-2 minutes,
indicating that the domain was successfully registered. If the resource ends
up in state REGISTRATION_FAILED
, it indicates that the domain was not
registered successfully, and you can safely delete the resource and retry
registration. (registrations.register)
Operation
renewDomain(string $registration, RenewDomainRequest $postBody, array $optParams = [])
Renews a recently expired domain. This method can only be called on domains
that expired in the previous 30 days. After the renewal, the new expiration
time of the domain is one year after the old expiration time and you are
charged a yearly_price
for the renewal. (registrations.renewDomain)
AuthorizationCode
resetAuthorizationCode(string $registration, ResetAuthorizationCodeRequest $postBody, array $optParams = [])
Resets the authorization code of the Registration
to a new random string.
You can call this method only after 60 days have elapsed since the initial
domain registration. Domains that have the REQUIRE_PUSH_TRANSFER
property
in the list of domain_properties
don't support authorization codes and must
use the InitiatePushTransfer
method to initiate the process to transfer the
domain to a different registrar. (registrations.resetAuthorizationCode)
AuthorizationCode
retrieveAuthorizationCode(string $registration, array $optParams = [])
Gets the authorization code of the Registration
for the purpose of
transferring the domain to another registrar. You can call this method only
after 60 days have elapsed since the initial domain registration. Domains
that have the REQUIRE_PUSH_TRANSFER
property in the list of
domain_properties
don't support authorization codes and must use the
InitiatePushTransfer
method to initiate the process to transfer the domain
to a different registrar. (registrations.retrieveAuthorizationCode)
RetrieveGoogleDomainsDnsRecordsResponse
retrieveGoogleDomainsDnsRecords(string $registration, array $optParams = [])
Lists the DNS records from the Google Domains DNS zone for domains that use
the deprecated google_domains_dns
in the Registration
's dns_settings
.
(registrations.retrieveGoogleDomainsDnsRecords)
RetrieveGoogleDomainsForwardingConfigResponse
retrieveGoogleDomainsForwardingConfig(string $registration, array $optParams = [])
Lists the deprecated domain and email forwarding configurations you set up in
the deprecated Google Domains UI. The configuration is present only for
domains with the google_domains_redirects_data_available
set to true
in
the Registration
's dns_settings
. A forwarding configuration might not
work correctly if required DNS records are not present in the domain's
authoritative DNS Zone. (registrations.retrieveGoogleDomainsForwardingConfig)
RetrieveImportableDomainsResponse
retrieveImportableDomains(string $location, array $optParams = [])
Deprecated: For more information, see Cloud Domains feature
deprecation Lists domain names from Google
Domains that can be imported to Cloud Domains using
the ImportDomain
method. Since individual users can own domains in Google
Domains, the list of domains returned depends on the individual user making
the call. Domains already managed by Cloud Domains are not returned.
(registrations.retrieveImportableDomains)
RetrieveRegisterParametersResponse
retrieveRegisterParameters(string $location, array $optParams = [])
Gets parameters needed to register a new domain name, including price and up-
to-date availability. Use the returned values to call RegisterDomain
.
(registrations.retrieveRegisterParameters)
RetrieveTransferParametersResponse
retrieveTransferParameters(string $location, array $optParams = [])
Deprecated: For more information, see Cloud Domains feature
deprecation Gets parameters needed to transfer a domain name from another
registrar to Cloud Domains. For domains already managed by Google
Domains, use ImportDomain
instead. Use the
returned values to call TransferDomain
.
(registrations.retrieveTransferParameters)
SearchDomainsResponse
searchDomains(string $location, array $optParams = [])
Searches for available domain names similar to the provided query.
Availability results from this method are approximate; call
RetrieveRegisterParameters
on a domain before registering to confirm
availability. (registrations.searchDomains)
Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (registrations.setIamPolicy)
TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND
error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning. (registrations.testIamPermissions)
Operation
transfer(string $parent, TransferDomainRequest $postBody, array $optParams = [])
Deprecated: For more information, see Cloud Domains feature
deprecation Transfers a domain name from another registrar to Cloud
Domains. For domains already managed by Google
Domains, use ImportDomain
instead. Before calling
this method, go to the domain's 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 this method. A successful call creates a
Registration
resource in state TRANSFER_PENDING
. It can take several days
to complete the transfer process. The registrant can often speed up this
process by approving the transfer through the current registrar, either by
clicking a link in an email from the registrar or by visiting the registrar's
website. A few minutes after transfer approval, the resource transitions to
state ACTIVE
, indicating that the transfer was successful. If the transfer
is rejected or the request expires without being approved, the resource can
end up in state TRANSFER_FAILED
. If transfer fails, you can safely delete
the resource and retry the transfer. (registrations.transfer)