Skip to main content

GMail Postmaster Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Gmail Postmaster location.
gmpm_api.png

GMail Postmaster

Follow the instructions below to create a new data flow that ingests data from a Gmail Postmaster source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Gmail Postmaster connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Gmail Postmaster account, and click Next; or, create a new Gmail Postmaster credential for use in this flow.

  3. In Nexla, Gmail Postmaster data sources can be created using pre-built endpoint templates, which expedite source setup for common Gmail Postmaster endpoints. Each template is designed specifically for the corresponding Gmail Postmaster endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Gmail Postmaster sources can also be configured manually, allowing you to ingest data from Gmail Postmaster endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Gmail Postmaster endpoints. Each template is designed specifically for the corresponding Gmail Postmaster endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get All Domains

    Lists the domains that have been registered by the client.

    • This endpoint automatically retrieves all domains registered in your Gmail Postmaster account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://gmailpostmastertools.googleapis.com/v1beta1/domains. The endpoint URL is automatically constructed based on the Gmail Postmaster API base URL.
    • The endpoint uses token-based pagination (iteration.type: paging.next.token) through the nextPageToken mechanism. The response data path is $.domains[*], which extracts all items from the domains array in the API response.

    This endpoint retrieves all domains that have been registered in your Gmail Postmaster account. The endpoint supports pagination through the nextPageToken parameter, which allows you to retrieve large lists of domains efficiently. The response includes a nextPageToken field when more results are available, and Nexla automatically handles fetching additional pages. For detailed information about the API response format and available fields, see the Gmail Postmaster API documentation.

    Get One Domain

    Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.

    • Enter the domain name you want to fetch information for in the Domain Name field. This should be the full domain name (e.g., example.com) that has been registered in your Gmail Postmaster account.
    • The endpoint uses GET requests to https://gmailpostmastertools.googleapis.com/v1beta1/domains/{domain_name} where {domain_name} is the Domain Name you provide. The endpoint URL is automatically constructed based on the Gmail Postmaster API base URL and the domain name.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire root-level object from the API response.

    This endpoint retrieves detailed information about a specific domain registered in your Gmail Postmaster account. The domain must be registered in your account for this endpoint to return data. If the domain is not found, the API will return a NOT_FOUND error. For detailed information about the API response format and available fields, see the Gmail Postmaster API documentation.

    Get Stats for A Day

    Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

    • Enter the domain name you want to fetch traffic statistics for in the Domain Name field. This should be the full domain name (e.g., example.com) that has been registered in your Gmail Postmaster account.
    • Enter the date for which you want to fetch traffic statistics in the Date (yyyyMMdd format) field. The date must be in yyyyMMdd format (e.g., 20240101 for January 1, 2024). You can also use Nexla macros like {now}, {now - 1}, etc. The default value is {now} if not specified.
    • The endpoint uses GET requests to https://gmailpostmastertools.googleapis.com/v1beta1/domains/{domain_name}/trafficStats/{for_date} where {domain_name} is the Domain Name you provide and {for_date} is the Date formatted as yyyyMMdd. The endpoint URL is automatically constructed based on the Gmail Postmaster API base URL, the domain name, and the date.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire root-level object from the API response.

    This endpoint retrieves traffic statistics for a specific domain on a specific date. The date must be in yyyyMMdd format (e.g., 20240101 for January 1, 2024). You can use Nexla macros like {now} for the current date or {now - 1} for yesterday's date. The domain must be registered in your Gmail Postmaster account, and you must have permission to access TrafficStats for the domain. If you do not have permission, the API will return a PERMISSION_DENIED error. For detailed information about the API response format and available fields, see the Gmail Postmaster API documentation.

    List All Stats for Domain

    List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

    • Enter the domain name you want to fetch traffic statistics for in the Domain Name field. This should be the full domain name (e.g., example.com) that has been registered in your Gmail Postmaster account.
    • The endpoint uses GET requests to https://gmailpostmastertools.googleapis.com/v1beta1/domains/{domain_name}/trafficStats where {domain_name} is the Domain Name you provide. The endpoint URL is automatically constructed based on the Gmail Postmaster API base URL and the domain name.
    • The endpoint uses token-based pagination (iteration.type: paging.next.token) through the nextPageToken mechanism. The response data path is $.trafficStats[*], which extracts all items from the trafficStats array in the API response.

    This endpoint retrieves traffic statistics for all available days for a specific domain. The domain must be registered in your Gmail Postmaster account, and you must have permission to access TrafficStats for the domain. If you do not have permission, the API will return a PERMISSION_DENIED error. The endpoint supports pagination through the nextPageToken parameter, which allows you to retrieve large lists of traffic statistics efficiently. The response includes a nextPageToken field when more results are available, and Nexla automatically handles fetching additional pages. For detailed information about the API response format and available fields, see the Gmail Postmaster API documentation.

Configure Manually​

Gmail Postmaster data sources can be manually configured to ingest data from any valid Gmail Postmaster API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Gmail Postmaster sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Gmail Postmaster API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Gmail Postmaster API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Gmail Postmaster API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Gmail Postmaster API endpoints typically follow the pattern https://gmailpostmastertools.googleapis.com/v1beta1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. For detailed information about Gmail Postmaster API endpoints and available APIs, see the Gmail Postmaster API documentation.