Google Analytics Admin API . properties . displayVideo360AdvertiserLinks

close()

Close httplib2 connections.

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

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

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

{ # A link between a GA4 property and a Display & Video 360 advertiser.
  "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
  "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
  "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
  "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
}

  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 GA4 property and a Display & Video 360 advertiser.
  "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
  "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
  "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
  "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
}

delete(name, x__xgafv=None)

Deletes a DisplayVideo360AdvertiserLink on a property.

Args:
  name: string, Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/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); } The JSON representation for `Empty` is empty JSON object `{}`.
}

get(name, x__xgafv=None)

Look up a single DisplayVideo360AdvertiserLink

Args:
  name: string, Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/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 link between a GA4 property and a Display & Video 360 advertiser.
  "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
  "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
  "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
  "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
}

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

Lists all DisplayVideo360AdvertiserLinks 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 `ListDisplayVideo360AdvertiserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinks` 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 ListDisplayVideo360AdvertiserLinks RPC.
  "displayVideo360AdvertiserLinks": [ # List of DisplayVideo360AdvertiserLinks.
    { # A link between a GA4 property and a Display & Video 360 advertiser.
      "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
      "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
      "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
      "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
      "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
      "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
    },
  ],
  "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(previous_request, previous_response)

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 DisplayVideo360AdvertiserLink on a property.

Args:
  name: string, Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID (required)
  body: object, The request body.
    The object takes the form of:

{ # A link between a GA4 property and a Display & Video 360 advertiser.
  "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
  "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
  "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
  "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
}

  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 link between a GA4 property and a Display & Video 360 advertiser.
  "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
  "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser.
  "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID.
  "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
  "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID
}