Firebase Cloud Messaging API . projects . registrations . topicSubscriptions

close()

Close httplib2 connections.

create(parent, body=None, topicName=None, x__xgafv=None)

Creates a TopicSubscription. Subscribes an app installation instance (by registration_id, either FID or FCM Token) to a topicSubscription. Returns a TopicSubscription if it is created successfully. If the subscription already exists, returns error of ALREADY_EXISTS.

Args:
  parent: string, Required. The parent resource where this subscription will be created. Format: projects/{project}/registrations/{registration} The {registration} part can be an FID or an FCM Token. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a subscription of a single app instance to a single FCM topic.
  "createTime": "A String", # Output only. Time when the subscription was created.
  "name": "A String", # Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).
  "topicName": "A String", # Output only. The ID of the TopicSubscription, which is the topic name. This corresponds to the {topicSubscription} segment in the resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
}

  topicName: string, Required. The ID to use for the subscription, which is the topic name. This will become the last segment of the TopicSubscription's resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a subscription of a single app instance to a single FCM topic.
  "createTime": "A String", # Output only. Time when the subscription was created.
  "name": "A String", # Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).
  "topicName": "A String", # Output only. The ID of the TopicSubscription, which is the topic name. This corresponds to the {topicSubscription} segment in the resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
}

delete(name, allowMissing=None, x__xgafv=None)

Deletes a TopicSubscription.

Args:
  name: string, Required. The name of the topic subscription to delete. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} (required)
  allowMissing: boolean, Optional. If set to true, and the topic subscription is not found, the request will succeed but no action will be taken on the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a TopicSubscription.

Args:
  name: string, Required. The name of the topic subscription to retrieve. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a subscription of a single app instance to a single FCM topic.
  "createTime": "A String", # Output only. Time when the subscription was created.
  "name": "A String", # Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).
  "topicName": "A String", # Output only. The ID of the TopicSubscription, which is the topic name. This corresponds to the {topicSubscription} segment in the resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
}

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

Lists TopicSubscriptions for a given app instance.

Args:
  parent: string, Required. The parent resource, which owns this collection of subscriptions. Format: projects/{project}/registrations/{registration} The {registration} part can be an FID or an FCM Token. (required)
  pageSize: integer, Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 1000 subscriptions will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.
  pageToken: string, Optional. A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListTopicSubscriptions.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "topicSubscriptions": [ # The topic subscriptions for the instance.
    { # Represents a subscription of a single app instance to a single FCM topic.
      "createTime": "A String", # Output only. Time when the subscription was created.
      "name": "A String", # Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).
      "topicName": "A String", # Output only. The ID of the TopicSubscription, which is the topic name. This corresponds to the {topicSubscription} segment in the resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
    },
  ],
}

list_next(previous_request, previous_response)

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.

patch(name, allowMissing=None, body=None, x__xgafv=None)

Updates a TopicSubscription. Subscribes an app installation instance by registration_id, either FID or FCM Token, to a topicSubscription. Returns an existing TopicSubscription or creates a new one if it does not exist.

Args:
  name: string, Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID). (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a subscription of a single app instance to a single FCM topic.
  "createTime": "A String", # Output only. Time when the subscription was created.
  "name": "A String", # Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).
  "topicName": "A String", # Output only. The ID of the TopicSubscription, which is the topic name. This corresponds to the {topicSubscription} segment in the resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
}

  allowMissing: boolean, Optional. If set to true, and the topic subscription is not found, a new topic subscription will be created.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a subscription of a single app instance to a single FCM topic.
  "createTime": "A String", # Output only. Time when the subscription was created.
  "name": "A String", # Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).
  "topicName": "A String", # Output only. The ID of the TopicSubscription, which is the topic name. This corresponds to the {topicSubscription} segment in the resource name. Topic names match the pattern of "[a-zA-Z0-9-_.~%]{1,900}".
}