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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-19 UTC."],[[["\u003cp\u003eThis API allows you to query a list of Opportunities associated with a specific Partner ID, using the \u003ccode\u003eopportunities:query\u003c/code\u003e endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe required parameter for this request is the \u003ccode\u003epartner\u003c/code\u003e ID, while optional parameters such as \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e are available to refine the query and control the results.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request must use the \u003ccode\u003eGET\u003c/code\u003e method and the provided URL, with an empty request body and query parameters to specify the partner and filter the results.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of \u003ccode\u003eOpportunity\u003c/code\u003e objects, a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and the \u003ccode\u003etotalSize\u003c/code\u003e of opportunities matching the applied filter, all represented in a specific JSON format.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, the request must be authenticated with the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/apps.order\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: opportunities.query\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.QueryOpportunitiesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nQuery [Opportunity](/channel/docs/reference/rest/v1alpha1/opportunities#Opportunity)s associated with a specific Partner.\n\nPossible error codes:\n\n- PERMISSION_DENIED: The user making the request isn't allowed to list opportunities associated with the given partner.\n- INVALID_ARGUMENT: Required request parameters are missing or invalid.\n\nReturn value: [Opportunity](/channel/docs/reference/rest/v1alpha1/opportunities#Opportunity)s the user has access to, or an empty list if there are no opportunities.\n\n### HTTP request\n\n`GET https://cloudchannel.googleapis.com/v1alpha1/opportunities:query`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for [CloudChannelService.QueryOpportunities](/channel/docs/reference/rest/v1alpha1/opportunities/query#google.cloud.channel.v1alpha1.CloudChannelService.QueryOpportunities)\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
