docs/dyn/androidenterprise_v1.storelayoutclusters.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.storelayoutclusters.html">storelayoutclusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(enterpriseId, pageId, clusterId)</a></code></p>
<p class="firstline">Deletes a cluster.</p>
<p class="toc_element">
  <code><a href="#get">get(enterpriseId, pageId, clusterId)</a></code></p>
<p class="firstline">Retrieves details of a cluster.</p>
<p class="toc_element">
  <code><a href="#insert">insert(enterpriseId, pageId, body)</a></code></p>
<p class="firstline">Inserts a new cluster in a page.</p>
<p class="toc_element">
  <code><a href="#list">list(enterpriseId, pageId)</a></code></p>
<p class="firstline">Retrieves the details of all clusters on the specified page.</p>
<p class="toc_element">
  <code><a href="#patch">patch(enterpriseId, pageId, clusterId, body)</a></code></p>
<p class="firstline">Updates a cluster. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(enterpriseId, pageId, clusterId, body)</a></code></p>
<p class="firstline">Updates a cluster.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(enterpriseId, pageId, clusterId)</code>
  <pre>Deletes a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(enterpriseId, pageId, clusterId)</code>
  <pre>Retrieves details of a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)

Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(enterpriseId, pageId, body)</code>
  <pre>Inserts a new cluster in a page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
        #
        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "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.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(enterpriseId, pageId)</code>
  <pre>Retrieves the details of all clusters on the specified page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)

Returns:
  An object of the form:

    { # The store page resources for the enterprise.
    "cluster": [ # A store cluster of an enterprise.
      { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
          "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
          "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
              #
              # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
          "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
            "A String",
          ],
          "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
          "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.
            { # A localized string with its locale.
              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
              "text": "A String", # The text localized in the associated locale.
            },
          ],
        },
    ],
    "kind": "androidenterprise#storeLayoutClustersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
  }</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(enterpriseId, pageId, clusterId, body)</code>
  <pre>Updates a cluster. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
        #
        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "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.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="update">update(enterpriseId, pageId, clusterId, body)</code>
  <pre>Updates a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
        #
        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "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.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
          #
          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters.
      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

</body></html>