Google Analytics Admin API . properties . dataStreams

Instance Methods

measurementProtocolSecrets()

Returns the measurementProtocolSecrets Resource.

close()

Close httplib2 connections.

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

Creates a DataStream.

delete(name, x__xgafv=None)

Deletes a DataStream on a property.

get(name, x__xgafv=None)

Lookup for a single DataStream.

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

Lists DataStreams on a property.

list_next()

Retrieves the next page of results.

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

Updates a DataStream on a property.

Method Details

close() 
Close httplib2 connections.
create(parent, body=None, x__xgafv=None) 
Creates a DataStream.

Args:
  parent: string, Required. Example format: properties/1234 (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a data stream.
  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
  },
  "createTime": "A String", # Output only. Time when this stream was originally created.
  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
  },
  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
  "type": "A String", # Required. Immutable. The type of this DataStream resource.
  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
    "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
    "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a data stream.
  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
  },
  "createTime": "A String", # Output only. Time when this stream was originally created.
  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
  },
  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
  "type": "A String", # Required. Immutable. The type of this DataStream resource.
  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
    "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
    "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
  },
}
delete(name, x__xgafv=None) 
Deletes a DataStream on a property.

Args:
  name: string, Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 (required)
  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) 
Lookup for a single DataStream.

Args:
  name: string, Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a data stream.
  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
  },
  "createTime": "A String", # Output only. Time when this stream was originally created.
  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
  },
  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
  "type": "A String", # Required. Immutable. The type of this DataStream resource.
  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
    "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
    "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
  },
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None) 
Lists DataStreams on a property.

Args:
  parent: string, Required. Example format: properties/1234 (required)
  pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
  pageToken: string, A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token.
  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 ListDataStreams RPC.
  "dataStreams": [ # List of DataStreams.
    { # A resource message representing a data stream.
      "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
        "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
        "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
      },
      "createTime": "A String", # Output only. Time when this stream was originally created.
      "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
      "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
        "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
        "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
      },
      "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
      "type": "A String", # Required. Immutable. The type of this DataStream resource.
      "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
      "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
        "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
        "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
        "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
      },
    },
  ],
  "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.
}
list_next() 
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, body=None, updateMask=None, x__xgafv=None) 
Updates a DataStream on a property.

Args:
  name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a data stream.
  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
  },
  "createTime": "A String", # Output only. Time when this stream was originally created.
  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
  },
  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
  "type": "A String", # Required. Immutable. The type of this DataStream resource.
  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
    "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
    "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
  },
}

  updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a data stream.
  "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
    "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
    "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
  },
  "createTime": "A String", # Output only. Time when this stream was originally created.
  "displayName": "A String", # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
  "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
    "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
    "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
  },
  "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
  "type": "A String", # Required. Immutable. The type of this DataStream resource.
  "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
  "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
    "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
    "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
    "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
  },
}