Google Directory Read

On this Page

Snap type:

Read


Description:

This Snap reads the data of the users, user photos, groups and org units in Google Directory.

  • Expected upstream SnapsFile reader followed by any file parser followed by Structure.
  • Expected downstream SnapsAny file Formatter followed by File Writer.
  • Expected inputResource type and Filter attributes(Filter keys, Filter values)
  • Expected output The data for the resource type provided.


Prerequisites:

[None]


Support and limitations:Works in Ultra Tasks.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Google Directory Accounts for information on setting up this type of account.

  • Verify that you have the correct Application scope defined for your account. See Google Directory Application Scope for more information.
  • Access tokens for Google Directory accounts expire in one hour.
Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Resource



Required. The type of resource to be created.

The options available include:

  • user - userKey required if calling the Users Get API.
  • userPhoto - userKey required.
  • orgunit - customerID and GetOrgUnitPath or ListOrgUnitPath must be specified as Filter attributes.
  • group - groupKey required if calling the Groups Get API.

Default value: user


Filter Attributes-
(Filter Keys, Filter values)


Filter keys - The suggested filter attributes based on the provided Resource Type selected.
Filter values - The corresponding values of the suggested filter key to read the resource.

Examples: See below.

Default value:  [None]


On empty result

Specify or select the Snap behavior when no matching filter value is found. The available options are:

Ignore: Select this option if you do not require an output document.

Error: Select this option if you want to send an error document to the error view.

Output: Select this option if you want an empty output document.

  • If you do not choose any of the options for On empty result (an empty space), the behavior of Snap for empty results remains consistent with its previous state.

  • If the resource type is userPhoto, the On empty result property value is not required.

Default value: space

Examples: Ignore

Snap execution

Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

  

Supported Filter Attributes by Resource

User

  • userKey - Required for Users Get API. Set the expression toggle (=) off and enter the userKey.
  • domain - Optional. Set the expression toggle (=) off and enter the domain.
  • showDeleted - Optional. Set the expression toggle (=) off and enter true | false.
  • fields - Optional. Set the expression toggle (=) off and list the fields to return, separated by a comma. See the API documentation referenced at the bottom of the page for the complete list of fields.
  • query -  Optional. Set the expression toggle (=) off and enter the query without quotation marks.

    Learn more about the user fields that are queryable within the user resource.

  • maxResults - Optional. Set the expression toggle (=) off and enter an integer (1 to 500, inclusive).
  • customer -  Set the expression toggle (=) off and enter the customerID. If you are an account administrator, you can use the my_customer alias with the expression toggle off.
  • projection - Optional. Set the expression toggle (=) off and enter custom or full in the Filter value field to retrieve the schema field.

  • customFieldMask - Optional. Set the expression toggle (=) off and list the custom fields to retrieve custom schema fields.

    You can fetch custom fields in a user profile by a comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

User.Photo

  • userKey - Required. Set the expression toggle (=) off and enter the userKey.


OrgUnit

  • customerID - Required. Set the expression toggle (=) off and enter the customerID.
  • GetOrgUnitPath - Required to call the OrgUnits Get API. Set the expression toggle (=) off and list the name of the org without a preceding slash (that is, TestOrg instead of /TestOrg).
  • ListOrgUnitPath - Required to call the OrgUnits List API. Set the expression toggle (=) off and list the name of the org without a preceding slash (that is, TestOrg instead of /TestOrg).
  • type - An optional parameter from the OrgUnits List API. Set the expression toggle (=) off and enter all | children.
  • fields - An optional parameter for either the OrgUnits Get API or the OrgUnits List API. Set the expression toggle (=) off and list the fields to return, separated by a c