Google Analytics Admin API . properties . bigQueryLinks

close()

Close httplib2 connections.

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

Creates a BigQueryLink.

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

{ # A link between a Google Analytics property and BigQuery project.
  "createTime": "A String", # Output only. Time when the link was created.
  "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
  "datasetLocation": "A String", # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
  "excludedEvents": [ # The list of event names that will be excluded from exports.
    "A String",
  ],
  "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
    "A String",
  ],
  "freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
  "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
  "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
  "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
  "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
}

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

Returns:
  An object of the form:

    { # A link between a Google Analytics property and BigQuery project.
  "createTime": "A String", # Output only. Time when the link was created.
  "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
  "datasetLocation": "A String", # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
  "excludedEvents": [ # The list of event names that will be excluded from exports.
    "A String",
  ],
  "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
    "A String",
  ],
  "freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
  "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
  "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
  "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
  "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
}

delete(name, x__xgafv=None)

Deletes a BigQueryLink on a property.

Args:
  name: string, Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/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 BigQuery Link.

Args:
  name: string, Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A link between a Google Analytics property and BigQuery project.
  "createTime": "A String", # Output only. Time when the link was created.
  "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
  "datasetLocation": "A String", # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
  "excludedEvents": [ # The list of event names that will be excluded from exports.
    "A String",
  ],
  "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
    "A String",
  ],
  "freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
  "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
  "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
  "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
  "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
}

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

Lists BigQuery Links on a property.

Args:
  parent: string, Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234 (required)
  pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. 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 `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` 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 ListBigQueryLinks RPC
  "bigqueryLinks": [ # List of BigQueryLinks.
    { # A link between a Google Analytics property and BigQuery project.
      "createTime": "A String", # Output only. Time when the link was created.
      "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
      "datasetLocation": "A String", # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
      "excludedEvents": [ # The list of event names that will be excluded from exports.
        "A String",
      ],
      "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
        "A String",
      ],
      "freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
      "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
      "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
      "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
      "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
    },
  ],
  "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 BigQueryLink.

Args:
  name: string, Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' (required)
  body: object, The request body.
    The object takes the form of:

{ # A link between a Google Analytics property and BigQuery project.
  "createTime": "A String", # Output only. Time when the link was created.
  "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
  "datasetLocation": "A String", # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
  "excludedEvents": [ # The list of event names that will be excluded from exports.
    "A String",
  ],
  "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
    "A String",
  ],
  "freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
  "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
  "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
  "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
  "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
}

  updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). 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 link between a Google Analytics property and BigQuery project.
  "createTime": "A String", # Output only. Time when the link was created.
  "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project.
  "datasetLocation": "A String", # Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
  "excludedEvents": [ # The list of event names that will be excluded from exports.
    "A String",
  ],
  "exportStreams": [ # The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
    "A String",
  ],
  "freshDailyExportEnabled": True or False, # If set true, enables fresh daily export to the linked Google Cloud project.
  "includeAdvertisingId": True or False, # If set true, exported data will include advertising identifiers for mobile app streams.
  "name": "A String", # Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
  "project": "A String", # Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
  "streamingExportEnabled": True or False, # If set true, enables streaming export to the linked Google Cloud project.
}