Search Ads 360 Reporting API . customers . dataLinks

close()

Close httplib2 connections.

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

Creates a data link. The requesting Google Ads account name and account ID will be shared with the third party (such as YouTube creators for video links) to whom you are creating the link with. Only customers on the allow-list can create data links. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer for which the data link is created. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataLinkService.CreateDataLink.
  "dataLink": { # Represents the data sharing connection between # Required. The data link to be created.
    "dataLinkId": "A String", # Output only. The ID of the data link. This field is read only.
    "productLinkId": "A String", # Output only. The ID of the link. This field is read only.
    "resourceName": "A String", # Immutable. Resource name of the product data link. DataLink resource names have the form: `
    "status": "A String", # Output only. The status of the data link.
    "type": "A String", # Output only. The type of the data.
    "youtubeVideo": { # The identifier for YouTube video # Immutable. A data link to YouTube video.
      "channelId": "A String", # Immutable. The ID of the hosting channel of the video. This is a string value with “UC” prefix. For example, "UCK8sQmJBp8GCxrOtXWBpyEA".
      "videoId": "A String", # Immutable. The ID of the video associated with the video link. This is the 11 character string value used in the YouTube video URL. For example, video ID is jV1vkHv4zq8 from the YouTube video URL "https://www.youtube.com/watch?v=jV1vkHv4zq8&t=2s".
    },
  },
}

  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 DataLinkService.CreateDataLink.
  "resourceName": "A String", # Returned for successful operations. Resource name of the data link.
}

remove(customerId, body=None, x__xgafv=None)

Remove a data link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer for which the data link is updated. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataLinkService.RemoveDataLink.
  "resourceName": "A String", # Required. The data link is expected to have a valid resource name.
}

  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 DataLinkService.RemoveDataLink.
  "resourceName": "A String", # Result for the remove request.
}

update(customerId, body=None, x__xgafv=None)

Update a data link. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DataLinkError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer for which the data link is created. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataLinkService.UpdateDataLink.
  "dataLinkStatus": "A String", # Required. The data link status to be updated to.
  "resourceName": "A String", # Required. The data link is expected to have a valid resource name.
}

  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 DataLinkService.UpdateDataLink.
  "resourceName": "A String", # Returned for successful operations. Resource name of the data link.
}