Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.

Scopes

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: retail2 --scope <scope> projects locations-catalogs-user-events-import ...

Required Scalar Argument

  • <parent> (string)
    • Required. projects/1234/locations/global/catalogs/default_catalog

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:

GoogleCloudRetailV2ImportUserEventsRequest:
  errors-config:
    gcs-prefix: string
  input-config:
    big-query-source:
      data-schema: string
      dataset-id: string
      gcs-staging-dir: string
      partition-date:
        day: integer
        month: integer
        year: integer
      project-id: string
      table-id: string
    gcs-source:
      data-schema: string
      input-uris: [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 .errors-config gcs-prefix=ipsum

    • Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded google.rpc.Status message.

  • ..input-config.big-query-source data-schema=eirmod

    • The schema to use when parsing the data from the source. Supported values for product imports: * product (default): One JSON Product per line. Each product must have a valid Product.id. * product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports: * user_event (default): One JSON UserEvent per line. * user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719. * user_event_ga4: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * suggestions (default): One JSON completion suggestion per line. * denylist: One JSON deny suggestion per line. * allowlist: One JSON allow suggestion per line.
  • dataset-id=vero
    • Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
  • gcs-staging-dir=voluptua.
    • Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
  • partition-date day=91
    • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  • month=46
    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • year=91

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  • .. project-id=et

    • The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

  • table-id=gubergren

    • Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.

  • ..gcs-source data-schema=dolore

    • The schema to use when parsing the data from the source. Supported values for product imports: * product (default): One JSON Product per line. Each product must have a valid Product.id. * product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports: * user_event (default): One JSON UserEvent per line. * user_event_ga360: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * control (default): One JSON Control per line. Supported values for catalog attribute imports: * catalog_attribute (default): One CSV CatalogAttribute per line.
  • input-uris=ea
    • Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See Importing product information for the expected file format and setup instructions.
    • Each invocation of this argument appends the given value to the array.

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