# Google Play EMM API . storelayoutclusters

## Instance Methods

Deletes a cluster.

Retrieves details of a cluster.

Inserts a new cluster in a page.

Retrieves the details of all clusters on the specified page.

Updates a cluster.

### Method Details

`delete(enterpriseId, pageId, clusterId, x__xgafv=None)`

    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)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

`get(enterpriseId, pageId, clusterId, x__xgafv=None)`

    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)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    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.
          "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.
            },
          ],
          "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",
          ],
        }

`insert(enterpriseId, pageId, body=None, x__xgafv=None)`

    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.
        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.
        "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.
          },
        ],
        "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",
        ],
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    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.
          "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.
            },
          ],
          "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",
          ],
        }

`list(enterpriseId, pageId, x__xgafv=None)`

    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)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "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.
              "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.
                },
              ],
              "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",
              ],
            },
        ],
      }

`update(enterpriseId, pageId, clusterId, body=None, x__xgafv=None)`

    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.
        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.
        "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.
          },
        ],
        "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",
        ],
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    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.
          "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.
            },
          ],
          "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",
          ],
        }