Searches for collections using provided SearchCollectionsRequest
. This call only returns collections that the caller has permission to search against.
HTTP request
POST https://contentwarehouse.googleapis.com/v1/{parent}/collections:search
Path parameters
Parameters | |
---|---|
parent |
Required. The parent, which owns the collections. Format: projects/{projectNumber}/locations/{location}. It takes the form |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"query": {
object ( |
Fields | |
---|---|
query |
Query used to search against collections. |
pageSize |
A limit on the number of collections returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. |
pageToken |
The token specifying the current offset within search results. See |
Response body
If successful, the response body contains data with the following structure:
Response message for CollectionService.SearchCollections.
JSON representation |
---|
{
"matchingCollections": [
{
object ( |
Fields | |
---|---|
matchingCollections[] |
The collection entities that match the specified |
nextPageToken |
The token that specifies the starting position of the next page of results. This field is empty if there are no more results. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
contentwarehouse.collections.get
For more information, see the IAM documentation.
CollectionQuery
The query string that matches against the collections.
MatchingCollection
Collection entry with metadata inside SearchCollectionsResponse
JSON representation |
---|
{
"collection": {
object ( |
Fields | |
---|---|
collection |
Collection that matches the specified |