Updates an existing Customer resource for the reseller or distributor. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.
Scopes
You will need authorization for the https://www.googleapis.com/auth/apps.order scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/apps.order.
You can set the scope for this method like this: cloudchannel1 --scope <scope> accounts channel-partner-links-customers-patch ...
Required Scalar Argument
- <name> (string)
- Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
GoogleCloudChannelV1Customer:
alternate-email: string
channel-partner-id: string
cloud-identity-id: string
cloud-identity-info:
admin-console-uri: string
alternate-email: string
customer-type: string
edu-data:
institute-size: string
institute-type: string
website: string
is-domain-verified: boolean
language-code: string
phone-number: string
primary-domain: string
correlation-id: string
create-time: string
domain: string
language-code: string
name: string
org-display-name: string
org-postal-address:
address-lines: [string]
administrative-area: string
language-code: string
locality: string
organization: string
postal-code: string
recipients: [string]
region-code: string
revision: integer
sorting-code: string
sublocality: string
primary-contact-info:
display-name: string
email: string
first-name: string
last-name: string
phone: string
title: string
update-time: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . alternate-email=erat
- 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.
channel-partner-id=consetetur
- Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.
cloud-identity-id=amet.
- Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
cloud-identity-info admin-console-uri=sed
- Output only. URI of Customer's Admin console dashboard.
alternate-email=takimata
- The alternate email.
customer-type=dolores
- CustomerType indicates verification type needed for using services.
edu-data institute-size=gubergren
- Size of the institute.
institute-type=et
- Designated institute type of customer.
-
website=accusam
- Web address for the edu customer's institution.
-
.. is-domain-verified=false
- Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
language-code=dolore
- Language code.
phone-number=dolore
- Phone number associated with the Cloud Identity.
-
primary-domain=dolore
- Output only. The primary domain name.
-
.. correlation-id=voluptua.
- Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer.
create-time=amet.
- Output only. Time when the customer was created.
domain=ea
- Required. The customer's primary domain. Must match the primary contact email's domain.
language-code=sadipscing
- 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.
name=lorem
- Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
org-display-name=invidunt
- Required. Name of the organization that the customer entity represents.
org-postal-address address-lines=no
- Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
- Each invocation of this argument appends the given value to the array.
administrative-area=est
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
language-code=at
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
locality=sed
- Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
organization=sit
- Optional. The name of the organization at the address.
postal-code=et
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
recipients=tempor
- Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
- Each invocation of this argument appends the given value to the array.
region-code=aliquyam
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
revision=96
- The schema revision of the
PostalAddress
. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
- The schema revision of the
sorting-code=et
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-
sublocality=sanctus
- Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-
..primary-contact-info display-name=lorem
- Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name.
email=est
- The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.
first-name=sed
- The customer account contact's first name. Optional for Team customers.
last-name=diam
- The customer account contact's last name. Optional for Team customers.
phone=dolores
- The customer account's contact phone number.
-
title=dolores
- Optional. The customer account contact's job title.
-
.. update-time=et
- Output only. Time when the customer was updated.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
- -p update-mask=string
- The update mask that applies to the resource. Optional.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").