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

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.

configureDnsSettings(string $registration, ConfigureDnsSettingsRequest $postBody, array $optParams = [])

Updates a Registration's DNS settings. (registrations.configureDnsSettings)

configureManagementSettings(string $registration, ConfigureManagementSettingsRequest $postBody, array $optParams = [])

Updates a Registration's management settings.

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.

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)

get(string $name, array $optParams = [])

Gets the details of a Registration resource. (registrations.get)

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)

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)

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.

listProjectsLocationsRegistrations(string $parent, array $optParams = [])

Lists the Registration resources in a project.

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)

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)

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)

resetAuthorizationCode(string $registration, ResetAuthorizationCodeRequest $postBody, array $optParams = [])

Resets the authorization code of the Registration to a new random string.

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)

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.

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)

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.

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.

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.

searchDomains(string $location, array $optParams = [])

Searches for available domain names similar to the provided query.

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)

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.

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)

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)

Parameters

string $registration

Required. The name of the Registration whose contact settings are being updated, in the format projects/locations/registrations.

ConfigureContactSettingsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation configureDnsSettings(string $registration, ConfigureDnsSettingsRequest $postBody, array $optParams = [])

Updates a Registration's DNS settings. (registrations.configureDnsSettings)

Parameters

string $registration

Required. The name of the Registration whose DNS settings are being updated, in the format projects/locations/registrations.

ConfigureDnsSettingsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation configureManagementSettings(string $registration, ConfigureManagementSettingsRequest $postBody, array $optParams = [])

Updates a Registration's management settings.

(registrations.configureManagementSettings)

Parameters

string $registration

Required. The name of the Registration whose management settings are being updated, in the format projects/locations/registrations.

ConfigureManagementSettingsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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)

Parameters

string $name

Required. The name of the Registration to delete, in the format projects/locations/registrations.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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)

Parameters

string $name

Required. The name of the Registration to export, in the format projects/locations/registrations.

ExportRegistrationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Registration get(string $name, array $optParams = [])

Gets the details of a Registration resource. (registrations.get)

Parameters

string $name

Required. The name of the Registration to get, in the format projects/locations/registrations.

array $optParams

Optional parameters.

Return Value

Registration

Exceptions

Exception

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

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)

Parameters

string $parent

Required. The parent resource of the Registration. Must be in the format projects/locations.

ImportDomainRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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)

Parameters

string $registration

Required. The name of the Registration for which the push transfer is initiated, in the format projects/locations/registrations.

InitiatePushTransferRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

ListRegistrationsResponse listProjectsLocationsRegistrations(string $parent, array $optParams = [])

Lists the Registration resources in a project.

(registrations.listProjectsLocationsRegistrations)

Parameters

string $parent

Required. The project and location from which to list Registrations, specified in the format projects/locations.

array $optParams

Optional parameters.

Return Value

ListRegistrationsResponse

Exceptions

Exception

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)

Parameters

string $name

Output only. Name of the Registration resource, in the format projects/locations/registrations/.

Registration $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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)

Parameters

string $parent

Required. The parent resource of the Registration. Must be in the format projects/locations.

RegisterDomainRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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)

Parameters

string $registration

Required. The name of the Registration whish is being renewed, in the format projects/locations/registrations.

RenewDomainRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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)

Parameters

string $registration

Required. The name of the Registration whose authorization code is being reset, in the format projects/locations/registrations.

ResetAuthorizationCodeRequest $postBody
array $optParams

Optional parameters.

Return Value

AuthorizationCode

Exceptions

Exception

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)

Parameters

string $registration

Required. The name of the Registration whose authorization code is being retrieved, in the format projects/locations/registrations.

array $optParams

Optional parameters.

Return Value

AuthorizationCode

Exceptions

Exception

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)

Parameters

string $registration

Required. The name of the Registration whose Google Domains DNS records details you are retrieving, in the format projects/locations/registrations.

array $optParams

Optional parameters.

Return Value

RetrieveGoogleDomainsDnsRecordsResponse

Exceptions

Exception

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)

Parameters

string $registration

Required. The name of the Registration whose Google Domains forwarding configuration details are being retrieved, in the format projects/locations/registrations.

array $optParams

Optional parameters.

Return Value

RetrieveGoogleDomainsForwardingConfigResponse

Exceptions

Exception

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)

Parameters

string $location

Required. The location. Must be in the format projects/locations.

array $optParams

Optional parameters.

Return Value

RetrieveImportableDomainsResponse

Exceptions

Exception

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)

Parameters

string $location

Required. The location. Must be in the format projects/locations.

array $optParams

Optional parameters.

Return Value

RetrieveRegisterParametersResponse

Exceptions

Exception

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)

Parameters

string $location

Required. The location. Must be in the format projects/locations.

array $optParams

Optional parameters.

Return Value

RetrieveTransferParametersResponse

Exceptions

Exception

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)

Parameters

string $location

Required. The location. Must be in the format projects/locations.

array $optParams

Optional parameters.

Return Value

SearchDomainsResponse

Exceptions

Exception

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)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

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)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception

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)

Parameters

string $parent

Required. The parent resource of the Registration. Must be in the format projects/locations.

TransferDomainRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception