Class: Google::Cloud::Retail::V2::BigQuerySource

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::BigQuerySource

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/import_config.rb

Overview

BigQuery source import data from.

Instance Attribute Summary

• #data_schema ⇒ ::String

  The schema to use when parsing the data from the source.

• #dataset_id ⇒ ::String

  Required.

• #gcs_staging_dir ⇒ ::String

  Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.

• #partition_date ⇒ ::Google::Type::Date

  BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

• #project_id ⇒ ::String

  The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters.

• #table_id ⇒ ::String

  Required.

Instance Attribute Details

#data_schema ⇒ ::String

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

Returns:

• (::String) —

  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.

# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 121

class BigQuerySource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dataset_id ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 121

class BigQuerySource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#gcs_staging_dir ⇒ ::String

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

Returns:

• (::String) —

  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.

# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 121

class BigQuerySource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#partition_date ⇒ ::Google::Type::Date

Returns BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

Only supported in ImportProductsRequest.

Returns:

• (::Google::Type::Date) —

  BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

  Only supported in ImportProductsRequest.

# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 121

class BigQuerySource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#project_id ⇒ ::String

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

Returns:

• (::String) —

  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.

# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 121

class BigQuerySource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#table_id ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 121

class BigQuerySource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end