Update company. Should only be called within the context of an authorized logged in user.
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:
Company:
additional-websites: [string]
auto-approval-email-domains: [string]
badge-authority-in-awn: boolean
badge-tier: string
company-types: [string]
converted-min-monthly-budget:
currency-code: string
nanos: integer
units: string
id: string
industries: [string]
name: string
original-min-monthly-budget:
currency-code: string
nanos: integer
units: string
primary-adwords-manager-account-id: string
primary-language-code: string
primary-location:
address: string
address-line: [string]
administrative-area: string
dependent-locality: string
language-code: string
lat-lng:
latitude: number
longitude: number
locality: string
postal-code: string
region-code: string
sorting-code: string
profile-status: string
public-profile:
display-image-url: string
display-name: string
id: string
profile-image: string
url: string
services: [string]
website-url: 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 . additional-websites=eos
- URL of the company's additional websites used to verify the dynamic badges. These are stored as full URLs as entered by the user, but only the TLD will be used for the actual verification.
- Each invocation of this argument appends the given value to the array.
auto-approval-email-domains=labore
- Email domains that allow users with a matching email address to get auto-approved for associating with this company.
- Each invocation of this argument appends the given value to the array.
badge-authority-in-awn=true
- Whether the company's badge authority is in AWN
badge-tier=duo
- Partner badge tier
company-types=sed
- Company type labels listed on the company's profile.
- Each invocation of this argument appends the given value to the array.
converted-min-monthly-budget currency-code=no
- The 3-letter currency code defined in ISO 4217.
nanos=86
- Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If
units
is positive,nanos
must be positive or zero. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.
- Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If
-
units=kasd
- The whole units of the amount.
For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- The whole units of the amount.
For example if
-
.. id=et
- The ID of the company.
industries=sed
- Industries the company can help with.
- Each invocation of this argument appends the given value to the array.
name=et
- The name of the company.
original-min-monthly-budget currency-code=et
- The 3-letter currency code defined in ISO 4217.
nanos=25
- Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If
units
is positive,nanos
must be positive or zero. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.
- Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If
-
units=erat
- The whole units of the amount.
For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- The whole units of the amount.
For example if
-
.. primary-adwords-manager-account-id=sed
- The Primary AdWords Manager Account id.
primary-language-code=duo
- The primary language code of the company, as defined by <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> (IETF BCP 47, "Tags for Identifying Languages").
primary-location address=dolore
- The single string version of the address.
address-line=et
- The following address lines represent the most specific part of any address.
- Each invocation of this argument appends the given value to the array.
administrative-area=voluptua.
- Top-level administrative subdivision of this country.
dependent-locality=amet.
- Dependent locality or sublocality. Used for UK dependent localities, or neighborhoods or boroughs in other locations.
language-code=consetetur
- Language code of the address. Should be in BCP 47 format.
lat-lng latitude=0.07223777776561668
- The latitude in degrees. It must be in the range [-90.0, +90.0].
-
longitude=0.9625057030686941
- The longitude in degrees. It must be in the range [-180.0, +180.0].
-
.. locality=et
- Generally refers to the city/town portion of an address.
postal-code=sadipscing
- Values are frequently alphanumeric.
region-code=stet
- CLDR (Common Locale Data Repository) region code .
-
sorting-code=dolor
- Use of this code is very country-specific, but will refer to a secondary classification code for sorting mail.
-
.. profile-status=duo
- The public viewability status of the company's profile.
public-profile display-image-url=vero
- The URL to the main display image of the public profile. Being deprecated.
display-name=vero
- The display name of the public profile.
id=invidunt
- The ID which can be used to retrieve more details about the public profile.
profile-image=stet
- The URL to the main profile image of the public profile.
-
url=vero
- The URL of the public profile.
-
.. services=elitr
- Services the company can help with.
- Each invocation of this argument appends the given value to the array.
website-url=lorem
- URL of the company's website.
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 request-metadata-experiment-ids=string
- Experiment IDs the current request belongs to.
-
-p request-metadata-locale=string
- Locale to use for the current request.
-
-p request-metadata-partners-session-id=string
- Google Partners session ID.
-
-p request-metadata-traffic-source-traffic-source-id=string
- Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
-
-p request-metadata-traffic-source-traffic-sub-id=string
- Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
-
-p request-metadata-user-overrides-ip-address=string
- IP address to use instead of the user's geo-located IP address.
-
-p request-metadata-user-overrides-user-id=string
- Logged-in user ID to impersonate instead of the user's ID.
-
-p update-mask=string
- Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths.
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").