Inserts an event ticket object with the given ID and properties.

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> eventticketobject insert ...

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:

EventTicketObject:
  app-link-data:
    android-app-link-info:
      app-logo-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
      app-target:
        package-name: string
        target-uri:
          description: string
          id: string
          kind: string
          localized-description:
            default-value:
              kind: string
              language: string
              value: string
            kind: string
          uri: string
      description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      title:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
    ios-app-link-info:
      app-logo-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
      app-target:
        package-name: string
        target-uri:
          description: string
          id: string
          kind: string
          localized-description:
            default-value:
              kind: string
              language: string
              value: string
            kind: string
          uri: string
      description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      title:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
    web-app-link-info:
      app-logo-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
      app-target:
        package-name: string
        target-uri:
          description: string
          id: string
          kind: string
          localized-description:
            default-value:
              kind: string
              language: string
              value: string
            kind: string
          uri: string
      description:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
      title:
        default-value:
          kind: string
          language: string
          value: string
        kind: string
  barcode:
    alternate-text: string
    kind: string
    render-encoding: string
    show-code-text:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    type: string
    value: string
  class-id: string
  class-reference:
    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
  disable-expiration-notification: boolean
  face-value:
    currency-code: string
    kind: string
    micros: string
  grouping-info:
    grouping-id: string
    sort-index: integer
  has-linked-device: boolean
  has-users: 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
  id: string
  info-module-data:
    show-last-update-time: boolean
  kind: string
  linked-offer-ids: [string]
  pass-constraints:
    nfc-constraint: [string]
    screenshot-eligibility: string
  reservation-info:
    confirmation-code: string
    kind: string
  rotating-barcode:
    alternate-text: string
    initial-rotating-barcode-values:
      period-millis: string
      start-date-time: string
      values: [string]
    render-encoding: string
    show-code-text:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    totp-details:
      algorithm: string
      period-millis: string
    type: string
    value-pattern: string
  seat-info:
    gate:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    kind: string
    row:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    seat:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
    section:
      default-value:
        kind: string
        language: string
        value: string
      kind: string
  smart-tap-redemption-value: string
  state: string
  ticket-holder-name: string
  ticket-number: string
  ticket-type:
    default-value:
      kind: string
      language: string
      value: string
    kind: string
  valid-time-interval:
    end:
      date: string
    kind: string
    start:
      date: string
  version: 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 .app-link-data.android-app-link-info.app-logo-image.content-description.default-value kind=gubergren
  • 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=ipsum

  • The UTF-8 encoded translated string.

• .. kind=kasd

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

• .. kind=dolore

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=lorem
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=amet
  • 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=lorem

  • The UTF-8 encoded translated string.

• .. kind=dolores

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

• .. uri=consetetur

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

• ...app-target package-name=stet

  • Package name for AppTarget. For example: com.google.android.gm
• target-uri description=accusam
  • 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=consetetur
  • The ID associated with a uri. This field is here to enable ease of management of uris.
• kind=takimata
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
• localized-description.default-value kind=sed
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=nonumy
  • 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=eos

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

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

• ...description.default-value kind=accusam

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

  • The UTF-8 encoded translated string.

• .. kind=labore

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

• ..title.default-value kind=et

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

  • The UTF-8 encoded translated string.

• .. kind=at

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

• ...ios-app-link-info.app-logo-image.content-description.default-value kind=stet

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

  • The UTF-8 encoded translated string.

• .. kind=lorem

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

• .. kind=dolor

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

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

• .. uri=et

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

• ...app-target package-name=dolor

  • Package name for AppTarget. For example: com.google.android.gm
• target-uri description=erat
  • 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=dolore
  • The ID associated with a uri. This field is here to enable ease of management of uris.
• kind=vero
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
• localized-description.default-value kind=ea
  • 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=amet.

  • The UTF-8 encoded translated string.

• .. kind=eirmod

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

• .. uri=sanctus

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

• ...description.default-value kind=sed

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

  • The UTF-8 encoded translated string.

• .. kind=et

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

• ..title.default-value kind=erat

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

  • The UTF-8 encoded translated string.

• .. kind=ea

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

• ...web-app-link-info.app-logo-image.content-description.default-value kind=aliquyam

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

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

• .. kind=eirmod

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=dolores
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=aliquyam
  • 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=invidunt

  • The UTF-8 encoded translated string.

• .. kind=dolor

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

• .. uri=eos

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

• ...app-target package-name=magna

  • Package name for AppTarget. For example: com.google.android.gm
• target-uri description=no
  • 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=gubergren
  • The ID associated with a uri. This field is here to enable ease of management of uris.
• kind=erat
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
• localized-description.default-value kind=aliquyam
  • 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=ea

  • The UTF-8 encoded translated string.

• .. kind=lorem

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

• .. uri=elitr

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

• ...description.default-value kind=justo

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

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

• ..title.default-value kind=vero

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

  • The UTF-8 encoded translated string.

• .. kind=sanctus

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

• ....barcode alternate-text=labore

  • An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
• kind=amet
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".
• render-encoding=et
  • The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
• show-code-text.default-value kind=dolore
  • 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=sit

  • The UTF-8 encoded translated string.

• .. kind=sanctus

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

• .. type=ipsum

  • The type of barcode.

• value=eirmod

  • The value encoded in the barcode.

• .. class-id=vero

  • Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
• class-reference allow-multiple-users-per-object=false
  • 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=ipsum

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

  • No description provided.

• .... confirmation-code-label=et

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

  • The UTF-8 encoded translated string.

• .. kind=takimata

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

• ..custom-gate-label.default-value kind=duo

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

• value=clita

  • The UTF-8 encoded translated string.

• .. kind=sed

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

• ..custom-row-label.default-value kind=no

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

  • The UTF-8 encoded translated string.

• .. kind=clita

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

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

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=dolores
  • 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=sea

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

• ..custom-section-label.default-value kind=sanctus

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

• value=eirmod

  • The UTF-8 encoded translated string.

• .. kind=dolores

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

• ..date-time.custom-doors-open-label.default-value kind=aliquyam

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

  • The UTF-8 encoded translated string.

• .. kind=ea

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

• .. doors-open=magna

  • 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=rebum.
  • 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=amet
  • 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=sea
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventDateTime".

• start=sadipscing

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

  • 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=amet
  • 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=invidunt
  • 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=dolores

  • The UTF-8 encoded translated string.

• .. kind=diam

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

• ..fine-print.default-value kind=sanctus

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

  • The UTF-8 encoded translated string.

• .. kind=sit

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

• .. gate-label=et

  • 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=ea
  • 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=sadipscing

  • The UTF-8 encoded translated string.

• .. kind=diam

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

• .. kind=at

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

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

• .. uri=gubergren

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

• ... hex-background-color=eos

  • 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=dolore
  • 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=tempor
  • The ID associated with a uri. This field is here to enable ease of management of uris.
• kind=stet
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
• localized-description.default-value kind=accusam
  • 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=dolor

  • The UTF-8 encoded translated string.

• .. kind=diam

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

• .. uri=elitr

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

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

  • No description provided.

• .. issuer-name=lorem

  • Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
• kind=sit
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventTicketClass".
• localized-issuer-name.default-value kind=lorem
  • 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=diam

  • The UTF-8 encoded translated string.

• .. kind=diam

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

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

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

  • The UTF-8 encoded translated string.

• .. kind=dolores

  • 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=diam
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=ea
  • 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=dolore

  • The UTF-8 encoded translated string.

• .. kind=dolores

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

• .. uri=invidunt

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

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

  • 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=voluptua.

  • No description provided.

• .. review-status=et

  • 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=est
  • 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=stet
  • 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=dolor
  • 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=et

  • Type of animation.

• ..venue.address.default-value kind=labore

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

  • The UTF-8 encoded translated string.

• .. kind=aliquyam

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

• .. kind=ut

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventVenue".
• name.default-value kind=amet.
  • 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=est

  • The UTF-8 encoded translated string.

• .. kind=rebum.

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

• ... version=consetetur

  • Deprecated
• view-unlock-requirement=erat
  • View Unlock Requirement options for the event ticket.
• wide-logo.content-description.default-value kind=dolor
  • 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=kasd

  • The UTF-8 encoded translated string.

• .. kind=eirmod

  • 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=takimata
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=amet.
  • 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=labore

  • The UTF-8 encoded translated string.

• .. kind=sed

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

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

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

  • The UTF-8 encoded translated string.

• .. kind=voluptua.

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

• .. kind=justo

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
• source-uri description=amet.
  • Additional information about the image, which is unused and retained only for backward compatibility.
• localized-description.default-value kind=aliquyam
  • 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=gubergren

  • The UTF-8 encoded translated string.

• .. kind=sed

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

• .. uri=no

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

• .... disable-expiration-notification=false

  • Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
• face-value currency-code=est
  • The currency code, such as "USD" or "EUR."
• kind=elitr
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".

• micros=et

  • The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.

• ..grouping-info grouping-id=consetetur

  • Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.

• sort-index=74

  • Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.

• .. has-linked-device=false

  • Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
• has-users=true
  • Indicates if the object has users. This field is set by the platform.
• hero-image.content-description.default-value kind=amet.
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=aliquyam
  • 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=sanctus

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

• .. kind=duo

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

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

• .. uri=gubergren

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

• ... hex-background-color=accusam

  • 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.
• id=lorem
  • Required. The unique identifier for an object. This ID must be unique across all objects 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. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.

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

  • No description provided.

• .. kind=sea

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventTicketObject".
• linked-offer-ids=diam
  • A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
  • Each invocation of this argument appends the given value to the array.
• pass-constraints nfc-constraint=amet
  • The NFC constraints for the pass.
  • Each invocation of this argument appends the given value to the array.

• screenshot-eligibility=magna

  • The screenshot eligibility for the pass.

• ..reservation-info confirmation-code=accusam

  • The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.

• kind=lorem

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

• ..rotating-barcode alternate-text=tempor

  • An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
• initial-rotating-barcode-values period-millis=consetetur
  • Required. The amount of time each barcode is valid for.
• start-date-time=amet
  • Required. The date/time the first barcode is valid from. Barcodes will be rotated through using period_millis defined on the object's RotatingBarcodeValueInfo. This is an ISO 8601 extended format date/time, with 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.

• values=ipsum

  • Required. The values to encode in the barcode. At least one value is required.
  • Each invocation of this argument appends the given value to the array.

• .. render-encoding=et

  • The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
• show-code-text.default-value kind=elitr
  • 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=diam

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

• ..totp-details algorithm=et

  • The TOTP algorithm used to generate the OTP.

• period-millis=lorem

  • The time interval used for the TOTP value generation, in milliseconds.

• .. type=no

  • The type of this barcode.

• value-pattern=sea

  • String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.

• ..seat-info.gate.default-value kind=et

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

  • The UTF-8 encoded translated string.

• .. kind=ea

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

• .. kind=ipsum

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventSeat".
• row.default-value kind=eos
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=vero
  • 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=dolores

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

• ..seat.default-value kind=elitr

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

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

• ..section.default-value kind=magna

  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=duo
  • 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=no

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

• ... smart-tap-redemption-value=sadipscing

  • The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields enableSmartTap and redemptionIssuers must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
• state=sit
  • Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is moved to the "Expired passes" section.
• ticket-holder-name=duo
  • Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
• ticket-number=stet
  • The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).
• ticket-type.default-value kind=diam
  • Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language=accusam
  • Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

• value=dolore

  • The UTF-8 encoded translated string.

• .. kind=eirmod

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

• ..valid-time-interval.end date=lorem

  • An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). 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 date/time is intended for a physical location 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. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.

• .. kind=ut

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

• start date=est

  • An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). 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 date/time is intended for a physical location 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. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.

• ... version=sadipscing

  • Deprecated

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