Reference documentation and code samples for the Google Cloud Channel V1 Client class Customer.
Entity representing a customer of a reseller or distributor.
Generated from protobuf message google.cloud.channel.v1.Customer
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} |
↳ org_display_name |
string
Required. Name of the organization that the customer entity represents. |
↳ org_postal_address |
Google\Type\PostalAddress
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. |
↳ primary_contact_info |
Google\Cloud\Channel\V1\ContactInfo
Primary contact info. |
↳ alternate_email |
string
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers. |
↳ domain |
string
Required. The customer's primary domain. Must match the primary contact email's domain. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the customer was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the customer was updated. |
↳ cloud_identity_id |
string
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. |
↳ language_code |
string
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
↳ cloud_identity_info |
Google\Cloud\Channel\V1\CloudIdentityInfo
Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. |
↳ channel_partner_id |
string
Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. |
↳ correlation_id |
string
Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer. |
getName
Output only. Resource name of the customer.
Format: accounts/{account_id}/customers/{customer_id}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the customer.
Format: accounts/{account_id}/customers/{customer_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrgDisplayName
Required. Name of the organization that the customer entity represents.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrgDisplayName
Required. Name of the organization that the customer entity represents.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrgPostalAddress
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
| Returns | |
|---|---|
| Type | Description |
Google\Type\PostalAddress|null | |
hasOrgPostalAddress
clearOrgPostalAddress
setOrgPostalAddress
Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\PostalAddress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrimaryContactInfo
Primary contact info.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\ContactInfo|null | |
hasPrimaryContactInfo
clearPrimaryContactInfo
setPrimaryContactInfo
Primary contact info.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\ContactInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAlternateEmail
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.
| Returns | |
|---|---|
| Type | Description |
string | |
setAlternateEmail
Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDomain
Required. The customer's primary domain. Must match the primary contact email's domain.
| Returns | |
|---|---|
| Type | Description |
string | |
setDomain
Required. The customer's primary domain. Must match the primary contact email's domain.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the customer was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the customer was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Time when the customer was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the customer was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudIdentityId
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
| Returns | |
|---|---|
| Type | Description |
string | |
setCloudIdentityId
Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCode
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCloudIdentityInfo
Output only. Cloud Identity information for the customer.
Populated only if a Cloud Identity account exists for this customer.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Channel\V1\CloudIdentityInfo|null | |
hasCloudIdentityInfo
clearCloudIdentityInfo
setCloudIdentityInfo
Output only. Cloud Identity information for the customer.
Populated only if a Cloud Identity account exists for this customer.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Channel\V1\CloudIdentityInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getChannelPartnerId
Cloud Identity ID of the customer's channel partner.
Populated only if a channel partner exists for this customer.
| Returns | |
|---|---|
| Type | Description |
string | |
setChannelPartnerId
Cloud Identity ID of the customer's channel partner.
Populated only if a channel partner exists for this customer.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCorrelationId
Optional. External CRM ID for the customer.
Populated only if a CRM ID exists for this customer.
| Returns | |
|---|---|
| Type | Description |
string | |
setCorrelationId
Optional. External CRM ID for the customer.
Populated only if a CRM ID exists for this customer.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |