Updates the transit class referenced by the given class ID. This method supports patch semantics.

Scopes

You will need authorization for the https://www.googleapis.com/auth/wallet_object.issuer scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/wallet_object.issuer. You can set the scope for this method like this: walletobjects1 --scope <scope> transitclass patch ...

Required Scalar Argument

• <resource-id> (string)
  • The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

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:

TransitClass:
  activation-options:
    activation-url: string
    allow-reactivation: boolean
  allow-multiple-users-per-object: boolean
  callback-options:
    update-request-url: string
    url: string
  class-template-info:
    list-template-override:
      first-row-option:
        transit-option: string
  country-code: string
  custom-carriage-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-coach-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-concession-category-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-confirmation-code-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-discount-message-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-fare-class-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-fare-name-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-other-restrictions-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-platform-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-purchase-face-value-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-purchase-price-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-purchase-receipt-number-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-route-restrictions-details-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-route-restrictions-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-seat-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-ticket-number-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-time-restrictions-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-transit-terminus-name-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-zone-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  enable-single-leg-itinerary: boolean
  enable-smart-tap: boolean
  hero-image:
    content-description:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    source-uri:
      description: string
      localized-description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      uri: string
  hex-background-color: string
  homepage-uri:
    description: string
    id: string
    kind: string
    localized-description:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    uri: string
  id: string
  info-module-data:
    show-last-update-time: boolean
  issuer-name: string
  language-override: string
  localized-issuer-name:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  logo:
    content-description:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    source-uri:
      description: string
      localized-description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      uri: string
  multiple-devices-and-holders-allowed-status: string
  redemption-issuers: [string]
  review:
    comments: string
  review-status: string
  security-animation:
    animation-type: string
  transit-operator-name:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  transit-type: string
  version: string
  view-unlock-requirement: string
  watermark:
    content-description:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    source-uri:
      description: string
      localized-description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      uri: string
  wide-logo:
    content-description:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    source-uri:
      description: string
      localized-description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      uri: string
  word-mark:
    content-description:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    source-uri:
      description: string
      localized-description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      uri: 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 .activation-options activation-url=vero
  • HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.

• allow-reactivation=true

  • Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device.

• .. allow-multiple-users-per-object=true

  • Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
• callback-options update-request-url=sadipscing
  • URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. Deprecated.

• url=aliquyam

  • The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables.

• ..class-template-info.list-template-override.first-row-option transit-option=ut

  • No description provided.

• .... country-code=nonumy

  • Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
• custom-carriage-label.default-value kind=ipsum
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=dolor
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=tempor

  • The UTF-8 encoded translated string.

• .. kind=at

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-coach-label.default-value kind=ipsum

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=sanctus
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=tempor

  • The UTF-8 encoded translated string.

• .. kind=dolor

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-concession-category-label.default-value kind=stet

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=at
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=lorem

  • The UTF-8 encoded translated string.

• .. kind=eirmod

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-confirmation-code-label.default-value kind=labore

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=ipsum
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=rebum.

  • The UTF-8 encoded translated string.

• .. kind=lorem

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-discount-message-label.default-value kind=vero

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=voluptua.
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=eos

  • The UTF-8 encoded translated string.

• .. kind=magna

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-fare-class-label.default-value kind=aliquyam

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=sit
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=kasd

  • The UTF-8 encoded translated string.

• .. kind=ipsum

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-fare-name-label.default-value kind=nonumy

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=amet
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=gubergren

  • The UTF-8 encoded translated string.

• .. kind=sed

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-other-restrictions-label.default-value kind=sea

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=dolor
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=at

  • The UTF-8 encoded translated string.

• .. kind=lorem

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-platform-label.default-value kind=rebum.

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=elitr
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=nonumy

  • The UTF-8 encoded translated string.

• .. kind=kasd

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-purchase-face-value-label.default-value kind=sadipscing

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=et
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=et

  • The UTF-8 encoded translated string.

• .. kind=consetetur

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-purchase-price-label.default-value kind=vero

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=takimata
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=labore

  • The UTF-8 encoded translated string.

• .. kind=ipsum

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-purchase-receipt-number-label.default-value kind=accusam

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=eirmod
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=takimata

  • The UTF-8 encoded translated string.

• .. kind=elitr

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-route-restrictions-details-label.default-value kind=sanctus

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=at
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=voluptua.

  • The UTF-8 encoded translated string.

• .. kind=dolore

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-route-restrictions-label.default-value kind=diam

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=consetetur
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=no

  • The UTF-8 encoded translated string.

• .. kind=rebum.

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-seat-label.default-value kind=dolor

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=sed
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=amet.

  • The UTF-8 encoded translated string.

• .. kind=ipsum

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-ticket-number-label.default-value kind=sadipscing

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=ea
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=at

  • The UTF-8 encoded translated string.

• .. kind=sed

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-time-restrictions-label.default-value kind=sit

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=erat
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=eos

  • The UTF-8 encoded translated string.

• .. kind=ipsum

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-transit-terminus-name-label.default-value kind=diam

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=invidunt
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=sed

  • The UTF-8 encoded translated string.

• .. kind=gubergren

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..custom-zone-label.default-value kind=gubergren

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=gubergren
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=et

  • The UTF-8 encoded translated string.

• .. kind=stet

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. enable-single-leg-itinerary=false

  • Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
• enable-smart-tap=true
  • Identifies whether this class supports Smart Tap. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.
• hero-image.content-description.default-value kind=dolore
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=eos
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=amet.

  • The UTF-8 encoded translated string.

• .. kind=ea

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. kind=amet

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=erat
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=duo
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=rebum.
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=invidunt

  • The UTF-8 encoded translated string.

• .. kind=clita

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. uri=takimata

  • The location of the image. URIs must have a scheme.

• ... hex-background-color=dolor

  • The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0.
• homepage-uri description=duo
  • The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when description is part of an image.
• id=justo
  • The ID associated with a uri. This field is here to enable ease of management of uris.
• kind=lorem
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
• localized-description.default-value kind=ipsum
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=stet
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=sed

  • The UTF-8 encoded translated string.

• .. kind=ea

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. uri=lorem

  • The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.

• .. id=at

  • Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

• info-module-data show-last-update-time=true

  • No description provided.

• .. issuer-name=at

  • Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
• language-override=ut
  • If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
• localized-issuer-name.default-value kind=sea
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=invidunt
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=duo

  • The UTF-8 encoded translated string.

• .. kind=dolor

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• ..logo.content-description.default-value kind=dolor

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=clita
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=aliquyam

  • The UTF-8 encoded translated string.

• .. kind=clita

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. kind=erat

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=dolore
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=sed
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=eirmod
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=diam

  • The UTF-8 encoded translated string.

• .. kind=tempor

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. uri=sit

  • The location of the image. URIs must have a scheme.

• ... multiple-devices-and-holders-allowed-status=erat

  • Identifies whether multiple users and devices will save the same object referencing this class.
• redemption-issuers=et
  • Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The enableSmartTap and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.
  • Each invocation of this argument appends the given value to the array.

• review comments=et

  • No description provided.

• .. review-status=ipsum

  • Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft. You should keep this field to draft when the class is under development. A draft class cannot be used to create any object. You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects. When updating an already approved class you should keep setting this field to underReview.

• security-animation animation-type=at

  • Type of animation.

• ..transit-operator-name.default-value kind=sed

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=labore
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=dolores

  • The UTF-8 encoded translated string.

• .. kind=diam

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. transit-type=nonumy

  • Required. The type of transit this class represents, such as "bus".
• version=et
  • Deprecated
• view-unlock-requirement=duo
  • View Unlock Requirement options for the transit ticket.
• watermark.content-description.default-value kind=dolor
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=sea
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=sanctus

  • The UTF-8 encoded translated string.

• .. kind=stet

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. kind=dolores

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=erat
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=no
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=sit
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=takimata

  • The UTF-8 encoded translated string.

• .. kind=labore

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. uri=sit

  • The location of the image. URIs must have a scheme.

• ...wide-logo.content-description.default-value kind=sit

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=eirmod
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=stet

  • The UTF-8 encoded translated string.

• .. kind=sit

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. kind=magna

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=consetetur
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=sea
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=dolor
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=duo

  • The UTF-8 encoded translated string.

• .. kind=kasd

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. uri=amet.

  • The location of the image. URIs must have a scheme.

• ...word-mark.content-description.default-value kind=stet

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=et
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=dolores

  • The UTF-8 encoded translated string.

• .. kind=kasd

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. kind=eos

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=ipsum
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=diam
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=sed
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=no

  • The UTF-8 encoded translated string.

• .. kind=amet.

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".

• .. uri=aliquyam

  • The location of the image. URIs must have a scheme.

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.

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").