Updates the event ticket 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> eventticketclass 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:

EventTicketClass:
  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
  confirmation-code-label: string
  country-code: string
  custom-confirmation-code-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-gate-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  custom-row-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-section-label:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  date-time:
    custom-doors-open-label:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    doors-open: string
    doors-open-label: string
    end: string
    kind: string
    start: string
  enable-smart-tap: boolean
  event-id: string
  event-name:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  fine-print:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  gate-label: string
  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
  kind: 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
  row-label: string
  seat-label: string
  section-label: string
  security-animation:
    animation-type: string
  venue:
    address:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    name:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
  version: string
  view-unlock-requirement: 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 . allow-multiple-users-per-object=true
    • Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
  • callback-options update-request-url=sea
    • 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=et

    • 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=at

    • No description provided.
  • .... confirmation-code-label=dolore

    • The label to use for the confirmation code value (eventTicketObject.reservationInfo.confirmationCode) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both confirmationCodeLabel and customConfirmationCodeLabel may not be set. If neither is set, the label will default to "Confirmation Code", localized. If the confirmation code field is unset, this label will not be used.
  • country-code=eirmod
    • 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-confirmation-code-label.default-value kind=lorem
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=accusam
    • 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=erat

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ..custom-gate-label.default-value kind=dolores

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

    • The UTF-8 encoded translated string.
  • .. kind=sea

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ..custom-row-label.default-value kind=takimata

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=lorem
    • 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=at

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ..custom-seat-label.default-value kind=dolor

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

    • The UTF-8 encoded translated string.
  • .. kind=erat

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ..custom-section-label.default-value kind=sea

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=nonumy
    • 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=gubergren

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ..date-time.custom-doors-open-label.default-value kind=justo

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

    • The UTF-8 encoded translated string.
  • .. kind=sit

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. doors-open=aliquyam

    • The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the venue is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
  • doors-open-label=eos
    • The label to use for the doors open value (doorsOpen) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both doorsOpenLabel and customDoorsOpenLabel may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
  • end=at
    • The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the venue is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
  • kind=dolores
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#eventDateTime&#34;.
  • start=consetetur

    • The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the venue is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
  • .. 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.
  • event-id=dolor
    • The ID of the event. This ID should be unique for every event in an account. It is used to group tickets together if the user has saved multiple tickets for the same event. It can be at most 64 characters. If provided, the grouping will be stable. Be wary of unintentional collision to avoid grouping tickets that should not be grouped. If you use only one class per event, you can simply set this to the classId (with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable).
  • event-name.default-value kind=aliquyam
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=no
    • 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 &#34;walletobjects#localizedString&#34;.
  • ..fine-print.default-value kind=lorem

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=accusam
    • 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=sadipscing

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. gate-label=at

    • The label to use for the gate value (eventTicketObject.seatInfo.gate) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both gateLabel and customGateLabel may not be set. If neither is set, the label will default to "Gate", localized. If the gate field is unset, this label will not be used.
  • hero-image.content-description.default-value kind=sit
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=duo
    • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
  • value=sit

    • The UTF-8 encoded translated string.
  • .. kind=magna

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. kind=et

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

    • The UTF-8 encoded translated string.
  • .. kind=amet.

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. uri=no

    • The location of the image. URIs must have a scheme.
  • ... hex-background-color=nonumy

    • 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=sed
    • 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=kasd
    • 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 &#34;walletobjects#uri&#34;.
  • localized-description.default-value kind=sanctus
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=nonumy
    • 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=tempor

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. uri=dolore

    • 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=eos

    • 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=dolore

    • Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
  • kind=amet
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#eventTicketClass&#34;.
  • localized-issuer-name.default-value kind=ut
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=at
    • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
  • value=sit

    • The UTF-8 encoded translated string.
  • .. kind=vero

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ..logo.content-description.default-value kind=duo

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

    • The UTF-8 encoded translated string.
  • .. kind=rebum.

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. kind=duo

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

    • The UTF-8 encoded translated string.
  • .. kind=et

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. uri=lorem

    • The location of the image. URIs must have a scheme.
  • ... multiple-devices-and-holders-allowed-status=magna

    • Identifies whether multiple users and devices will save the same object referencing this class.
  • redemption-issuers=takimata
    • 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=rebum.

    • No description provided.
  • .. review-status=at

    • 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.
  • row-label=invidunt
    • The label to use for the row value (eventTicketObject.seatInfo.row) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both rowLabel and customRowLabel may not be set. If neither is set, the label will default to "Row", localized. If the row field is unset, this label will not be used.
  • seat-label=clita
    • The label to use for the seat value (eventTicketObject.seatInfo.seat) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both seatLabel and customSeatLabel may not be set. If neither is set, the label will default to "Seat", localized. If the seat field is unset, this label will not be used.
  • section-label=stet
    • The label to use for the section value (eventTicketObject.seatInfo.section) on the card detail view. Each available option maps to a set of localized strings, so that translations are shown to the user based on their locale. Both sectionLabel and customSectionLabel may not be set. If neither is set, the label will default to "Section", localized. If the section field is unset, this label will not be used.
  • security-animation animation-type=aliquyam

    • Type of animation.
  • ..venue.address.default-value kind=ut

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

    • The UTF-8 encoded translated string.
  • .. kind=rebum.

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. kind=dolores

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#eventVenue&#34;.
  • name.default-value kind=consetetur
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=dolores
    • 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=invidunt

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • ... version=clita

    • Deprecated
  • view-unlock-requirement=dolor
    • View Unlock Requirement options for the event ticket.
  • wide-logo.content-description.default-value kind=aliquyam
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=magna
    • 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=nonumy

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. kind=et

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#image&#34;.
  • source-uri description=sanctus
    • Additional information about the image, which is unused and retained only for backward compatibility.
  • localized-description.default-value kind=accusam
    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=tempor
    • 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=est

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. uri=takimata

    • The location of the image. URIs must have a scheme.
  • ...word-mark.content-description.default-value kind=dolor

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#translatedString&#34;.
  • language=diam
    • 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=erat

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. kind=justo

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

    • The UTF-8 encoded translated string.
  • .. kind=no

    • Identifies what kind of resource this is. Value: the fixed string &#34;walletobjects#localizedString&#34;.
  • .. uri=justo

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