Class: Google::Cloud::ContactCenterInsights::V1::Dimension

Inherits:

Object

• Object
• Google::Cloud::ContactCenterInsights::V1::Dimension

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb

Overview

A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses.

Defined Under Namespace

Modules: DimensionKey Classes: AgentDimensionMetadata, IssueDimensionMetadata, QaQuestionAnswerDimensionMetadata, QaQuestionDimensionMetadata

Instance Attribute Summary

• #agent_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::AgentDimensionMetadata readonly

  Output only.

• #dimension_key ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::DimensionKey

  The key of the dimension.

• #issue_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::IssueDimensionMetadata readonly

  Output only.

• #qa_question_answer_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionAnswerDimensionMetadata readonly

  Output only.

• #qa_question_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionDimensionMetadata readonly

  Output only.

Instance Attribute Details

#agent_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::AgentDimensionMetadata (readonly)

Returns Output only. Metadata about the agent dimension.

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::Dimension::AgentDimensionMetadata) —

  Output only. Metadata about the agent dimension.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1376

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

  # Metadata about the issue dimension.
  # @!attribute [rw] issue_id
  #   @return [::String]
  #     The issue ID.
  # @!attribute [rw] issue_display_name
  #   @return [::String]
  #     The issue display name.
  # @!attribute [rw] issue_model_id
  #   @return [::String]
  #     The parent issue model ID.
  class IssueDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the agent dimension.
  # @!attribute [rw] agent_id
  #   @return [::String]
  #     Optional. A user-specified string representing the agent.
  # @!attribute [rw] agent_display_name
  #   @return [::String]
  #     Optional. The agent's name
  # @!attribute [rw] agent_team
  #   @return [::String]
  #     Optional. A user-specified string representing the agent's team.
  class AgentDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question dimension.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question-answer dimension.
  # This is useful for showing the answer distribution for questions for a
  # given scorecard.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  # @!attribute [rw] answer_value
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionAnswerDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The key of the dimension.
  module DimensionKey
    # The key of the dimension is unspecified.
    DIMENSION_KEY_UNSPECIFIED = 0

    # The dimension is keyed by issues.
    ISSUE = 1

    # The dimension is keyed by agents.
    AGENT = 2

    # The dimension is keyed by agent teams.
    AGENT_TEAM = 3

    # The dimension is keyed by QaQuestionIds.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing stats for
    # the same question across different scorecard revisions.
    QA_QUESTION_ID = 4

    # The dimension is keyed by QaQuestionIds-Answer value pairs.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing
    # distribution of answers per question across different scorecard
    # revisions.
    QA_QUESTION_ANSWER_VALUE = 5

    # The dimension is keyed by the conversation profile ID.
    CONVERSATION_PROFILE_ID = 6
  end
end

#dimension_key ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::DimensionKey

Returns The key of the dimension.

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::Dimension::DimensionKey) —

  The key of the dimension.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1376

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

  # Metadata about the issue dimension.
  # @!attribute [rw] issue_id
  #   @return [::String]
  #     The issue ID.
  # @!attribute [rw] issue_display_name
  #   @return [::String]
  #     The issue display name.
  # @!attribute [rw] issue_model_id
  #   @return [::String]
  #     The parent issue model ID.
  class IssueDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the agent dimension.
  # @!attribute [rw] agent_id
  #   @return [::String]
  #     Optional. A user-specified string representing the agent.
  # @!attribute [rw] agent_display_name
  #   @return [::String]
  #     Optional. The agent's name
  # @!attribute [rw] agent_team
  #   @return [::String]
  #     Optional. A user-specified string representing the agent's team.
  class AgentDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question dimension.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question-answer dimension.
  # This is useful for showing the answer distribution for questions for a
  # given scorecard.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  # @!attribute [rw] answer_value
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionAnswerDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The key of the dimension.
  module DimensionKey
    # The key of the dimension is unspecified.
    DIMENSION_KEY_UNSPECIFIED = 0

    # The dimension is keyed by issues.
    ISSUE = 1

    # The dimension is keyed by agents.
    AGENT = 2

    # The dimension is keyed by agent teams.
    AGENT_TEAM = 3

    # The dimension is keyed by QaQuestionIds.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing stats for
    # the same question across different scorecard revisions.
    QA_QUESTION_ID = 4

    # The dimension is keyed by QaQuestionIds-Answer value pairs.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing
    # distribution of answers per question across different scorecard
    # revisions.
    QA_QUESTION_ANSWER_VALUE = 5

    # The dimension is keyed by the conversation profile ID.
    CONVERSATION_PROFILE_ID = 6
  end
end

#issue_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::IssueDimensionMetadata (readonly)

Returns Output only. Metadata about the issue dimension.

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::Dimension::IssueDimensionMetadata) —

  Output only. Metadata about the issue dimension.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1376

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

  # Metadata about the issue dimension.
  # @!attribute [rw] issue_id
  #   @return [::String]
  #     The issue ID.
  # @!attribute [rw] issue_display_name
  #   @return [::String]
  #     The issue display name.
  # @!attribute [rw] issue_model_id
  #   @return [::String]
  #     The parent issue model ID.
  class IssueDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the agent dimension.
  # @!attribute [rw] agent_id
  #   @return [::String]
  #     Optional. A user-specified string representing the agent.
  # @!attribute [rw] agent_display_name
  #   @return [::String]
  #     Optional. The agent's name
  # @!attribute [rw] agent_team
  #   @return [::String]
  #     Optional. A user-specified string representing the agent's team.
  class AgentDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question dimension.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question-answer dimension.
  # This is useful for showing the answer distribution for questions for a
  # given scorecard.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  # @!attribute [rw] answer_value
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionAnswerDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The key of the dimension.
  module DimensionKey
    # The key of the dimension is unspecified.
    DIMENSION_KEY_UNSPECIFIED = 0

    # The dimension is keyed by issues.
    ISSUE = 1

    # The dimension is keyed by agents.
    AGENT = 2

    # The dimension is keyed by agent teams.
    AGENT_TEAM = 3

    # The dimension is keyed by QaQuestionIds.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing stats for
    # the same question across different scorecard revisions.
    QA_QUESTION_ID = 4

    # The dimension is keyed by QaQuestionIds-Answer value pairs.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing
    # distribution of answers per question across different scorecard
    # revisions.
    QA_QUESTION_ANSWER_VALUE = 5

    # The dimension is keyed by the conversation profile ID.
    CONVERSATION_PROFILE_ID = 6
  end
end

#qa_question_answer_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionAnswerDimensionMetadata (readonly)

Returns Output only. Metadata about the QA question-answer dimension.

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionAnswerDimensionMetadata) —

  Output only. Metadata about the QA question-answer dimension.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1376

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

  # Metadata about the issue dimension.
  # @!attribute [rw] issue_id
  #   @return [::String]
  #     The issue ID.
  # @!attribute [rw] issue_display_name
  #   @return [::String]
  #     The issue display name.
  # @!attribute [rw] issue_model_id
  #   @return [::String]
  #     The parent issue model ID.
  class IssueDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the agent dimension.
  # @!attribute [rw] agent_id
  #   @return [::String]
  #     Optional. A user-specified string representing the agent.
  # @!attribute [rw] agent_display_name
  #   @return [::String]
  #     Optional. The agent's name
  # @!attribute [rw] agent_team
  #   @return [::String]
  #     Optional. A user-specified string representing the agent's team.
  class AgentDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question dimension.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question-answer dimension.
  # This is useful for showing the answer distribution for questions for a
  # given scorecard.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  # @!attribute [rw] answer_value
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionAnswerDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The key of the dimension.
  module DimensionKey
    # The key of the dimension is unspecified.
    DIMENSION_KEY_UNSPECIFIED = 0

    # The dimension is keyed by issues.
    ISSUE = 1

    # The dimension is keyed by agents.
    AGENT = 2

    # The dimension is keyed by agent teams.
    AGENT_TEAM = 3

    # The dimension is keyed by QaQuestionIds.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing stats for
    # the same question across different scorecard revisions.
    QA_QUESTION_ID = 4

    # The dimension is keyed by QaQuestionIds-Answer value pairs.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing
    # distribution of answers per question across different scorecard
    # revisions.
    QA_QUESTION_ANSWER_VALUE = 5

    # The dimension is keyed by the conversation profile ID.
    CONVERSATION_PROFILE_ID = 6
  end
end

#qa_question_dimension_metadata ⇒ ::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionDimensionMetadata (readonly)

Returns Output only. Metadata about the QA question dimension.

Returns:

• (::Google::Cloud::ContactCenterInsights::V1::Dimension::QaQuestionDimensionMetadata) —

  Output only. Metadata about the QA question dimension.

# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1376

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

  # Metadata about the issue dimension.
  # @!attribute [rw] issue_id
  #   @return [::String]
  #     The issue ID.
  # @!attribute [rw] issue_display_name
  #   @return [::String]
  #     The issue display name.
  # @!attribute [rw] issue_model_id
  #   @return [::String]
  #     The parent issue model ID.
  class IssueDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the agent dimension.
  # @!attribute [rw] agent_id
  #   @return [::String]
  #     Optional. A user-specified string representing the agent.
  # @!attribute [rw] agent_display_name
  #   @return [::String]
  #     Optional. The agent's name
  # @!attribute [rw] agent_team
  #   @return [::String]
  #     Optional. A user-specified string representing the agent's team.
  class AgentDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question dimension.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Metadata about the QA question-answer dimension.
  # This is useful for showing the answer distribution for questions for a
  # given scorecard.
  # @!attribute [rw] qa_scorecard_id
  #   @return [::String]
  #     Optional. The QA scorecard ID.
  # @!attribute [rw] qa_question_id
  #   @return [::String]
  #     Optional. The QA question ID.
  # @!attribute [rw] question_body
  #   @return [::String]
  #     Optional. The full body of the question.
  # @!attribute [rw] answer_value
  #   @return [::String]
  #     Optional. The full body of the question.
  class QaQuestionAnswerDimensionMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The key of the dimension.
  module DimensionKey
    # The key of the dimension is unspecified.
    DIMENSION_KEY_UNSPECIFIED = 0

    # The dimension is keyed by issues.
    ISSUE = 1

    # The dimension is keyed by agents.
    AGENT = 2

    # The dimension is keyed by agent teams.
    AGENT_TEAM = 3

    # The dimension is keyed by QaQuestionIds.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing stats for
    # the same question across different scorecard revisions.
    QA_QUESTION_ID = 4

    # The dimension is keyed by QaQuestionIds-Answer value pairs.
    # Note that: We only group by the QuestionId and not the revision-id of the
    # scorecard this question is a part of. This allows for showing
    # distribution of answers per question across different scorecard
    # revisions.
    QA_QUESTION_ANSWER_VALUE = 5

    # The dimension is keyed by the conversation profile ID.
    CONVERSATION_PROFILE_ID = 6
  end
end