Class: Google::Shopping::Merchant::Promotions::V1::PromotionStatus

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb

Overview

The status of the promotion.

Defined Under Namespace

Classes: DestinationStatus, ItemLevelIssue

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Date on which the promotion has been created in ISO 8601 format: Date, time, and offset, for example 2020-01-02T09:00:00+01:00 or 2020-01-02T09:00:00Z.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Date on which the promotion has been created in ISO 8601 format: Date, time, and offset, for example 2020-01-02T09:00:00+01:00 or 2020-01-02T09:00:00Z



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 245

class PromotionStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status for the specified destination.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The name of the promotion destination.
  # @!attribute [r] status
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::DestinationStatus::State]
  #     Output only. The status for the specified destination.
  class DestinationStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current state of the promotion.
    module State
      # Unknown promotion state.
      STATE_UNSPECIFIED = 0

      # The promotion is under review.
      IN_REVIEW = 1

      # The promotion is disapproved.
      REJECTED = 2

      # The promotion is approved and active.
      LIVE = 3

      # The promotion is stopped by merchant.
      STOPPED = 4

      # The promotion is no longer active.
      EXPIRED = 5

      # The promotion is not stopped, and all reviews are approved, but the
      # active date is in the future.
      PENDING = 6
    end
  end

  # The issue associated with the promotion.
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The error code of the issue.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::ItemLevelIssue::Severity]
  #     Output only. How this issue affects serving of the promotion.
  # @!attribute [r] resolution
  #   @return [::String]
  #     Output only. Whether the issue can be resolved by the merchant.
  # @!attribute [r] attribute
  #   @return [::String]
  #     Output only. The attribute's name, if the issue is caused by a single
  #     attribute.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The destination the issue applies to.
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. A short issue description in English.
  # @!attribute [r] detail
  #   @return [::String]
  #     Output only. A detailed issue description in English.
  # @!attribute [r] documentation
  #   @return [::String]
  #     Output only. The URL of a web page to help with resolving this issue.
  # @!attribute [r] applicable_countries
  #   @return [::Array<::String>]
  #     Output only. List of country codes (ISO 3166-1 alpha-2) where issue
  #     applies to the offer.
  class ItemLevelIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Not specified.
      SEVERITY_UNSPECIFIED = 0

      # This issue represents a warning and does not have a direct affect
      # on the promotion.
      NOT_IMPACTED = 1

      # The promotion is demoted and most likely have limited performance
      # in search results
      DEMOTED = 2

      # Issue disapproves the promotion.
      DISAPPROVED = 3
    end
  end
end

#destination_statuses ⇒ ::Array<::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::DestinationStatus> (readonly)

Returns Output only. The intended destinations for the promotion.

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 245

class PromotionStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status for the specified destination.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The name of the promotion destination.
  # @!attribute [r] status
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::DestinationStatus::State]
  #     Output only. The status for the specified destination.
  class DestinationStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current state of the promotion.
    module State
      # Unknown promotion state.
      STATE_UNSPECIFIED = 0

      # The promotion is under review.
      IN_REVIEW = 1

      # The promotion is disapproved.
      REJECTED = 2

      # The promotion is approved and active.
      LIVE = 3

      # The promotion is stopped by merchant.
      STOPPED = 4

      # The promotion is no longer active.
      EXPIRED = 5

      # The promotion is not stopped, and all reviews are approved, but the
      # active date is in the future.
      PENDING = 6
    end
  end

  # The issue associated with the promotion.
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The error code of the issue.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::ItemLevelIssue::Severity]
  #     Output only. How this issue affects serving of the promotion.
  # @!attribute [r] resolution
  #   @return [::String]
  #     Output only. Whether the issue can be resolved by the merchant.
  # @!attribute [r] attribute
  #   @return [::String]
  #     Output only. The attribute's name, if the issue is caused by a single
  #     attribute.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The destination the issue applies to.
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. A short issue description in English.
  # @!attribute [r] detail
  #   @return [::String]
  #     Output only. A detailed issue description in English.
  # @!attribute [r] documentation
  #   @return [::String]
  #     Output only. The URL of a web page to help with resolving this issue.
  # @!attribute [r] applicable_countries
  #   @return [::Array<::String>]
  #     Output only. List of country codes (ISO 3166-1 alpha-2) where issue
  #     applies to the offer.
  class ItemLevelIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Not specified.
      SEVERITY_UNSPECIFIED = 0

      # This issue represents a warning and does not have a direct affect
      # on the promotion.
      NOT_IMPACTED = 1

      # The promotion is demoted and most likely have limited performance
      # in search results
      DEMOTED = 2

      # Issue disapproves the promotion.
      DISAPPROVED = 3
    end
  end
end

#item_level_issues ⇒ ::Array<::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::ItemLevelIssue> (readonly)

Returns Output only. A list of issues associated with the promotion.

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 245

class PromotionStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status for the specified destination.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The name of the promotion destination.
  # @!attribute [r] status
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::DestinationStatus::State]
  #     Output only. The status for the specified destination.
  class DestinationStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current state of the promotion.
    module State
      # Unknown promotion state.
      STATE_UNSPECIFIED = 0

      # The promotion is under review.
      IN_REVIEW = 1

      # The promotion is disapproved.
      REJECTED = 2

      # The promotion is approved and active.
      LIVE = 3

      # The promotion is stopped by merchant.
      STOPPED = 4

      # The promotion is no longer active.
      EXPIRED = 5

      # The promotion is not stopped, and all reviews are approved, but the
      # active date is in the future.
      PENDING = 6
    end
  end

  # The issue associated with the promotion.
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The error code of the issue.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::ItemLevelIssue::Severity]
  #     Output only. How this issue affects serving of the promotion.
  # @!attribute [r] resolution
  #   @return [::String]
  #     Output only. Whether the issue can be resolved by the merchant.
  # @!attribute [r] attribute
  #   @return [::String]
  #     Output only. The attribute's name, if the issue is caused by a single
  #     attribute.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The destination the issue applies to.
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. A short issue description in English.
  # @!attribute [r] detail
  #   @return [::String]
  #     Output only. A detailed issue description in English.
  # @!attribute [r] documentation
  #   @return [::String]
  #     Output only. The URL of a web page to help with resolving this issue.
  # @!attribute [r] applicable_countries
  #   @return [::Array<::String>]
  #     Output only. List of country codes (ISO 3166-1 alpha-2) where issue
  #     applies to the offer.
  class ItemLevelIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Not specified.
      SEVERITY_UNSPECIFIED = 0

      # This issue represents a warning and does not have a direct affect
      # on the promotion.
      NOT_IMPACTED = 1

      # The promotion is demoted and most likely have limited performance
      # in search results
      DEMOTED = 2

      # Issue disapproves the promotion.
      DISAPPROVED = 3
    end
  end
end

#last_update_date ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Date on which the promotion status has been last updated in ISO 8601 format: Date, time, and offset, for example 2020-01-02T09:00:00+01:00 or 2020-01-02T09:00:00Z.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Date on which the promotion status has been last updated in ISO 8601 format: Date, time, and offset, for example 2020-01-02T09:00:00+01:00 or 2020-01-02T09:00:00Z



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'proto_docs/google/shopping/merchant/promotions/v1/promotions_common.rb', line 245

class PromotionStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status for the specified destination.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The name of the promotion destination.
  # @!attribute [r] status
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::DestinationStatus::State]
  #     Output only. The status for the specified destination.
  class DestinationStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The current state of the promotion.
    module State
      # Unknown promotion state.
      STATE_UNSPECIFIED = 0

      # The promotion is under review.
      IN_REVIEW = 1

      # The promotion is disapproved.
      REJECTED = 2

      # The promotion is approved and active.
      LIVE = 3

      # The promotion is stopped by merchant.
      STOPPED = 4

      # The promotion is no longer active.
      EXPIRED = 5

      # The promotion is not stopped, and all reviews are approved, but the
      # active date is in the future.
      PENDING = 6
    end
  end

  # The issue associated with the promotion.
  # @!attribute [r] code
  #   @return [::String]
  #     Output only. The error code of the issue.
  # @!attribute [r] severity
  #   @return [::Google::Shopping::Merchant::Promotions::V1::PromotionStatus::ItemLevelIssue::Severity]
  #     Output only. How this issue affects serving of the promotion.
  # @!attribute [r] resolution
  #   @return [::String]
  #     Output only. Whether the issue can be resolved by the merchant.
  # @!attribute [r] attribute
  #   @return [::String]
  #     Output only. The attribute's name, if the issue is caused by a single
  #     attribute.
  # @!attribute [r] reporting_context
  #   @return [::Google::Shopping::Type::ReportingContext::ReportingContextEnum]
  #     Output only. The destination the issue applies to.
  # @!attribute [r] description
  #   @return [::String]
  #     Output only. A short issue description in English.
  # @!attribute [r] detail
  #   @return [::String]
  #     Output only. A detailed issue description in English.
  # @!attribute [r] documentation
  #   @return [::String]
  #     Output only. The URL of a web page to help with resolving this issue.
  # @!attribute [r] applicable_countries
  #   @return [::Array<::String>]
  #     Output only. List of country codes (ISO 3166-1 alpha-2) where issue
  #     applies to the offer.
  class ItemLevelIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The severity of the issue.
    module Severity
      # Not specified.
      SEVERITY_UNSPECIFIED = 0

      # This issue represents a warning and does not have a direct affect
      # on the promotion.
      NOT_IMPACTED = 1

      # The promotion is demoted and most likely have limited performance
      # in search results
      DEMOTED = 2

      # Issue disapproves the promotion.
      DISAPPROVED = 3
    end
  end
end