REST Resource: opportunities

Resource: Opportunity

An Opportunity is a pending sale from a customer likely to purchase Google Cloud products or services. Once closed, an Opportunity is either won (results in an order) or lost.

JSON representation 
{
  "name": string,
  "customerDisplayName": string,
  "state": enum (State),
  "stateDescription": string,
  "stage": enum (Stage),
  "owner": string,
  "ownerEmail": string,
  "creationDate": {
    object (Date)
  },
  "creatorEmail": string,
  "source": enum (Source),
  "opportunityInfo": {
    object (OpportunityInfo)
  },
  "qualificationInfo": {
    object (QualificationInfo)
  },
  "customerInfo": {
    object (CustomerInfo)
  },
  "isvSolutionConnectInfo": {
    object (IsvSolutionConnectInfo)
  },
  "partnerInfo": {
    object (PartnerInfo)
  },
  "salesCycle": {
    object (SalesCycle)
  },
  "winLossInfo": {
    object (WinLossInfo)
  },
  "opportunityLines": [
    {
      object (OpportunityLine)
    }
  ],
  "opportunityTeamMembers": [
    {
      object (OpportunityTeamMember)
    }
  ],
  "customerContacts": [
    {
      object (CustomerContact)
    }
  ],
  "rebateExtensions": [
    {
      object (RebateExtension)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "referenceOpportunityId": string
}
Fields
name

string

Identifier. Resource name of an Opportunity in the form: opportunities/{opportunity_id}.
customerDisplayName

string

Output only. Customer display name that the Opportunity is associated with. This maps to the Vector Account name.
state

enum (State)

State the Opportunity is in. Client can only set the state to DRAFT or SUBMITTED. Default: DRAFT.
stateDescription

string

Output only. Contains the reason if the Opportunity was not accepted.
stage

enum (Stage)

The sales stage that the Opportunity is in. New Opportunities are created in Stage 0. Can only be updated after the Opportunity is ACCEPTED. Can't be updated to CLOSED.
owner

string

Output only. Name of the Google FSR who owns the Opportunity.
ownerEmail

string

Output only. Email of the Google FSR who owns the Opportunity.
creationDate
(deprecated)

object (Date)

Output only. Deprecated: use createTime instead. Date when the Opportunity was created.
creatorEmail

string

Output only. User email that created the Opportunity. If the Opportunity is created through an integrator, this will be the integrator's service account.
source

enum (Source)

Output only. Represents if the Opportunity was created by Google or by Partner.
opportunityInfo

object (OpportunityInfo)

Required. Information about the Opportunity provided during deal submission. Required for Creating an Opportunity.
qualificationInfo

object (QualificationInfo)

Required. Information that will be used to qualify the Opportunity for approval and incentive eligibility. Required for Creating an Opportunity.
customerInfo

object (CustomerInfo)

Required. Information of the end customer used for matching to an existing customer account or for creating a new one. Required for Creating an Opportunity. Can't be edited after the Opportunity is Accepted.
isvSolutionConnectInfo

object (IsvSolutionConnectInfo)

Optional. Optional information that can be provided for ISV deals during Create Opportunity. Can't be edited after the Opportunity is Accepted.
partnerInfo

object (PartnerInfo)

Optional. Opportunity information related to the sourcing Partner. Present only after the Opportunity is Accepted. Unset otherwise. Can be edited.
salesCycle

object (SalesCycle)

Optional. Information related to the Sales cycle. Present only after the Opportunity is Accepted. Unset otherwise. Can be edited.
winLossInfo

object (WinLossInfo)

Output only. Information related to the Sales cycle. Present only after the Opportunity is closed. Unset otherwise. Can't be edited.
opportunityLines[]

object (OpportunityLine)

Output only. Information about the Products added to the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
opportunityTeamMembers[]

object (OpportunityTeamMember)

Output only. Information on the Partner users with access to the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
customerContacts[]

object (CustomerContact)

Output only. List of Customer contacts for the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
rebateExtensions[]

object (RebateExtension)

Output only. Information about the rebate extensions requested on the Opportunity. Present only after the Opportunity is Accepted. Unset otherwise. Can't be edited.
createTime

string (Timestamp format)

Output only. Timestamp when the Opportunity was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Timestamp when the Opportunity was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
referenceOpportunityId

string

Output only. Opportunity ID in the Partner Advantage Portal. This ID is meant for mapping the Opportunities to the old system, and has a 1 to 1 mapping with the opportunities in this Service.

State

Represents the approval state of the Opportunity.

Enums
STATE_UNSPECIFIED Not used.
DRAFT Set this state if you are not ready to submit the Opportunity for Approval.
SUBMITTED Set this state to process the Approval.
ACCEPTED Can only be set by the system. Indicates that the Opportunity has been accepted.
NOT_ACCEPTED Can only be set by the system. Indicates that the Opportunity has not been accepted. Clients can edit the Opportunity and resubmit it for approval by setting the state back to SUBMITTED.

Stage

Represents the sales stages of an Opportunity.

Enums
STAGE_UNSPECIFIED Not used.
QUALIFY Stage 0 - Qualify.
REFINE Stage 1 - Refine.
TECH_EVAL_SOL_DEV Stage 2 - Tech evaluation and Solution Development.
PROPOSAL_NEGOTIATION Stage 3 - Proposal negotiation.
MIGRATION_IMPL Stage 4 - Migration or Implementation. Represents Closed/Won stage. Can only be set by the system.
CLOSED_LOST Closed lost. Can only be set by the system.
CLOSED_ADMIN Closed by Admin. Can only be set by the system.

Source

Represents the source for Oppty creation.

Enums
SOURCE_UNKNOWN Not used.
GOOGLE Created by Google sales rep.
GOOGLE_BDR Created by Google Business.
GOOGLE_PROGRAMMATIC Created by Google programmatically.
PARTNER If the Opportunity was created by Partner.

OpportunityInfo

Contains details about the Opportunity.

JSON representation 
{
  "partnerEntity": string,
  "indirectPartnerEntity": string,
  "displayName": string,
  "description": string,
  "productFamily": [
    enum (ProductFamily)
  ],
  "productCategory": [
    enum (ProductCategory)
  ],
  "confidential": boolean,
  "gcpWatermark": number,
  "opportunityAmount": {
    object (Money)
  }
}
Fields
partnerEntity

string

Required. Partner who sources the deal. In case of 2-tier Partners, this is the Distributor id. Format: partners/{id}
indirectPartnerEntity

string

Optional. If a 2-tier deal provide the Indirect Reseller involved. Format: partners/{id}
displayName

string

Optional. Display name for the Opportunity. Default name: {customerName}-{productCategory}
description

string

Optional. Opportunity description.
productFamily[]

enum (ProductFamily)

Optional. Product Family the Opportunity belongs to. For MVP, only 1 Product Family is supported. Required for ISV Solution Connect Opportunity. For Non-ISV Opportunities its derived from the Product Category.
productCategory[]

enum (ProductCategory)

Optional. Product Category the Opportunity belongs to. For MVP, only 1 Product Category is supported. Required for non-ISV Opportunities. For ISV Solution Connect, the Product Category should be empty. Can't be edited after the Opportunity is Accepted.
confidential

boolean

Optional. Flag to identify if the Opportunity is confidential and needs to have restricted access. Default: false.
gcpWatermark

number

Output only. GCP Watermark.
opportunityAmount

object (Money)

Output only. Total estimate for the Opportunity calculated based on the Opportunity Line items.

ProductFamily

Defines the high-level Product Family. Product Authorization is performed at this level.

Enums
PRODUCT_FAMILY_UNSPECIFIED Not used.
GOOGLE_CLOUD_PLATFORM Google Cloud Platform.
GOOGLE_WORKSPACE Google Workspace.
MAPS Maps.

ProductCategory

Defines the sub category under Product Family. For ISV Solution Connect, the Product Category should be PRODUCT_CATEGORY_UNSPECIFIED.

Enums
PRODUCT_CATEGORY_UNSPECIFIED Not used.
GOOGLE_GEMINI_AI Google Gemini AI.
GCP_AI GCP AI.
GCP_ANALYTICS GCP Analytics.
GCP_ANTHOS GCP Anthos.
GCP_APIGEE GCP Apigee.
GCP_APPSHEET GCP Appsheet.
GCP_COMPUTE GCP Compute.
GCP_DATABASES GCP Databases.
GCP_DISTRIBUTED_CLOUD GCP Distributed Cloud.
GCP_DUET_AI GCP Duet AI.
GCP_GPU GCP GPU.
GCP_LOOKER GCP Looker.
GCP_NETWORK GCP Network.
GCP_OTHER GCP Other.
GCP_OTHER_SECURITY GCP Other Security.
GCP_PLATFORM GCP Platform.
GCP_SCCE GCP SCCE.
GCP_SERVERLESS GCP Serverless.
GCP_STORAGE GCP Storage.
GCP_SUPPORT GCP Support.
GOOGLE_CLOUD_IDENTITY Google Cloud Identity.
GOOGLE_MAPS Google Maps.
GOOGLE_VAULT Google Vault.
GOOGLE_VOICE Google Voice.
GOOGLE_WORKSPACE_CORE Google Workspace Core.
GOOGLE_WORKSPACE_EDU Google Workspace Edu.

QualificationInfo

Qualification information for the Opportunity.

JSON representation 
{
  "dealNumber": string,
  "operationType": enum (OperationType),
  "contractLengthMonths": integer,
  "dealSize": {
    object (Money)
  },
  "estimatedCloseDate": {
    object (Date)
  },
  "publicSector": boolean,
  "budget": enum (Budget),
  "authority": enum (Authority),
  "need": enum (Need),
  "timeline": enum (Timeline),
  "campaignCode": string,
  "msspDeal": boolean,
  "legalLanguageAccepted": boolean,
  "decisionPhase": enum (DecisionPhase)
}
Fields
dealNumber

string

Output only. System generated unique deal identifier.
operationType

enum (OperationType)

Required. Transaction Operation type for which the Opportunity is being created.
contractLengthMonths

integer

Required. Contract terms in months.
dealSize

object (Money)

Required. Target budget/estimated cost. Can't be edited after the Opportunity is Accepted.
estimatedCloseDate

object (Date)

Required. Target deal close date in UTC. Can't be edited after the Opportunity is Accepted.
publicSector

boolean

Optional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can be edited after the Opportunity is Accepted. Default: false.
budget

enum (Budget)

Required. Budget. Can't be edited after the Opportunity is Accepted.
authority

enum (Authority)

Required. Authority. Can't be edited after the Opportunity is Accepted.
need

enum (Need)

Required. Need. Can't be edited after the Opportunity is Accepted.
timeline

enum (Timeline)

Required. Timeline. Can't be edited after the Opportunity is Accepted.
campaignCode

string

Optional. Valid campaign name for the selected customer's region and products. Ex: "CA-0072131 - 2023 H1 - PPF - Modernize SaaS apps onto GCP".
msspDeal

boolean

Optional. Flag to highlight if the partner will also act as MSSP (Managed Security Service Provided).
legalLanguageAccepted

boolean

Required. Is the legal_language accepted? Must be true for the Opportunity to be created. Can't be edited after the Opportunity is Accepted. T&C is listed here: https://docs.google.com/document/d/1UvQQtoZ6xiBCGoz0nJFNo-O80iR9faeHzQdWUfnEGTg/edit
decisionPhase

enum (DecisionPhase)

Required. Decision Phase.

OperationType

Transaction Operation type.

Enums
OPERATION_TYPE_UNSPECIFIED Not used.
NEW New.
RENEWAL Renewal.
ADD_ON Add-on.
EXPANSION Expansion - user increase or upgrade.

Budget

Budget.

Enums
BUDGET_UNSPECIFIED Not used.
BUDGET_EXISTS_NOT_SPECIFIED Budget exists, not specified.
CONFIRMED_NO_BUDGET Confirmed no budget.
EXACT_BUDGET_GIVEN Exact budget given.
REFUSE_TO_DISCLOSE Refuse to disclose.

Authority

Authority.

Enums
AUTHORITY_UNSPECIFIED Not used.
CONFIRMED_NO_AUTHORITY_DECIDED Confirmed no authority decided.
DONT_KNOW Don't know the authority.
CLEARLY_IDENTIFIED_PROCESS Clearly identified process.
VAGUE_UNDERSTANDING Vague understanding.

Need

Need.

Enums
NEED_UNSPECIFIED Not used.
CLEAR_NEED Clear need.
COMPELLING_NEED Compelling need.
NO_NEED No need.

Timeline

Timeline.

Enums
TIMELINE_UNSPECIFIED Not used.
CONFIRMED_NO_DECISION_DATE Confirmed no decision date.
REFUSED_TO_GIVE_DATE Refused to give date.
SPECIFIC_DECISION_DATES_GIVEN Specific decision dates given.
VAGUE_DECISION_DATES_GIVEN Vague decision dates given.

DecisionPhase

Decision Phase.

Enums
DECISION_PHASE_UNSPECIFIED Not used.
INFORMATION_GATHERING Initial research and information gathering
TRIAL_OR_PILOT Currently in-trial or looking to trial/pilot
FINAL_DECISION Final decision

CustomerInfo

Customer Information provided during Opportunity Creation

JSON representation 
{
  "customerDetails": {
    object (CustomerDetails)
  },
  "contact": {
    object (Contact)
  },
  "region": enum (Region)
}
Fields
customerDetails

object (CustomerDetails)

Required. Firm details needed for creating a new customer or for mapping to an existing customer.
contact

object (Contact)

Optional. Primary Customer contact that will be added to the Opportunity Contact Roles.
region

enum (Region)

Required. Geographical region where end customer is located Note: Partner needs to have Sell authorization in this region to qualify for deal registration incentives.

CustomerDetails

Customer details used to create a new customer or map to existing customers.

JSON representation 
{
  "organizationName": string,
  "domain": string,
  "address": {
    object (PostalAddress)
  },
  "industry": enum (Industry),
  "employeeCount": integer
}
Fields
organizationName

string

Required. Name of the Customer Organization.
domain

string

Required. Customer's primary website domain.
address

object (PostalAddress)

Required. Customer address.
industry

enum (Industry)

Required. Customer's Primary Industry.
employeeCount

integer

Required. Workforce size.

Industry

Industry.

Enums
INDUSTRY_UNSPECIFIED Not used.
ADVERTISING_MARKETING Advertising & Marketing.
AGRICULTURE Agriculture
AUTOMOTIVE Automotive.
BUSINESS_SERVICES Business & Professional Services.
CONSUMER_GOODS Consumer Packaged Goods.
EDUCATION Education.
ELECTRICAL_ELECTRONICS Electrical & Electronics.
ENERGY Energy & Utilities.
FINANCIAL_SERVICES Financial Services.
FOOD Food, Beverage & Restaurants.
GAMING Gaming.
HEALTHCARE Healthcare & Life Sciences.
INDUSTRIAL_GOODS Industrial Goods & Manufacturing.
GOVERNMENT Government.
LOGISTICS Logistics.
MANUFACTURING Manufacturing & Industrial.
MEDIA Media & Entertainment.
NON_PROFIT Non-Profit.
OTHER Other.
PUBLIC_SECTOR Public Sector & EDU.
RETAIL_CONSUMER Retail & Consumer.
RETAIL_WHOLESALE Retail & Wholesale.
SOFTWARE Software & Internet.
TELECOMMUNICATIONS Telecommunications.
TELECOMMUNICATIONS_MEDIA Telecommunications, Media & Gaming.
TOURISM Tourism & Leisure.
WEB3 Web3.
MANUFACTURING_INDUSTRIAL_TRANSPORTATION Manufacturing, Industrial & Transportation.

Contact

Contact Details

JSON representation 
{
  "givenName": string,
  "familyName": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
Fields
givenName

string

Required. Contact's First name.
familyName

string

Required. Contact's Last name.
email

string

Required. Email.
phone

object (PhoneNumber)

Optional. Phone number.

PhoneNumber

An object representing a phone number, suitable as an API wire format.

This representation:

  • should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123"

  • is not designed for efficient storage

  • may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose

To do something meaningful with this number, such as format it for various use-cases, convert it to an i18n.phonenumbers.PhoneNumber object first.

For instance, in Java this would be:

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

Reference(s): - https://github.com/google/libphonenumber

JSON representation 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
Fields
extension

string

The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.

Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
Union field kind. Required. Either a regular number, or a short code. New fields may be added to the oneof below in the future, so clients should ignore phone numbers for which none of the fields they coded against are set. kind can be only one of the following:
e164Number

string

The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".

The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed.

References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

A short code.

Reference(s): - https://en.wikipedia.org/wiki/Short_code

ShortCode

An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan.").

Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA).

JSON representation 
{
  "regionCode": string,
  "number": string
}
Fields
regionCode

string

Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB".

Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

Required. The short code digits, without a leading plus ('+') or country calling code. For example "611".

Region

Geographical region where end customer is located

Enums
REGION_UNSPECIFIED Default value. Does not display if there are no errors.
ANZ Australia & New Zealand
CEE Central & Eastern Europe
DACH Germany, Austria, & Switzerland
FRANCE France
GLOBAL

Global
INDIA India
JAPAN Japan
LATAM_BRAZIL LATAM - Brazil
LATAM_SPANISH_SPEAKING LATAM - Spanish speaking
NE Northern Europe
NORTH_AMERICA North America
OTHER_ASIA_PACIFIC Other Asia Pacific
SEEMEA Southern Europe and Emerging Markets
UK_AND_I UK & Ireland

IsvSolutionConnectInfo

Information about a ISV Solution Connect Deal.

JSON representation 
{
  "isvSolutionConnectDeal": boolean,
  "customerContactRequested": boolean,
  "supportLevel": enum (SupportLevel),
  "contractVehicle": enum (ContractVehicle),
  "deliveryModel": enum (DeliveryModel)
}
Fields
isvSolutionConnectDeal

boolean

Is the deal an ISV solution connect deal? Can't be edited after the Opportunity is Accepted. Default: false.
customerContactRequested

boolean

Has customer requested to be contacted? Can't be edited after the Opportunity is Accepted. Default: false.
supportLevel

enum (SupportLevel)

Support Level. Can't be edited after the Opportunity is Accepted.
contractVehicle

enum (ContractVehicle)

Contract Vehicle. Can't be edited after the Opportunity is Accepted.
deliveryModel

enum (DeliveryModel)

Delivery Model. Can't be edited after the Opportunity is Accepted.

SupportLevel

Support Level.

Enums
SUPPORT_LEVEL_UNSPECIFIED Not used.
OTHER_SUPPORT_LEVEL Other.
TECH Technical support.
TRANSACTION Transaction related support (POC/Google Cloud Marketplace/Procurement).
UPSELL_RENEW_CROSS_SELL Upselling/renewal/cross-selling support.
ALIGN_SALES_ACCOUNT Align sales/account strategy.
ALREADY_CONTACT Already in touch with Google Cloud sales.

ContractVehicle

Contract Vehicle.

Enums
CONTRACT_VEHICLE_UNSPECIFIED Not used.
CLOUD_MARKETPLACE Google Cloud Marketplace.
PARTNER_CONTRACT Partner contract.
UNKNOWN Not known at this time.

DeliveryModel

Delivery Model.

Enums
DELIVERY_MODEL_UNSPECIFIED Not used.
OTHER_DELIVERY_MODEL Other.
DATA_TO_CUSTOMER_BIGQUERY Data to customer BigQuery.
VM_ON_CUSTOMER_TENANCY VM on Customer Tenancy.
SAAS_ON_GOOGLE_CLOUD SaaS on Google Cloud.

PartnerInfo

Partner Information provided after the Opportunity is Accepted.

JSON representation 
{
  "incentiveEligibility": boolean,
  "incentiveType": enum (IncentiveType),
  "contractExpiryDate": {
    object (Date)
  },
  "rebateExpirationDate": {
    object (Date)
  },
  "distributor": string,
  "subBillingAccountId": string,
  "extensionsCount": integer,
  "gcpProjectNumbers": [
    string
  ],
  "submittedDate": {
    object (Date)
  },
  "approvedDate": {
    object (Date)
  },
  "submitTime": string,
  "approveTime": string
}
Fields
incentiveEligibility

boolean

Output only. Whether Partner is eligible for incentives for this Opportunity.
incentiveType

enum (IncentiveType)

Output only. Incentive type if the Opportunity is eligible for incentive: Deal Registration or Deal Referral.
contractExpiryDate

object (Date)

Contract expiration date. Date in UTC. Can be edited after the Opportunity is Accepted.
rebateExpirationDate

object (Date)

Output only. Rebate expiration date.
distributor

string

Distributor in case of 2-tier deals. Format: partners/{id}. Can be edited after the Opportunity is Accepted.
subBillingAccountId

string

Optional. Cloud Billing subaccount ID. Can be edited after the Opportunity is Accepted.
extensionsCount

integer

Output only. Number of extensions for rebate.
gcpProjectNumbers[]

string

Optional. Google Cloud project numbers. Can be edited after the Opportunity is Accepted. Can only be numeric values.
submittedDate
(deprecated)

object (Date)

Output only. Deprecated. Instead, use submitTime. Date when the Opportunity was last submitted.
approvedDate
(deprecated)

object (Date)

Output only. Deprecated. Instead, use approveTime. Date when the Opportunity was approved.
submitTime

string (Timestamp format)

Output only. Timestamp when the Opportunity was last submitted.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
approveTime

string (Timestamp format)

Output only. Timestamp when the Opportunity was approved.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

IncentiveType

Incentive Type.

Enums
INCENTIVE_TYPE_UNSPECIFIED Not used.
DEAL_REGISTRATION Deal Registration incentive.
DEAL_REFERRAL Deal Referral incentive.

SalesCycle

Information on the sales cycle.

JSON representation 
{
  "closeDate": {
    object (Date)
  },
  "partnerReadyToClose": enum (PartnerCloseStage),
  "closeDatePushCount": integer,
  "prmSiteDetails": string
}
Fields
closeDate

object (Date)

Output only. Date when the Opportunity is closed.
partnerReadyToClose

enum (PartnerCloseStage)

Partner ready to close info. Can be edited after the Opportunity is Accepted.
closeDatePushCount

integer

Output only. Number of times close date is pushed/changed.
prmSiteDetails

string

Output only. PRM site details.

PartnerCloseStage

Partner close stage

Enums
PARTNER_CLOSE_STAGE_UNSPECIFIED Not used.
MIGRATION_IMPL Stage 4 - Migration or Implementation. Represents Closed/Won stage.
CLOSED_LOST Closed lost. Can only be set by the system.

WinLossInfo

Win Loss Details.

JSON representation 
{
  "lostReason": string,
  "lostMainReason": string,
  "lostRejectedReasonDetails": string,
  "winMainReason": string,
  "wonReason": string,
  "winLossProducts": [
    string
  ],
  "winLossAdditionalContext": string
}
Fields
lostReason

string

Output only. Lost reason.
lostMainReason

string

Output only. Lost main reason.
lostRejectedReasonDetails

string

Output only. Lost rejected reason details.
winMainReason

string

Output only. Win main reason.
wonReason

string

Output only. Won reason.
winLossProducts[]

string

Output only. Win/loss products.
winLossAdditionalContext

string

Output only. Win/loss additional context.

OpportunityLine

Opportunity Line item.

JSON representation 
{
  "displayName": string,
  "quantity": integer,
  "salesPrice": {
    object (Money)
  },
  "listPrice": {
    object (Money)
  },
  "totalPrice": {
    object (Money)
  },
  "metric": string,
  "description": string
}
Fields
displayName

string

Output only. Product display name.
quantity

integer

Output only. Quantity.
salesPrice

object (Money)

Output only. Sales price.
listPrice

object (Money)

Output only. List price.
totalPrice

object (Money)

Output only. Total price of the line.
metric

string

Output only. Unit of measure.
description

string

Output only. Line item description.

OpportunityTeamMember

Opportunity Team Member.

JSON representation 
{
  "name": string,
  "email": string,
  "accessLevel": enum (AccessLevel)
}
Fields
name

string

Output only. Name.
email

string

Output only. Email.
accessLevel

enum (AccessLevel)

Output only. Access Level.

AccessLevel

Access Level.

Enums
ACCESS_LEVEL_UNSPECIFIED Not used.
VIEW_ONLY View only.
MODIFY Modify.

CustomerContact

Customer Contact.

JSON representation 
{
  "givenName": string,
  "familyName": string,
  "title": string,
  "role": enum (Role),
  "primary": boolean
}
Fields
givenName

string

Output only. Contact First Name.
familyName

string

Output only. Contact Last Name.
title

string

Output only. Contact Title.
role

enum (Role)

Output only. Contact Role.
primary

boolean

Output only. Is Primary contact for this Opportunity?

Role

Customer Contact Role.

Enums
ROLE_UNSPECIFIED Not used.
OTHER_ROLE Other role.
ADMIN Administrator.
BILLING_CONTACT Billing Contact.
BUSINESS_DECISION_MAKER Business Decision Maker.
BUSINESS_USER Business User.
CHANGE_CHAMPION Change Champion.
CHRONICLE_SIEM_CONTACT Chronicle SIEM Contact.
CHRONICLE_SOAR_CONTACT Chronicle SOAR Contact.
ECONOMIC_BUYER Economic Buyer.
EVALUATOR Evaluator.
EXECUTIVE_SPONSOR Executive Sponsor.
INFLUENCER Influencer.
MAIN_DECISION_MAKER Main Decision Maker.
ORDERING_CONTACT Ordering Contact.
PRODUCT_CONTACT Product Contact.
TECH_CONTACT Technical Contact.
TECH_DECISION_MAKER Technical Decision Maker.

RebateExtension

Rebate Extension.

JSON representation 
{
  "requestNumber": string,
  "extensionReason": enum (ExtensionReason),
  "extensionStatus": enum (ExtensionStatus),
  "extensionRejectionReason": enum (ExtensionRejectionReason),
  "comments": string
}
Fields
requestNumber

string

Output only. Extension Request number.
extensionReason

enum (ExtensionReason)

Output only. Extension Reason.
extensionStatus

enum (ExtensionStatus)

Output only. Extension Status.
extensionRejectionReason

enum (ExtensionRejectionReason)

Output only. Extension Rejection Reason.
comments

string

Output only. Comments.

ExtensionReason

Extension Reason.

Enums
EXTENSION_REASON_UNSPECIFIED Not used.
OTHER_EXTENSION_REASON Other.
CUSTOMER_ENGAGEMENT_DELAYED Customer Engagement Delayed.
PROOF_OF_CONCEPT_LONGER_THAN_EXPECTED Proof of Concept Longer Than Expected.
COMPLEX_DEAL Complex Deal

ExtensionStatus

Extension Status.

Enums
EXTENSION_STATUS_UNSPECIFIED Not used.
SUBMITTED Submitted.
APPROVED Approved.
REJECTED Rejected.

ExtensionRejectionReason

Extension Rejection Reason.

Enums
EXTENSION_REJECTION_REASON_UNSPECIFIED Not used.
OTHER_EXTENSION_REJECTION_REASON Other.
LACK_OF_PARTNER_ENGAGEMENT Lack of Partner Engagement.
NEGATIVE_CUSTOMER_FEEDBACK Negative Customer Feedback
PPS_REJECTION PPS Rejection.

Methods

create

 Creates a new Opportunity resource for a deal submission process.

get

 Returns the requested Opportunity resource.

patch

 Updates an existing Opportunity resource.

query

 Query Opportunitys associated with a specific Partner.