Creates an account with the specified name and type under the given parent. <ul> <li> Personal accounts and Organizations cannot be created. </li> <li> User Groups cannot be created with a Personal account as primary owner. </li> <li> Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization. </li> <li> Location Groups cannot own Location Groups. </li> </ul>
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:
Account:
account-name: string
account-number: string
name: string
organization-info:
phone-number: string
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
registered-domain: string
permission-level: string
role: string
state:
status: string
vetted-status: string
type: 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 . account-name=takimata
- The name of the account. <aside class="note"><b>Note:</b> For an account
with AccountType
PERSONAL
, this is the first and last name of the user account.</aside>
- The name of the account. <aside class="note"><b>Note:</b> For an account
with AccountType
account-number=amet.
- Account reference number if provisioned.
name=duo
- The resource name, in the format
accounts/{account_id}
.
- The resource name, in the format
organization-info phone-number=ipsum
- The contact number for the organization.
-
postal-address address-lines=gubergren
-
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=lorem
- 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=gubergren
- 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=eos
- 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=dolor
- Optional. The name of the organization at the address. *postal-code=ea
- 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=ipsum
- 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=invidunt
- 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 http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. *revision=54
- The schema revision of thePostalAddress
. This must be set to 0, which is the latest revision.All new revisions must be backward compatible with old revisions. *
sorting-code=duo
- 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=ipsum
- Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-
-
.. registered-domain=sed
- The registered domain for the account.
-
.. permission-level=ut
- Output only. Specifies the PermissionLevel the caller has for this account.
role=gubergren
- Output only. Specifies the AccountRole the caller has for this account.
state status=rebum.
- If verified, future locations that are created are automatically connected to Google Maps, and have Google+ pages created, without requiring moderation.
-
vetted-status=est
- Indicates whether the account is vetted by Google. A vetted account is able to verify locations via the VETTED_PARTNER method.
-
.. type=ipsum
- Output only. Specifies the AccountType of this account.
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 primary-owner=string
- The resource name of the account which will be the primary owner of the
account being created. It should be of the form
accounts/{account_id}/
.
- The resource name of the account which will be the primary owner of the
account being created. It should be of the form
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").