Method: sampleProjects.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the sample projects supported by the gactions CLI.
HTTP request
GET https://actions.googleapis.com/v2/sampleProjects
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of sample projects to return. The service may return fewer than this value. If unspecified, at most 1000 sample projects will be returned. Values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. A page token, received from a previous 'sampleProjects.list' call. Provide this to retrieve the subsequent page.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
RPC response for sampleProjects.list.
| JSON representation |
{
"sampleProjects": [
{
object (SampleProject)
}
],
"nextPageToken": string
} |
| Fields |
sampleProjects[] |
object (SampleProject)
The list of sample projects supported.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
SampleProject
Definition of sample project resource.
| JSON representation |
{
"name": string,
"hostedUrl": string,
"description": string
} |
| Fields |
name |
string
The name of the sample project. Format: sampleProjects/{sample_project}
|
hostedUrl |
string
The URL to the zip file where the sample is hosted.
|
description |
string
The description of the sample project.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThis document outlines the API for listing sample projects supported by the gactions CLI, using a GET request to the specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eUsers can paginate results by specifying \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters for managing result sets.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003esampleProjects\u003c/code\u003e, each containing a name, hosted URL for the project zip file, and a description.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSampleProjects\u003c/code\u003e are identified by a unique name in the format \u003ccode\u003esampleProjects/{sample_project}\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: sampleProjects.list\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.ListSampleProjectsResponse.SCHEMA_REPRESENTATION)\n- [SampleProject](#SampleProject)\n - [JSON representation](#SampleProject.SCHEMA_REPRESENTATION)\n\nLists all the sample projects supported by the gactions CLI.\n\n### HTTP request\n\n`GET https://actions.googleapis.com/v2/sampleProjects`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of sample projects to return. The service may return fewer than this value. If unspecified, at most 1000 sample projects will be returned. Values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. A page token, received from a previous 'sampleProjects.list' call. Provide this to retrieve the subsequent page. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nRPC response for sampleProjects.list.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"sampleProjects\": [ { object (/assistant/actions/api/reference/rest/v2/sampleProjects/list#SampleProject) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sampleProjects[]` | `object (`[SampleProject](/assistant/actions/api/reference/rest/v2/sampleProjects/list#SampleProject)`)` The list of sample projects supported. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\nSampleProject\n-------------\n\nDefinition of sample project resource.\n\n| JSON representation ||\n|------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"hostedUrl\": string, \"description\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------|\n| `name` | `string` The name of the sample project. Format: `sampleProjects/{sample_project}` |\n| `hostedUrl` | `string` The URL to the zip file where the sample is hosted. |\n| `description` | `string` The description of the sample project. |"]]
