Idea Hub API . platforms . properties . locales

Instance Methods

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns which locales ideas are available in for a given Creator.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns which locales ideas are available in for a given Creator.

Args:
  parent: string, Required. The web property to check idea availability for Format: platforms/{platform}/property/{property} (required)
  pageSize: integer, The maximum number of locales to return. The service may return fewer than this value. If unspecified, at most 100 locales will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  pageToken: string, A page token, received from a previous `ListAvailableLocales` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAvailableLocales` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for whether ideas are available for a given web property on a platform, for the currently logged-in user.
  "availableLocales": [ # Locales for which ideas are available for the given Creator.
    { # Represents locales that are available for a web property.
      "locale": "A String", # A string in BCP 47 format, without a resource prefix.
      "name": "A String", # A string in BCP 47 format, prefixed with the platform and property name, and "locales/". Format: platforms/{platform}/properties/{property}/locales/{locale}
    },
  ],
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.