Data Manager API . accountTypes . accounts . partnerLinks

close()

Close httplib2 connections.

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

Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

Args:
  parent: string, Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account} (required)
  body: object, The request body.
    The object takes the form of:

{ # A partner link between an owning account and a partner account.
  "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
  "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner account.
    "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
    "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
    "product": "A String", # Deprecated. Use `account_type` instead.
  },
  "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning account.
    "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
    "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
    "product": "A String", # Deprecated. Use `account_type` instead.
  },
  "partnerLinkId": "A String", # Output only. The partner link ID.
}

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

Returns:
  An object of the form:

    { # A partner link between an owning account and a partner account.
  "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
  "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner account.
    "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
    "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
    "product": "A String", # Deprecated. Use `account_type` instead.
  },
  "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning account.
    "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
    "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
    "product": "A String", # Deprecated. Use `account_type` instead.
  },
  "partnerLinkId": "A String", # Output only. The partner link ID.
}

delete(name, x__xgafv=None)

Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

Args:
  name: string, Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} (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); }
}

search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

Args:
  parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required)
  filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321`
  pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` 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 from the SearchPartnerLinksRequest.
  "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.
  "partnerLinks": [ # The partner links for the given account.
    { # A partner link between an owning account and a partner account.
      "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
      "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner account.
        "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
        "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
        "product": "A String", # Deprecated. Use `account_type` instead.
      },
      "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning account.
        "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
        "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
        "product": "A String", # Deprecated. Use `account_type` instead.
      },
      "partnerLinkId": "A String", # Output only. The partner link ID.
    },
  ],
}

search_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.