customers

Creates, updates, deletes, gets or lists a customers resource.

Overview

Name	customers
Type	Resource
Id	google.cloudcontrolspartner.customers

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Format: organizations/{organization}/locations/{location}/customers/{customer}
customerOnboardingState	object	Output only. Container for customer onboarding steps (id: CustomerOnboardingState)
displayName	string	Required. Display name for the customer
isOnboarded	boolean	Output only. Indicates whether a customer is fully onboarded
organizationDomain	string	Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"

list

Successful response

Name	Datatype	Description
name	string	Identifier. Format: organizations/{organization}/locations/{location}/customers/{customer}
customerOnboardingState	object	Output only. Container for customer onboarding steps (id: CustomerOnboardingState)
displayName	string	Required. Display name for the customer
isOnboarded	boolean	Output only. Indicates whether a customer is fully onboarded
organizationDomain	string	Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	organizationsId, locationsId, customersId		Gets details of a single customer
list	select	organizationsId, locationsId	pageSize, pageToken, filter, orderBy	Lists customers of a partner identified by its Google Cloud organization ID
create	insert	organizationsId, locationsId	customerId	Creates a new customer.
patch	update	organizationsId, locationsId, customersId	updateMask	Update details of a single customer
delete	delete	organizationsId, locationsId, customersId		Delete details of a single customer

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customersId	string
locationsId	string
organizationsId	string
customerId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single customer

SELECT
name,
customerOnboardingState,
displayName,
isOnboarded,
organizationDomain
FROM google.cloudcontrolspartner.customers
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND customersId = '{{ customersId }}' -- required;

list

Lists customers of a partner identified by its Google Cloud organization ID

SELECT
name,
customerOnboardingState,
displayName,
isOnboarded,
organizationDomain
FROM google.cloudcontrolspartner.customers
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new customer.

INSERT INTO google.cloudcontrolspartner.customers (
data__name,
data__displayName,
organizationsId,
locationsId,
customerId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ customerId }}'
RETURNING
name,
customerOnboardingState,
displayName,
isOnboarded,
organizationDomain
;

Manifest

# Description fields are for documentation purposes
- name: customers
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the customers resource.
    - name: locationsId
      value: string
      description: Required parameter for the customers resource.
    - name: name
      value: string
      description: >
        Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
        
    - name: displayName
      value: string
      description: >
        Required. Display name for the customer
        
    - name: customerId
      value: string

UPDATE examples

patch

Update details of a single customer

UPDATE google.cloudcontrolspartner.customers
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND customersId = '{{ customersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
customerOnboardingState,
displayName,
isOnboarded,
organizationDomain;

DELETE examples

delete

Delete details of a single customer

DELETE FROM google.cloudcontrolspartner.customers
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND customersId = '{{ customersId }}' --required;