Firebase Cloud Messaging API (fcm:v1)

Additions

Methods


• ▼ ▲ fcm.projects.registrations.topicSubscriptions.patch

  HTTP Method : PATCH

  Parameters :

  name

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/registrations/[^/]+/topicSubscriptions/[^/]+$

  Required : Yes

  Description : Identifier. The resource name of the subscription. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription} The {registration} part contains the registration ID (e.g., FID).

  allowMissing

  Type : boolean

  Location : query

  Description : Optional. If set to true, and the topic subscription is not found, a new topic subscription will be created.

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase.messaging

  Description : 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.

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/registrations/{registrationsId}/topicSubscriptions/{topicSubscriptionsId}

• ▼ ▲ fcm.projects.registrations.topicSubscriptions.list

  Description : Lists TopicSubscriptions for a given app instance.

  Flat Path : v1/projects/{projectsId}/registrations/{registrationsId}/topicSubscriptions

  HTTP Method : GET

  Parameters :

  parent

  Required : Yes

  Type : string

  Description : 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.

  Location : path

  Pattern : ^projects/[^/]+/registrations/[^/]+$

  pageSize

  Type : integer

  Format : int32

  Description : 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.

  Location : query

  pageToken

  Type : string

  Description : Optional. A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page.

  Location : query

  Parameter Order : parent

  Path : v1/{+parent}/topicSubscriptions

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase.messaging

• ▼ ▲ fcm.projects.registrations.topicSubscriptions.create

  Flat Path : v1/projects/{projectsId}/registrations/{registrationsId}/topicSubscriptions

  Path : v1/{+parent}/topicSubscriptions

  Parameters :

  parent

  Location : path

  Description : 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.

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/registrations/[^/]+$

  topicName

  Location : query

  Description : 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}".

  Type : string

  HTTP Method : POST

  Description : 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.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase.messaging

  Parameter Order : parent

• ▼ ▲ fcm.projects.registrations.topicSubscriptions.get

  Flat Path : v1/projects/{projectsId}/registrations/{registrationsId}/topicSubscriptions/{topicSubscriptionsId}

  Description : Gets a TopicSubscription.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase.messaging

  Parameter Order : name

  Parameters :

  name

  Description : Required. The name of the topic subscription to retrieve. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription}

  Type : string

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/registrations/[^/]+/topicSubscriptions/[^/]+$

  HTTP Method : GET

  Path : v1/{+name}

• ▼ ▲ fcm.projects.registrations.topicSubscriptions.delete

  Flat Path : v1/projects/{projectsId}/registrations/{registrationsId}/topicSubscriptions/{topicSubscriptionsId}

  Parameter Order : name

  Path : v1/{+name}

  Parameters :

  name

  Required : Yes

  Location : path

  Description : Required. The name of the topic subscription to delete. Format: projects/{project}/registrations/{registration}/topicSubscriptions/{topicSubscription}

  Pattern : ^projects/[^/]+/registrations/[^/]+/topicSubscriptions/[^/]+$

  Type : string

  allowMissing

  Description : 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.

  Type : boolean

  Location : query

  HTTP Method : DELETE

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase.messaging

  Description : Deletes a TopicSubscription.