YouTube Data API v3 . thirdPartyLinks

Instance Methods

close()

Close httplib2 connections.

delete(linkingToken, type, externalChannelId=None, part=None, x__xgafv=None)

Deletes a resource.

insert(part, body=None, externalChannelId=None, x__xgafv=None)

Inserts a new resource into this collection.

list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)

Retrieves a list of resources, possibly filtered.

update(part, body=None, externalChannelId=None, x__xgafv=None)

Updates an existing resource.

Method Details

close()
Close httplib2 connections.
delete(linkingToken, type, externalChannelId=None, part=None, x__xgafv=None)
Deletes a resource.

Args:
  linkingToken: string, Delete the partner links with the given linking token. (required)
  type: string, Type of the link to be deleted. (required)
    Allowed values
      linkUnspecified - 
      channelToStoreLink - A link that is connecting (or about to connect) a channel with a store on a merchandising platform in order to enable retail commerce capabilities for that channel on YouTube.
  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  part: string, Do not use. Required for compatibility. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
insert(part, body=None, externalChannelId=None, x__xgafv=None)
Inserts a new resource into this collection.

Args:
  part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
  body: object, The request body.
    The object takes the form of:

{ # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  "etag": "A String", # Etag of this resource
  "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
  "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  "snippet": { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    "channelToStoreLink": { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      "billingDetails": { # Information specific to billing. # Information specific to billing (read-only).
        "billingStatus": "A String", # The current billing profile status.
      },
      "merchantAffiliateProgramDetails": { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        "status": "A String", # The current merchant affiliate program status.
      },
      "merchantId": "A String", # Google Merchant Center id of the store.
      "storeName": "A String", # Name of the store.
      "storeUrl": "A String", # Landing page of the store.
    },
    "type": "A String", # Type of the link named after the entities that are being linked.
  },
  "status": { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    "linkStatus": "A String",
  },
}

  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  "etag": "A String", # Etag of this resource
  "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
  "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  "snippet": { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    "channelToStoreLink": { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      "billingDetails": { # Information specific to billing. # Information specific to billing (read-only).
        "billingStatus": "A String", # The current billing profile status.
      },
      "merchantAffiliateProgramDetails": { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        "status": "A String", # The current merchant affiliate program status.
      },
      "merchantId": "A String", # Google Merchant Center id of the store.
      "storeName": "A String", # Name of the store.
      "storeUrl": "A String", # Landing page of the store.
    },
    "type": "A String", # Type of the link named after the entities that are being linked.
  },
  "status": { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    "linkStatus": "A String",
  },
}
list(part, externalChannelId=None, linkingToken=None, type=None, x__xgafv=None)
Retrieves a list of resources, possibly filtered.

Args:
  part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  linkingToken: string, Get a third party link with the given linking token.
  type: string, Get a third party link of the given type.
    Allowed values
      linkUnspecified - 
      channelToStoreLink - A link that is connecting (or about to connect) a channel with a store on a merchandising platform in order to enable retail commerce capabilities for that channel on YouTube.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "etag": "A String", # Etag of this resource.
  "items": [
    { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
      "etag": "A String", # Etag of this resource
      "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
      "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
      "snippet": { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
        "channelToStoreLink": { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
          "billingDetails": { # Information specific to billing. # Information specific to billing (read-only).
            "billingStatus": "A String", # The current billing profile status.
          },
          "merchantAffiliateProgramDetails": { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
            "status": "A String", # The current merchant affiliate program status.
          },
          "merchantId": "A String", # Google Merchant Center id of the store.
          "storeName": "A String", # Name of the store.
          "storeUrl": "A String", # Landing page of the store.
        },
        "type": "A String", # Type of the link named after the entities that are being linked.
      },
      "status": { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
        "linkStatus": "A String",
      },
    },
  ],
  "kind": "youtube#thirdPartyLinkListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLinkListResponse".
}
update(part, body=None, externalChannelId=None, x__xgafv=None)
Updates an existing resource.

Args:
  part: string, The *part* parameter specifies the thirdPartyLink resource parts that the API request and response will include. Supported values are linkingToken, status, and snippet. (required) (repeated)
  body: object, The request body.
    The object takes the form of:

{ # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  "etag": "A String", # Etag of this resource
  "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
  "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  "snippet": { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    "channelToStoreLink": { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      "billingDetails": { # Information specific to billing. # Information specific to billing (read-only).
        "billingStatus": "A String", # The current billing profile status.
      },
      "merchantAffiliateProgramDetails": { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        "status": "A String", # The current merchant affiliate program status.
      },
      "merchantId": "A String", # Google Merchant Center id of the store.
      "storeName": "A String", # Name of the store.
      "storeUrl": "A String", # Landing page of the store.
    },
    "type": "A String", # Type of the link named after the entities that are being linked.
  },
  "status": { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    "linkStatus": "A String",
  },
}

  externalChannelId: string, Channel ID to which changes should be applied, for delegation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A *third party account link* resource represents a link between a YouTube account or a channel and an account on a third-party service.
  "etag": "A String", # Etag of this resource
  "kind": "youtube#thirdPartyLink", # Identifies what kind of resource this is. Value: the fixed string "youtube#thirdPartyLink".
  "linkingToken": "A String", # The linking_token identifies a YouTube account and channel with which the third party account is linked.
  "snippet": { # Basic information about a third party account link, including its type and type-specific information. # The snippet object contains basic details about the third- party account link.
    "channelToStoreLink": { # Information specific to a store on a merchandising platform linked to a YouTube channel. # Information specific to a link between a channel and a store on a merchandising platform.
      "billingDetails": { # Information specific to billing. # Information specific to billing (read-only).
        "billingStatus": "A String", # The current billing profile status.
      },
      "merchantAffiliateProgramDetails": { # Information specific to merchant affiliate program. # Information specific to merchant affiliate program (read-only).
        "status": "A String", # The current merchant affiliate program status.
      },
      "merchantId": "A String", # Google Merchant Center id of the store.
      "storeName": "A String", # Name of the store.
      "storeUrl": "A String", # Landing page of the store.
    },
    "type": "A String", # Type of the link named after the entities that are being linked.
  },
  "status": { # The third-party link status object contains information about the status of the link. # The status object contains information about the status of the link.
    "linkStatus": "A String",
  },
}