Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.storelayoutpages.html">storelayoutpages</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(enterpriseId, pageId)</a></code></p>
     79 <p class="firstline">Deletes a store page.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(enterpriseId, pageId)</a></code></p>
     82 <p class="firstline">Retrieves details of a store page.</p>
     83 <p class="toc_element">
     84   <code><a href="#insert">insert(enterpriseId, body)</a></code></p>
     85 <p class="firstline">Inserts a new store page.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list(enterpriseId)</a></code></p>
     88 <p class="firstline">Retrieves the details of all pages in the store.</p>
     89 <p class="toc_element">
     90   <code><a href="#patch">patch(enterpriseId, pageId, body)</a></code></p>
     91 <p class="firstline">Updates the content of a store page. This method supports patch semantics.</p>
     92 <p class="toc_element">
     93   <code><a href="#update">update(enterpriseId, pageId, body)</a></code></p>
     94 <p class="firstline">Updates the content of a store page.</p>
     95 <h3>Method Details</h3>
     96 <div class="method">
     97     <code class="details" id="delete">delete(enterpriseId, pageId)</code>
     98   <pre>Deletes a store page.
     99 
    100 Args:
    101   enterpriseId: string, The ID of the enterprise. (required)
    102   pageId: string, The ID of the page. (required)
    103 </pre>
    104 </div>
    105 
    106 <div class="method">
    107     <code class="details" id="get">get(enterpriseId, pageId)</code>
    108   <pre>Retrieves details of a store page.
    109 
    110 Args:
    111   enterpriseId: string, The ID of the enterprise. (required)
    112   pageId: string, The ID of the page. (required)
    113 
    114 Returns:
    115   An object of the form:
    116 
    117     { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    118       "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    119       "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    120           #
    121           # No attempt is made to verify that all pages are reachable from the homepage.
    122         "A String",
    123       ],
    124       "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    125       "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    126         { # A localized string with its locale.
    127           "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    128           "text": "A String", # The text localized in the associated locale.
    129         },
    130       ],
    131     }</pre>
    132 </div>
    133 
    134 <div class="method">
    135     <code class="details" id="insert">insert(enterpriseId, body)</code>
    136   <pre>Inserts a new store page.
    137 
    138 Args:
    139   enterpriseId: string, The ID of the enterprise. (required)
    140   body: object, The request body. (required)
    141     The object takes the form of:
    142 
    143 { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    144     "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    145     "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    146         # 
    147         # No attempt is made to verify that all pages are reachable from the homepage.
    148       "A String",
    149     ],
    150     "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    151     "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    152       { # A localized string with its locale.
    153         "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    154         "text": "A String", # The text localized in the associated locale.
    155       },
    156     ],
    157   }
    158 
    159 
    160 Returns:
    161   An object of the form:
    162 
    163     { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    164       "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    165       "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    166           #
    167           # No attempt is made to verify that all pages are reachable from the homepage.
    168         "A String",
    169       ],
    170       "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    171       "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    172         { # A localized string with its locale.
    173           "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    174           "text": "A String", # The text localized in the associated locale.
    175         },
    176       ],
    177     }</pre>
    178 </div>
    179 
    180 <div class="method">
    181     <code class="details" id="list">list(enterpriseId)</code>
    182   <pre>Retrieves the details of all pages in the store.
    183 
    184 Args:
    185   enterpriseId: string, The ID of the enterprise. (required)
    186 
    187 Returns:
    188   An object of the form:
    189 
    190     { # The store page resources for the enterprise.
    191     "kind": "androidenterprise#storeLayoutPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse".
    192     "page": [ # A store page of an enterprise.
    193       { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    194           "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    195           "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    196               #
    197               # No attempt is made to verify that all pages are reachable from the homepage.
    198             "A String",
    199           ],
    200           "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    201           "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    202             { # A localized string with its locale.
    203               "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    204               "text": "A String", # The text localized in the associated locale.
    205             },
    206           ],
    207         },
    208     ],
    209   }</pre>
    210 </div>
    211 
    212 <div class="method">
    213     <code class="details" id="patch">patch(enterpriseId, pageId, body)</code>
    214   <pre>Updates the content of a store page. This method supports patch semantics.
    215 
    216 Args:
    217   enterpriseId: string, The ID of the enterprise. (required)
    218   pageId: string, The ID of the page. (required)
    219   body: object, The request body. (required)
    220     The object takes the form of:
    221 
    222 { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    223     "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    224     "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    225         # 
    226         # No attempt is made to verify that all pages are reachable from the homepage.
    227       "A String",
    228     ],
    229     "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    230     "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    231       { # A localized string with its locale.
    232         "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    233         "text": "A String", # The text localized in the associated locale.
    234       },
    235     ],
    236   }
    237 
    238 
    239 Returns:
    240   An object of the form:
    241 
    242     { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    243       "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    244       "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    245           #
    246           # No attempt is made to verify that all pages are reachable from the homepage.
    247         "A String",
    248       ],
    249       "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    250       "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    251         { # A localized string with its locale.
    252           "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    253           "text": "A String", # The text localized in the associated locale.
    254         },
    255       ],
    256     }</pre>
    257 </div>
    258 
    259 <div class="method">
    260     <code class="details" id="update">update(enterpriseId, pageId, body)</code>
    261   <pre>Updates the content of a store page.
    262 
    263 Args:
    264   enterpriseId: string, The ID of the enterprise. (required)
    265   pageId: string, The ID of the page. (required)
    266   body: object, The request body. (required)
    267     The object takes the form of:
    268 
    269 { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    270     "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    271     "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    272         # 
    273         # No attempt is made to verify that all pages are reachable from the homepage.
    274       "A String",
    275     ],
    276     "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    277     "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    278       { # A localized string with its locale.
    279         "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    280         "text": "A String", # The text localized in the associated locale.
    281       },
    282     ],
    283   }
    284 
    285 
    286 Returns:
    287   An object of the form:
    288 
    289     { # Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
    290       "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
    291       "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
    292           #
    293           # No attempt is made to verify that all pages are reachable from the homepage.
    294         "A String",
    295       ],
    296       "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
    297       "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
    298         { # A localized string with its locale.
    299           "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
    300           "text": "A String", # The text localized in the associated locale.
    301         },
    302       ],
    303     }</pre>
    304 </div>
    305 
    306 </body></html>