Search Ads 360 Reporting API . customers . productLinkInvitations

Instance Methods

close()

Close httplib2 connections.

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

Creates a product link invitation.

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

Remove a product link invitation.

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

Update a product link invitation.

Method Details

close()
Close httplib2 connections.
create(customerId, body=None, x__xgafv=None)
Creates a product link invitation.

Args:
  customerId: string, Required. The ID of the customer being modified. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ProductLinkInvitationService.CreateProductLinkInvitation.
  "productLinkInvitation": { # Represents an invitation for data sharing connection between a Google Ads account and another account. # Required. The product link invitation to be created.
    "advertisingPartner": { # The identifier for the Advertising Partner Google Ads account. # Output only. Advertising Partner link invitation.
      "customer": "A String", # Immutable. The resource name of the advertising partner Google Ads account. This field is read only.
    },
    "hotelCenter": { # The identifier for Hotel account. # Output only. Hotel link invitation.
      "hotelCenterId": "A String", # Output only. The hotel center id of the hotel account. This field is read only
    },
    "merchantCenter": { # The identifier for Merchant Center Account. # Output only. Merchant Center link invitation.
      "merchantCenterId": "A String", # Output only. The Merchant Center id of the Merchant account. This field is read only
    },
    "productLinkInvitationId": "A String", # Output only. The ID of the product link invitation. This field is read only.
    "resourceName": "A String", # Immutable. The resource name of a product link invitation. Product link invitation resource names have the form: `customers/{customer_id}/productLinkInvitations/{product_link_invitation_id}`
    "status": "A String", # Output only. The status of the product link invitation. This field is read only.
    "type": "A String", # Output only. The type of the invited account. This field is read only and can be used for filtering invitations with {@code GoogleAdsService.SearchGoogleAdsRequest}.
  },
}

  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 product link invitation create.
  "resourceName": "A String", # Resource name of the product link invitation.
}
remove(customerId, body=None, x__xgafv=None)
Remove a product link invitation.

Args:
  customerId: string, Required. The ID of the product link invitation being removed. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ProductLinkInvitationService.RemoveProductLinkInvitation.
  "resourceName": "A String", # Required. The resource name of the product link invitation being removed. expected, in this format: ` `
}

  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 product link invitation removeal.
  "resourceName": "A String", # Result for the remove request.
}
update(customerId, body=None, x__xgafv=None)
Update a product link invitation.

Args:
  customerId: string, Required. The ID of the customer being modified. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ProductLinkInvitationService.UpdateProductLinkInvitation.
  "productLinkInvitationStatus": "A String", # Required. The product link invitation to be created.
  "resourceName": "A String", # Required. Resource name of the product link invitation.
}

  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 product link invitation update.
  "resourceName": "A String", # Result of the update.
}