Method: projects.locations.collections.search

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

string

Required. The parent, which owns the collections. Format: projects/{projectNumber}/locations/{location}. It takes the form projects/{project}/locations/{location}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "query": {
    object (CollectionQuery)
  },
  "pageSize": integer,
  "pageToken": string
}
Fields
query

object (CollectionQuery)

Query used to search against collections.
pageSize

integer

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

string

The token specifying the current offset within search results. See SearchCollectionsResponse.next_page_token for an explanation of how to obtain the next set of query results.

Response body

If successful, the response body contains data with the following structure:

Response message for CollectionService.SearchCollections.

JSON representation 
{
  "matchingCollections": [
    {
      object (MatchingCollection)
    }
  ],
  "nextPageToken": string
}
Fields
matchingCollections[]

object (MatchingCollection)

The collection entities that match the specified SearchCollectionsRequest.
nextPageToken

string

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 (Collection)
  }
}
Fields
collection

object (Collection)

Collection that matches the specified SearchCollectionsRequest.