Class: Google::Apis::TagmanagerV2::Environment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/tagmanager_v2/classes.rb,
generated/google/apis/tagmanager_v2/representations.rb,
generated/google/apis/tagmanager_v2/representations.rb

Overview

Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Environment

Returns a new instance of Environment



828
829
830
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 828

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


700
701
702
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 700

def 
  @account_id
end

#authorization_code ⇒ String

The environment authorization code. Corresponds to the JSON property authorizationCode

Returns:

  • (String) 


705
706
707
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 705

def authorization_code
  @authorization_code
end

#authorization_timestamp ⇒ Google::Apis::TagmanagerV2::Timestamp

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear. The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time(). Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX gettimeofday(). struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv. tv_usec * 1000); Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime(). FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft. dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java System.currentTimeMillis(). long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) . setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "year- month-dayThour:min:sec[.frac_sec]Z" where year is always expressed using four digits while month, day, hour, min, and sec are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format. Corresponds to the JSON property authorizationTimestamp

Returns:



762
763
764
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 762

def authorization_timestamp
  @authorization_timestamp
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


767
768
769
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 767

def container_id
  @container_id
end

#container_version_id ⇒ String

Represents a link to a container version. Corresponds to the JSON property containerVersionId

Returns:

  • (String) 


772
773
774
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 772

def container_version_id
  @container_version_id
end

#description ⇒ String

The environment description. Can be set or changed only on USER type environments. Corresponds to the JSON property description

Returns:

  • (String) 


778
779
780
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 778

def description
  @description
end

#enable_debug ⇒ Boolean Also known as: enable_debug?

Whether or not to enable debug by default for the environment. Corresponds to the JSON property enableDebug

Returns:

  • (Boolean) 


783
784
785
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 783

def enable_debug
  @enable_debug
end

#environment_id ⇒ String

GTM Environment ID uniquely identifies the GTM Environment. Corresponds to the JSON property environmentId

Returns:

  • (String) 


789
790
791
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 789

def environment_id
  @environment_id
end

#fingerprint ⇒ String

The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified. Corresponds to the JSON property fingerprint

Returns:

  • (String) 


795
796
797
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 795

def fingerprint
  @fingerprint
end

#name ⇒ String

The environment display name. Can be set or changed only on USER type environments. Corresponds to the JSON property name

Returns:

  • (String) 


801
802
803
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 801

def name
  @name
end

#path ⇒ String

GTM Environment's API relative path. Corresponds to the JSON property path

Returns:

  • (String) 


806
807
808
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 806

def path
  @path
end

#tag_manager_url ⇒ String

Auto generated link to the tag manager UI Corresponds to the JSON property tagManagerUrl

Returns:

  • (String) 


811
812
813
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 811

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

The type of this environment. Corresponds to the JSON property type

Returns:

  • (String) 


816
817
818
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 816

def type
  @type
end

#url ⇒ String

Default preview page url for the environment. Corresponds to the JSON property url

Returns:

  • (String) 


821
822
823
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 821

def url
  @url
end

#workspace_id ⇒ String

Represents a link to a quick preview of a workspace. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


826
827
828
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 826

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 833

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @authorization_code = args[:authorization_code] if args.key?(:authorization_code)
  @authorization_timestamp = args[:authorization_timestamp] if args.key?(:authorization_timestamp)
  @container_id = args[:container_id] if args.key?(:container_id)
  @container_version_id = args[:container_version_id] if args.key?(:container_version_id)
  @description = args[:description] if args.key?(:description)
  @enable_debug = args[:enable_debug] if args.key?(:enable_debug)
  @environment_id = args[:environment_id] if args.key?(:environment_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @name = args[:name] if args.key?(:name)
  @path = args[:path] if args.key?(:path)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @type = args[:type] if args.key?(:type)
  @url = args[:url] if args.key?(:url)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end