Reference documentation and code samples for the Google API Common Protos Client class Page.
Represents a documentation page. A page can contain subpages to represent
nested documentation set structure.
Generated from protobuf messagegoogle.api.Page
Namespace
Google \ Api
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with.) can be used as reference to the page in your documentation. For example:
pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)
You can referenceJavapage using Markdown reference link syntax:<xref uid="\\Tutorial\Java">Java</xref>.
↳ content
string
The Markdown content of the page. You can use(== include {path} ==)to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
getName
The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with.) can be used as reference to the page in your
documentation. For example:
pages:
- name: Tutorial
content: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
You can referenceJavapage using Markdown reference link syntax:<xref uid="\\Tutorial\Java">Java</xref>.
Returns
Type
Description
string
setName
The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with.) can be used as reference to the page in your
documentation. For example:
pages:
- name: Tutorial
content: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
You can referenceJavapage using Markdown reference link syntax:<xref uid="\\Tutorial\Java">Java</xref>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getContent
The Markdown content of the page. You can use(== include {path}
==)to include content from a Markdown file. The content can be used
to produce the documentation page such as HTML format page.
Returns
Type
Description
string
setContent
The Markdown content of the page. You can use(== include {path}
==)to include content from a Markdown file. The content can be used
to produce the documentation page such as HTML format page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSubpages
Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
[[["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-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class Page (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Api.Page)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Api.Page)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Api.Page)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Api.Page)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Api.Page)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Api.Page) \nReference documentation and code samples for the Google API Common Protos Client class Page.\n\nRepresents a documentation page. A page can contain subpages to represent\nnested documentation set structure.\n\nGenerated from protobuf message `google.api.Page`\n\nNamespace\n---------\n\nGoogle \\\\ Api\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example: \n\n pages:\n - name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\nYou can reference `Java` page using Markdown reference link syntax:\n`\u003cxref uid=\"\\\\Tutorial\\Java\"\u003eJava\u003c/xref\u003e`.\n\n### setName\n\nThe name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example: \n\n pages:\n - name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\nYou can reference `Java` page using Markdown reference link syntax:\n`\u003cxref uid=\"\\\\Tutorial\\Java\"\u003eJava\u003c/xref\u003e`.\n\n### getContent\n\nThe Markdown content of the page. You can use `(== include {path}\n==)` to include content from a Markdown file. The content can be used\nto produce the documentation page such as HTML format page.\n\n### setContent\n\nThe Markdown content of the page. You can use `(== include {path}\n==)` to include content from a Markdown file. The content can be used\nto produce the documentation page such as HTML format page.\n\n### getSubpages\n\nSubpages of this page. The order of subpages specified here will be\nhonored in the generated docset.\n\n### setSubpages\n\nSubpages of this page. The order of subpages specified here will be\nhonored in the generated docset."]]
