Query Opportunity
s associated with a specific Partner.
Possible error codes:
- PERMISSION_DENIED: The user making the request isn't allowed to list opportunities associated with the given partner.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: Opportunity
s the user has access to, or an empty list if there are no opportunities.
HTTP request
GET https://cloudchannel.googleapis.com/v1alpha1/opportunities:query
The URL uses gRPC Transcoding syntax.
Query parameters
partner
string
Required. Provide the Partner ID for which the Opportunities are being queried. Format: partner = partners/{id}
pageSize
integer
Optional. The maximum number of opportunities to return. The service might return fewer than this value. If unspecified, at most 50 opportunities are returned. The maximum value is 100; values above 100 are coerced to 100.
pageToken
string
Optional. A page token, received from a previous opportunities.query
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to opportunities.query
must match the call that provided the page token.
filter
string
Optional. Filters on the Opportunity
. Currently supports filtering on the following fields:
-
state -
stage -
partnerInfo.rebate_expiration_date -
salesCycle.close_date -
source -
customerDisplayName -
partnerInfo.incentive_eligibility, -
qualificationInfo.campaign_code -
updateTime
For information on the filter format, see https://google.aip.dev/160 .
orderBy
string
Optional. Sort order of the Opportunity
. Currently supports sorting on the following fields:
-
state -
stage -
partnerInfo.rebate_expiration_date -
salesCycle.close_date -
source -
opportunityInfo.display_name -
customerDisplayName -
opportunityInfo.product_category -
updateTime
For information on the sort format, see https://google.aip.dev/132#ordering .
Request body
The request body must be empty.
Response body
Response message for CloudChannelService.QueryOpportunities
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"opportunities"
:
[
{
object (
|
| Fields | |
|---|---|
opportunities[]
|
The opportunities for the specified partner. |
nextPageToken
|
A token, which can be sent as |
totalSize
|
Total Number of Opportunties for the given filter. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/apps.order
For more information, see the Authentication Overview .
